#import <VOCommonPlayerStatus.h>
Inheritance diagram for <VOCommonPlayerStatus >:
Instance Methods | |
| (VO_OSMP_PLAYER_ENGINE) - getPlayerType | |
| Get the player engine type. More... | |
| (VO_OSMP_STATUS) - getPlayerStatus | |
| Get the player status. More... | |
| (bool) - canBePaused | |
| Check if the stream can be paused. More... | |
| (BOOL) - canPlayIframeOnly | |
| Check if the stream contains I-Frame. More... | |
| (bool) - isLiveStreaming | |
| Check if the opened data source is a live streaming. More... | |
| (long) - getPosition | |
| Get current playback position. More... | |
| (long) - getMinPosition | |
| Get minimum position. More... | |
| (long) - getMaxPosition | |
| Get maximum position. More... | |
| (long long) - getUTCPosition | |
| Get the UTC position of current playback. More... | |
| (long) - getDuration | |
| Get duration of the stream. More... | |
| (int) - getScreenBrightness | |
| Get the screen display brightness. More... | |
| (NSString *) - getDRMUniqueIdentifier | |
| Get unique identifier of the device. More... | |
| (NSString *) - getVersion: | |
| Get version information of a module. More... | |
| (VO_OSMP_DOWNLOAD_STATUS) - getDownloadStatus: | |
| Get the download status. More... | |
| (int) - getValidBufferDuration | |
| Get the valid buffer duration (in ms). More... | |
| (id) - getSEIInfo:flag: | |
| Get the SEI info. More... | |
| (BOOL) - isOutputControlActive: | |
| Get the connection status of output control. More... | |
| (BOOL) - isOutputControlEnforce: | |
| Get the enforce status of output control. More... | |
| (VO_OSMP_RETURN_CODE) - getParameter:pObj: | |
| Get the value from specified ID. More... | |
Method Documentation
| - (bool VOCommonPlayerStatus) canBePaused |
Check if the stream can be paused.
- Returns
- true if the stream can be paused
| - (BOOL VOCommonPlayerStatus) canPlayIframeOnly |
Check if the stream contains I-Frame.
- Returns
- true if current stream contains I-Frame, else return false.
| - (VO_OSMP_DOWNLOAD_STATUS VOCommonPlayerStatus) getDownloadStatus: | (VO_OSMP_SOURCE_STREAMTYPE) | trackType |
Get the download status.
- Parameters
-
trackType [in] the track type VO_OSMP_SOURCE_STREAMTYPE
- Returns
- download status of the given track type, VO_OSMP_SS_MAX for error return
| - (NSString * VOCommonPlayerStatus) getDRMUniqueIdentifier |
Get unique identifier of the device.
To get the UID, this method should be called after calling VOCommonPlayerConfiguration#setDRMLibrary. Note that UID is only changed if the SDK is reinstalled. The application upgrade will not lead to the change of UID.
- Returns
- unique identifier is successful; nil if unsuccessful
| - (long VOCommonPlayerStatus) getDuration |
Get duration of the stream.
- Returns
- current stream duration <ms>; 0 if source is a live stream
| - (long VOCommonPlayerStatus) getMaxPosition |
Get maximum position.
- VOD: returns the duration
-
Live: relies on VOCommonPlayerConfiguration#enableLiveStreamingDVRPosition:
- Enabled: always returns 0, which represents the live playhead
- Disabled: returns the offset between the live playhead and the beginning of the playback
- Returns
- The position (ms); -1 if unsuccessful
| - (long VOCommonPlayerStatus) getMinPosition |
Get minimum position.
- For VOD: returns 0
- For Live: returns (getMaxPosition - DVR window size)
- Returns
- The position (ms); -1 if unsuccessful
| - (VO_OSMP_RETURN_CODE VOCommonPlayerStatus) getParameter: | (int) | paramID | |
| pObj: | (void *) | pObj | |
Get the value from specified ID.
Use this method only based on recommendations by VisualOn.
- Parameters
-
paramID [in] Parameter id. pObj [out] Returned parameter value; relies on parameter id.
- Returns
- VO_OSMP_ERR_NONE if successful
| - (VO_OSMP_STATUS VOCommonPlayerStatus) getPlayerStatus |
Get the player status.
- Returns
- player status. Refer to VO_OSMP_STATUS
| - (VO_OSMP_PLAYER_ENGINE VOCommonPlayerStatus) getPlayerType |
Get the player engine type.
- Returns
- Player engine type, refer to VO_OSMP_PLAYER_ENGINE
| - (long VOCommonPlayerStatus) getPosition |
Get current playback position.
The returned value of getPosition is 0 until the SDK receives either the VO_OSMP_CB_VIDEO_RENDER_START callback or the VO_OSMP_CB_AUDIO_RENDER_START callback.
- VOD: returns current playback position.
-
Live streaming: relies on VOCommonPlayerConfiguration#enableLiveStreamingDVRPosition:
- Enabled: returns 0 when playing at the live head. A negative position represents the offset into the DVR window with respect to live head
- Disabled: returns the offset with respect to the beginning of the playback
- Returns
- the position <ms>; -1 if unsuccessful
| - (int VOCommonPlayerStatus) getScreenBrightness |
Get the screen display brightness.
- Returns
- Current display brightness (percent)
| - (id VOCommonPlayerStatus) getSEIInfo: | (long long) | time | |
| flag: | (VO_OSMP_SEI_INFO_FLAG) | flag | |
Get the SEI info.
- Parameters
-
time [in] the time stamp of SEI to be obtained flag [in] the type flag of SEI info VO_OSMP_SEI_INFO_FLAG
- Returns
- the object according to flag if successful
| - (long long VOCommonPlayerStatus) getUTCPosition |
Get the UTC position of current playback.
- Returns
- the position <ms>; -1 if unsuccessful
| - (int VOCommonPlayerStatus) getValidBufferDuration |
Get the valid buffer duration (in ms).
- Returns
- Valid buffer duration, -1 for error return
| - (NSString* VOCommonPlayerStatus) getVersion: | (VO_OSMP_MODULE_TYPE) | module |
Get version information of a module.
The OSMP+ SDK is currently built using the same version for all modules. Pass VO_OSMP_MODULE_TYPE_SDK instead of passing a module as an argument.
- Parameters
-
module [in] module type.
- Returns
- version information of the given module
| - (bool VOCommonPlayerStatus) isLiveStreaming |
Check if the opened data source is a live streaming.
- Returns
- true if the data source is opened, is a streaming source and is a live streaming
| - (BOOL VOCommonPlayerStatus) isOutputControlActive: | (VO_OSMP_OUTPUT_CONTROL_TYPE) | type |
Get the connection status of output control.
- Parameters
-
type [in] the type flag of output control VO_OSMP_OUTPUT_CONTROL_TYPE
- Returns
- the status of connection
| - (BOOL VOCommonPlayerStatus) isOutputControlEnforce: | (VO_OSMP_OUTPUT_CONTROL_TYPE) | type |
Get the enforce status of output control.
- Parameters
-
type [in] the type flag of output control VO_OSMP_OUTPUT_CONTROL_TYPE
- Returns
- the status of enforce
The documentation for this protocol was generated from the following file: