#import <VOCommonPlayerConfiguration.h>

Inheritance diagram for <VOCommonPlayerConfiguration >:

Instance Methods
(VO_OSMP_RETURN_CODE)	- setLicenseContent:
	Set contents of license file. More...

(VO_OSMP_RETURN_CODE)	- setLicenseFilePath:
	Set the location of the license file. More...

(VO_OSMP_RETURN_CODE)	- setPreAgreedLicense:
	Set pre-agreed license string. More...

(VO_OSMP_RETURN_CODE)	- enableDeblock:
	Enable/Disable deblock. More...

(VO_OSMP_RETURN_CODE)	- setDeviceCapabilityByFile:
	Set the location of device capability file. More...

(VO_OSMP_RETURN_CODE)	- setInitialBitrate:
	Set the initial bitrate. More...

(VO_OSMP_RETURN_CODE)	- setZoomMode:rect:
	Set video display area. More...

(VO_OSMP_RETURN_CODE)	- enableLiveStreamingDVRPosition:
	Enable the position definition based on live streaming DVR window. More...

(VO_OSMP_RETURN_CODE)	- setDRMLibrary:libApiName:
	Set DRM Library name and API name. More...

(VO_OSMP_RETURN_CODE)	- setDRMAdapter:
	Set the DRM adapter. More...

(VO_OSMP_RETURN_CODE)	- setDRMVerificationInfo:
	Set the verification information to start DRM verification. More...

(VO_OSMP_RETURN_CODE)	- setDRMUniqueIdentifier:
	Set unique identifier of the device. More...

(VO_OSMP_RETURN_CODE)	- enableDRMOfflineMode:
	Enable/Disable drm offline mode. More...

(VO_OSMP_RETURN_CODE)	- setInitialBufferTime:
	Set the initial buffering time before starting playback. More...

(VO_OSMP_RETURN_CODE)	- setInitialBufferingTime:
	Set the initial buffering time before starting playback. More...

(VO_OSMP_RETURN_CODE)	- setMaxBufferTime:
	Set the maximum buffering time for playback. More...

(VO_OSMP_RETURN_CODE)	- setMaxBufferingTime:
	Set the maximum buffering time for playback. More...

(VO_OSMP_RETURN_CODE)	- setPlaybackBufferingTime:
	Set the buffering time when re-buffering is needed during playback. More...

(VO_OSMP_RETURN_CODE)	- setAnewBufferingTime:
	Set the buffering time for continuous playback when re-buffering is needed. More...

(VO_OSMP_RETURN_CODE)	- enableAudioStream:
	Enable/Disable playback of the audio stream. More...

(VO_OSMP_RETURN_CODE)	- enableVideoStream:
	Enable/Disable playback of the video stream. More...

(VO_OSMP_RETURN_CODE)	- enableLowLatencyVideo:
	Enable/Disable immediate video rendering with low latency. More...

(VO_OSMP_RETURN_CODE)	- enableAudioEffect:
	Enable/Disable audio effect. More...

(VO_OSMP_RETURN_CODE)	- enablePCMOutput:
	Enable/Disable PCM data output. More...

(VO_OSMP_RETURN_CODE)	- setAudioPlaybackSpeed:
	Set audio playback speed. More...

(VO_OSMP_RETURN_CODE)	- setPlayIFrameOnly:Speed:
	Set I-Frame only mode. More...

(VO_OSMP_RETURN_CODE)	- setPresentationDelay:
	Set the presentation delay time for a live streaming source. More...

(VO_OSMP_RETURN_CODE)	- enableSEI:
	Enable/Disable processing SEI information. More...

(VO_OSMP_RETURN_CODE)	- enableSEIPostProcessVideo:
	Indicate to post process video data with SEI. More...

(VO_OSMP_RETURN_CODE)	- setPDConnectionRetryCount:
	Set the number of retry attempts in progressive download module when network connection fails. More...

(VO_OSMP_RETURN_CODE)	- enableCPUAdaptation:
	Enable/disable CPU adaptation; CPU adaptation is enabled by default. More...

