#import <VOCommonPlayerAnalytics.h>
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) enableAnalytics: |
|
(int) |
cacheTime |
|
Set cache time and start analytics data collection.
- Parameters
-
cacheTime | [in] Time <seconds> to cache the analytics data. |
- Returns
- VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) enableAnalyticsAgent: |
|
(bool) |
enable |
|
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) enableAnalyticsDisplay: |
|
(int) |
time |
|
Enable analytics display.
-
To enable analytics display, this API must be called before calling the VOCommonPlayerControl#open method.
-
This API should be called ASAP after calling the {VOCommonPlayerConfiguration::setPreAgreedLicense}.
-
Call this API during playback to change the time of refreshing analytics display.
- Parameters
-
time | [in] Time <seconds> to refresh the display, set to 0 to disable analytics display. Valid time should be greater than or equal to 3. |
- Returns
- VO_OSMP_RETURN_CODE#VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) enableAnalyticsExport: |
|
(bool) |
enable |
|
Enable or disable logging of analytics events for realtime export.
- Parameters
-
enable | [in] Enable/disable; true to enable, false to disable (default). |
- Returns
- VO_OSMP_RETURN_CODE#VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) enableAnalyticsFoundation: |
|
(bool) |
enable |
|
Enable Analytics Foundation.
-
To enable Analytics Foundation, this API must be called before calling the VOCommonPlayerControl#open method.
-
This API should be called ASAP after calling the {VOCommonPlayerConfiguration::setPreAgreedLicense}.
- Parameters
-
enable | [in] Enable/Disable; true to enable, false to disable(default). |
- Returns
- VO_OSMP_RETURN_CODE#VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) enableAnalyticsFoundationLocation: |
|
(bool) |
enable |
|
Get current analytics data.
- Parameters
-
- Returns
- A VOOSMPAnalyticsInfo object if successful; nil if unsuccessful
- (NSString * VOCommonPlayerAnalytics) getAnalyticsExportPacket |
|
|
|
Get and flush logged analytics events.
- Returns
- String representing analytics events as JSON array
- (float VOCommonPlayerAnalytics) getAnalyticsFPS |
|
|
|
Get video video frames per second (FPS) from analytics display.
Need enable analytic display with enableAnalyticsDisplay
- Returns
- FPS; -1 if unsuccessful.
- (NSArray * VOCommonPlayerAnalytics) getAudioDecodingBitrate |
|
|
|
Get audio decoding bitrate(bps) for each of the last 10 seconds.
- Returns
- an array(NSNumber) of size 10 in which elements are the audio decoding bitrates of each of the last 10 seconds. The bitrate information is arranged in the way that the smaller the array index is, the closer the bitrate is to the current time. That is, element 0 is the bitrate of the closest second before the current time; element 1 is the bitrate that is 1 second before element 0; element 2 is the bitrate that is 1 second before element 1, and so on.
- (NSArray * VOCommonPlayerAnalytics) getVideoDecodingBitrate |
|
|
|
Get video decoding bitrate(bps) for each of the last 10 seconds.
- Returns
- an array(NSNumber) of size 10 in which elements are the video decoding bitrates of each of the last 10 seconds. The bitrate information is arranged in the way that the smaller the array index is, the closer the bitrate is to the current time. That is, element 0 is the bitrate of the closest second before the current time; element 1 is the bitrate that is 1 second before element 0; element 2 is the bitrate that is 1 second before element 1, and so on.
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) setAnalyticsAgentAppID: |
|
(NSString *) |
appID |
|
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) setAnalyticsAgentCUID: |
|
(NSString *) |
cuid |
|
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) setAnalyticsDisplayType: |
|
(VO_OSMP_DISPLAY_TYPE) |
type |
|
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) setAnalyticsExportListener: |
|
(id< VOOSMPAnalyticsExportListener >) |
listener |
|
Set listener that will be notified when new analytics event is available.
- Parameters
-
listener | [in] Analytics event listener |
- Returns
- VO_OSMP_RETURN_CODE#VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOCommonPlayerAnalytics) setAnalyticsFoundationCUID: |
|
(NSString *) |
cuid |
|
The documentation for this protocol was generated from the following file: