<VOOSMPStreamingDownloader > Protocol Reference

#import <VOOSMPStreamingDownloader.h>

+ Inheritance diagram for <VOOSMPStreamingDownloader >:

Instance Methods

(id) - init:initParam:
 Initialize a player instance. More...
 
(VO_OSMP_RETURN_CODE) - open:flag:localDir:
 Open a media source. More...
 
(VO_OSMP_RETURN_CODE) - close
 Close a media source. More...
 
(VO_OSMP_RETURN_CODE) - start
 Start downloading the content. More...
 
(VO_OSMP_RETURN_CODE) - stop
 Stop downloading the content. More...
 
(VO_OSMP_RETURN_CODE) - pause
 Pause the content download. More...
 
(VO_OSMP_RETURN_CODE) - resume
 Resume the content download. More...
 
(VO_OSMP_RETURN_CODE) - setDRMVerificationInfo:
 Set the information to start DRM verification. More...
 
(VO_OSMP_RETURN_CODE) - setDRMUniqueIdentifier:
 Set unique identifier of the device. More...
 
(VO_OSMP_RETURN_CODE) - setDRMLibrary:libApiName:
 Set DRM Library name and API name. More...
 
(id< VOOSMPStreamingDownloaderProgressInfo >) - getDuration
 Get duration of stream downloaded so far, and total duration of stream. More...
 
(VO_OSMP_DRM_KEY_EXPIRED_STATUS) - getDRMKeyExpiredStatus
 Check if the downloaded DRM key of current link is expired. More...
 
(VO_OSMP_RETURN_CODE) - deleteContent:
 Delete content that has been downloaded. More...
 

Method Documentation

- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) close

Close a media source.

Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) deleteContent: (NSString *)  URL

Delete content that has been downloaded.

Parameters
URL[in] source file description (for example, a URL or a file descriptor)
Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_DRM_KEY_EXPIRED_STATUS VOOSMPStreamingDownloader) getDRMKeyExpiredStatus

Check if the downloaded DRM key of current link is expired.

To get the status of downloaded DRM key, this API must be called after calling the VOCommonPlayerControl#open:flag:sourceType:openParam: method.

Returns
DRM key expired status, refer to VO_OSMP_DRM_KEY_EXPIRED_STATUS.
- (id<VOOSMPStreamingDownloaderProgressInfo> VOOSMPStreamingDownloader) getDuration

Get duration of stream downloaded so far, and total duration of stream.

Returns
VOOSMPStreamingDownloaderProgressInfo object if successful; nil if unsuccessful
- (id VOOSMPStreamingDownloader) init: (id< VOOSMPStreamingDownloaderDelegate >)  delegate
initParam: (VOOSMPStreamingDownloaderInitParam *)  initParam 

Initialize a player instance.

This function must be called first to start a session.
Parameters
delegate[in] Refer to VOOSMPStreamingDownloaderDelegate
initParam[in] Refer to VOOSMPStreamingDownloaderInitParam
Returns
player object if successful; nil if unsuccessful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) open: (NSString *)  url
flag: (unsigned int)  flag
localDir: (NSString *)  localDir 

Open a media source.

Parameters
url[in] Source file description (for example, an URL or a file descriptor, etc.)
flag[in] Flag for opening a media source
localDir[in] Directory in which content files are saved
Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) pause

Pause the content download.

Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) resume

Resume the content download.

Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) 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

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

Set unique identifier of the device.

Parameters
string[in] Unique identifier string
Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) setDRMVerificationInfo: (VOOSMPVerificationInfo *)  info

Set the information to start DRM verification.

Parameters
info[in] Verification information.
Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) start

Start downloading the content.

Returns
VO_OSMP_ERR_NONE if successful
- (VO_OSMP_RETURN_CODE VOOSMPStreamingDownloader) stop

Stop downloading the content.

Returns
VO_OSMP_ERR_NONE if successful

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