(VO_OSMP_RETURN_CODE)	- setBitrateThreshold:lower:
	Set upper/lower bitrate threshold for adaptation. More...

(VO_OSMP_RETURN_CODE)	- setSegmentDownloadRetryCount:
	Set the maximum number of retry attempts to download a corresponding segment from a different bitrate due to DRM errors, server issues, or unsupported media format. More...

(VO_OSMP_RETURN_CODE)	- enableDolbyLibrary:
	Enable/Disable loading Dolby libraries. More...

(VO_OSMP_RETURN_CODE)	- enableAudioDecoderLibrary:value:
	Enable/Disable loading audio decoder libraries. More...

(VO_OSMP_RETURN_CODE)	- setAudioEffectEndpointType:
	Set endpoint of audio effect. More...

(NSString *)	- sendAudioEffectMessage:
	Reserved. More...

(VO_OSMP_RETURN_CODE)	- setHDCPPolicy:
	Set the HDCP policy. More...

(VO_OSMP_RETURN_CODE)	- setURLQueryString:
	Set URL query string, the query string should be in the format of "key1=value&key2=value". More...

(VO_OSMP_RETURN_CODE)	- enableAntiMirror:
	Enable anti-mirror. More...

(VO_OSMP_RETURN_CODE)	- enableCardBoardVideo:
	Enable card board video. More...

(VO_OSMP_RETURN_CODE)	- enableSphericalVideo:
	Enable spherical video. More...

(VO_OSMP_RETURN_CODE)	- setSphericalVideoView:pitch:fov:
	Set spherical video view. More...

(VO_OSMP_RETURN_CODE)	- setParameter:pObj:
	Set the value for a specified ID. More...

Method Documentation

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableAntiMirror: (bool) enable

Enable anti-mirror.

Disable is set by default.

Parameters

enable [in] Enable/Disable; true to enable, false to disable(default).

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableAudioDecoderLibrary:	(VO_OSMP_AUDIO_CODEC_TYPE)	type
value:	(bool)	value

Enable/Disable loading audio decoder libraries.

Enable is set by default. Disable loading an audio library is usually required when the device or application does not have a proper license in place to use the library.

Parameters

type	[in] Audio decoder type VO_OSMP_AUDIO_CODEC_TYPE .
value	[in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableAudioEffect: (bool) value

Enable/Disable audio effect.

Disable is set by default.

Parameters

value [in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableAudioStream: (bool) value

Enable/Disable playback of the audio stream.

Enable is set by default.

Parameters

value [in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableCardBoardVideo: (bool) enable

Enable card board video.

Parameters

enable [in] Enable/Disable; true to enable, false to disable(default).

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableCPUAdaptation: (bool) value

Enable/disable CPU adaptation; CPU adaptation is enabled by default.

When CPU adaptation is enabled, the player will adapt to a lower bitrate automatically if high CPU loading happens and frame drops. This API is not implemented in Streaming V2 that is undergoing testing by select customers. Contact your local VisualOn application engineers for more information about Streaming V2.

Parameters

value [in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableDeblock: (bool) value

Enable/Disable deblock.

This is valid for H.264 and Real video. Enabled is set by default.

Parameters

value [in] Enable/Disable; true to enable deblock (default), false to disable deblock.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableDolbyLibrary: (bool) value

Enable/Disable loading Dolby libraries.

Enable is set by default.

Parameters

value [in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

Deprecated:: This method is replaced by VOCommonPlayerConfiguration#enableAudioDecoderLibrary: and will be removed in the future.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableDRMOfflineMode: (bool) enable

Enable/Disable drm offline mode.

Parameters

enable [in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableLiveStreamingDVRPosition: (bool) enable

Enable the position definition based on live streaming DVR window.

This function is enabled by default. Set the value of this function to false to make Enter NTS work.

When enabled:

VOCommonPlayerStatus#getPosition returns 0 when playing at the live head. A negative position represents the offset into the DVR window with respect to live head
VOCommonPlayerStatus#getMaxPosition always returns 0 that represents the live head
VOCommonPlayerStatus#getMinPosition returns (getMaxPosition - DVR window size)

When disabled:

VOCommonPlayerStatus#getPosition returns the offset with respect to the beginning of the playback
VOCommonPlayerStatus#getMaxPosition returns the offset between the live head and the beginning of the playback
VOCommonPlayerStatus#getMinPosition returns (getMaxPosition - DVR window size)

Parameters

value [in] Enable/Disable; true to enable(default), false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableLowLatencyVideo: (bool) value

Enable/Disable immediate video rendering with low latency.

This function is only applicable to video-only streams. Disable is set by default.

Parameters

value [in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enablePCMOutput: (bool) value

Enable/Disable PCM data output.

Disable is set by default.

Parameters

value [in] Enable/Disable; true to enable PCM data output, false to disable (default).

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableSEI: (VO_OSMP_SEI_INFO_FLAG) flag

Enable/Disable processing SEI information.

Parameters

flag	[in] the flag VO_OSMP_SEI_INFO_FLAG. Set to VO_OSMP_SEI_INFO_NONE to disable processing SEI information or any other flags to enable.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableSEIPostProcessVideo: (bool) value

Indicate to post process video data with SEI.

Parameters

value [in] Enable/disable process; true to enable, false to disable(default).

Returns: VO_OSMP_ERR_NONE if successful.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableSphericalVideo: (bool) enable

Enable spherical video.

Parameters

enable [in] Enable/Disable; true to enable, false to disable(default).

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) enableVideoStream: (bool) value

Enable/Disable playback of the video stream.

Enable is set by default.

Parameters

value [in] Enable/Disable; true to enable, false to disable.

Returns: VO_OSMP_ERR_NONE if successful

- (NSString * VOCommonPlayerConfiguration) sendAudioEffectMessage: (NSString *) msg

Reserved.

Do not use it except for recommendations by VisualOn.

Parameters

msg	[in] Message.

Returns: string of return value

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setAnewBufferingTime: ((deprecated)) __attribute__

Set the buffering time for continuous playback when re-buffering is needed.

Parameters

time	[in] buffering time (milliseconds)

Returns: VO_OSMP_ERR_NONE if successful.

Deprecated:: This method is replaced by VOCommonPlayerConfiguration#setPlaybackBufferingTime: and will be removed in the future.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setAudioEffectEndpointType: (VO_OSMP_AUDIO_EFFECT_ENDPOINT_TYPE) type

Set endpoint of audio effect.

Parameters

type	[in] Endpoint type VO_OSMP_AUDIO_EFFECT_ENDPOINT_TYPE .

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setAudioPlaybackSpeed: (float) speed

Set audio playback speed.

Parameters

speed [in] speed multiplier with respect to realtime playback. Default is 1.0.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setBitrateThreshold:	(int)	upper
lower:	(int)	lower

Set upper/lower bitrate threshold for adaptation.

Parameters

upper [in] Maximum bitrate that the adaptation cannot exceed (bps) in addition to the constraint defined in the device capability file VOCommonPlayerControl#setDeviceCapabilityByFile.

If the value is 0, the maximum bitrate is constrained by the device capability file if it is specified. Otherwise the maximum bitrate is unconstrained.
If the value is not 0 and the device capability file is not specified, it defines the maximum bitrate threshold
If the value is not 0 and the device capability file is specified, the maximum bitrate threshold is defined as min(upper, max bitrate in device capability file)

Parameters

lower [in] Minimum bitrate that the adaptation cannot drop below (bps).

If the value is 0, the minimum threshold is unconstrained
If the value is not 0, it defines the minimum bitrate threshold that adaptation cannot drop below.

Returns: VO_OSMP_ERR_NONE if successful.

It is recommended to call this API before calling the VOCommonPlayerControl#open:flag:sourceType:openParam: method. However if it is necessary to set the bitrate threshold during playback, call this API when needed, then the player might have a little delay and starts downloading for playback with the defined bitrate.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setDeviceCapabilityByFile: (NSString *) filename

Set the location of device capability file.

The device capability file contains device-specific display sizes and bitrates to optimize performance. An example of cap.xml file is included with the SamplePlayer project. This API only works when VOCommonPlayerConfiguration#enableCPUAdaptation is enabled.

Parameters

filename [in] Location of device capability file.

Returns: VO_OSMP_ERR_NONE if successful; error code if unsuccessful

To set the location of capability file, this API should be called before calling the VOCommonPlayerControl#open:flag:sourceType:openParam: method.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setDRMAdapter: (void *) adapter

Set the DRM adapter.

Parameters

adapter [in] DRM adapter

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setDRMLibrary:	(NSString *)	libName
libApiName:	(NSString *)	libApiName

Set DRM Library name and API name.

Parameters

libName	[in] DRM library name.
libApiName	[in] API name for exporting DRM library.

Returns: VO_OSMP_ERR_NONE if successful .

To set DRM library name and API name, this API must be called before calling the VOCommonPlayerControl#open:flag:sourceType:openParam: method.

If it is required to set the unique identifier or verification information, ensure that you call VOCommonPlayerConfiguration#setDRMUniqueIdentifer or VOCommonPlayerConfiguration#setDRMVerificationInfo after calling this API.

Meanwhile, ensure that VOCommonPlayerConfiguration#setDRMUniqueIdentifer is followed by VOCommonPlayerConfiguration#setDRMVerificationInfo if you need to set both functions.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setDRMUniqueIdentifier: (NSString *) string

Set unique identifier of the device.

Parameters

string [in] Unique identifier string

Returns: VO_OSMP_ERR_NONE if successful

Deprecated:: use new function VOCommonPlayerStatus#getDRMUniqueIdentifier

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setDRMVerificationInfo: (VOOSMPVerificationInfo *) info

Set the verification information to start DRM verification.

Parameters

info	[in] Verification information. VOOSMPVerificationInfo

Returns: VO_OSMP_ERR_NONE if successful

To set the DRM verification information,

This API must be called before calling the VOCommonPlayerControl#open method.
This API must be called after calling the VOCommonPlayerConfiguration#setDRMLibrary method.
This API must be called after calling the VOCommonPlayerConfiguration#setDRMAdapter method.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setHDCPPolicy: (VO_OSMP_HDCP_POLICY) policyType

Set the HDCP policy.

Parameters

policyType [in] HDCP policy type. VO_OSMP_HDCP_POLICY .

Returns: VO_OSMP_RETURN_CODE#VO_OSMP_ERR_NONE if successful.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setInitialBitrate: (int) bitrate

Set the initial bitrate.

The player selects the closest stream at or below that number. If none is available, the player selects the closest one above that number. If an initial bitrate is not set, the player follows the streaming protocol specification. If the behavior is undefined in the protocol being used, the player selects a stream based on definitions in cap.xml, orders in the manifest file, and so on.

Parameters

bitrate [in] Bitrate <bps>.

Returns: VO_OSMP_ERR_NONE if successful

To set the initial bitrate, this API must be called before calling the VOCommonPlayerControl#open:flag:sourceType:openParam: method.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setInitialBufferingTime: (int) time

Set the initial buffering time before starting playback.

Parameters

time	[in] buffering time <milliseconds>

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setInitialBufferTime: (int) time

Set the initial buffering time before starting playback.

Parameters

time	[in] buffering time <milliseconds>

Returns: VO_OSMP_ERR_NONE if successful

Deprecated:: This method is replaced by setInitialBufferingTime: and will be removed in the future.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setLicenseContent: (NSData *) data

Set contents of license file.

Parameters

data	[in] Contents of the license file in a Byte array.

Returns: VO_OSMP_ERR_NONE if successful

To set contents of license file, this API must be called before calling the VOCommonPlayerControl#open method.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setLicenseFilePath: (NSString *) path

Set the location of the license file.

Parameters

path	[in] Location of the license file.

Returns: VO_OSMP_ERR_NONE if successful

To set the location of license file, this API must be called before calling the VOCommonPlayerControl#open method.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setMaxBufferingTime: (int) time

Set the maximum buffering time for playback.

Parameters

time	[in] buffering time (milliseconds)

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setMaxBufferTime: (int) time

Set the maximum buffering time for playback.

Parameters

time	[in] buffering time (milliseconds)

Returns: VO_OSMP_ERR_NONE if successful

Deprecated:: This method is replaced by setMaxBufferingTime: and will be removed in the future.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setParameter:	(int)	paramID
pObj:	(void *)	pObj

Set the value for a specified ID.

This method should only be used on recommendation by VisualOn.

Parameters

paramID	[in] Parameter id.
pObj	[in] Parameter value; relies on parameter id.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setPDConnectionRetryCount: (int) times

Set the number of retry attempts in progressive download module when network connection fails.

Parameters

times [in] the number of retry attempts. Default is 2. Setting this value to -1 to continue retrying until VOCommonPlayerControl#stop be called.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setPlaybackBufferingTime: (int) time

Set the buffering time when re-buffering is needed during playback.

Parameters

time	[in] buffering time (milliseconds)

Returns: VO_OSMP_ERR_NONE if successful.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setPlayIFrameOnly:	(BOOL)	enable
Speed:	(float)	speed

Set I-Frame only mode.

Parameters

enable	[in] I-Frame mode enabled or disabled.
speed	[in] I-Frame mode speed rate.

Returns: VO_OSMP_RETURN_CODE#VO_OSMP_ERR_NONE if successful.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setPreAgreedLicense: (NSString *) str

Set pre-agreed license string.

Parameters

str	[in] Pre-agreed license string.

Returns: VO_OSMP_ERR_NONE if successful.

To set pre-agreed license string, this API must be called before calling the VOCommonPlayerControl#open method.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setPresentationDelay: (int) time

Set the presentation delay time for a live streaming source.

Parameters

time	[in] presentation delay time (milliseconds) for a live streaming source with respective to current time

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setSegmentDownloadRetryCount: (int) times

Set the maximum number of retry attempts to download a corresponding segment from a different bitrate due to DRM errors, server issues, or unsupported media format.

Parameters

times [in] Maximum number of retry attempts. The default is 0.

Returns: VO_OSMP_ERR_NONE if successful.

To set the maximum retry times, this API must be called before calling the VOCommonPlayerControl#open:flag:sourceType:openParam: method.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setSphericalVideoView:	(float)	heading
pitch:	(float)	pitch
fov:	(float)	fov

Set spherical video view.

Parameters

heading	[in] heading indicates the compass heading of the camera.
pitch	[in] pitch (default is 0) specifies the up or down angle. Positive values angle the camera up (with 90 degrees indicating straight up); negative values angle the camera down (with -90 indicating straight down).
fov	[in] fov (default is 90) determines the horizontal field of view of the image. The field of view is express in degrees; The degree should be greater than 0, and should be less than or equal to 120.

Returns: VO_OSMP_ERR_NONE if successful

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setURLQueryString: (NSString *) string

Set URL query string, the query string should be in the format of "key1=value&key2=value".

Parameters

string [in] query string.

Returns: VO_OSMP_RETURN_CODE#VO_OSMP_ERR_NONE if successful.

- (VO_OSMP_RETURN_CODE VOCommonPlayerConfiguration) setZoomMode:	(VO_OSMP_ZOOM_MODE)	mode
rect:	(Rect)	rect

Set video display area.

Parameters

mode	[in] Zoom mode. Refer to VO_OSMP_ZOOM_MODE.
rect	[in] The rectangular area of the video to be displayed. This argument is only used when the zoom mode is VO_OSMP_ZOOM_ZOOMIN. The rectangular area is expressed in terms of video pixel dimensions. When the video size is changed (e.g. due to a dynamic resolution switching), the player automatically adjusts the dimensions of the displayed rectangle according to the video scaling factor.

This API cannot be implemented on Mac OS.

Returns: VO_OSMP_ERR_NONE if successful

The documentation for this protocol was generated from the following file:

VOCommonPlayerConfiguration.h

Instance Methods

Method Documentation