Properties | List of all members
OOAssetDownloadOptions Class Reference
Offline Playback (DTO)

Options object used to create an OODtoAsset. More...

#import <OOAssetDownloadOptions.h>

+ Inheritance diagram for OOAssetDownloadOptions:

Properties

NSString * pcode
 The Ooyala's account provider code. More...
 
NSString * embedCode
 Ooyala's video embed code (asset id) More...
 
OOPlayerDomain * domain
 Ooyala's whitelist domain, for example: "http://www.ooyala.com/". More...
 
id< OOEmbedTokenGenerator > embedTokenGenerator
 Generates an embed token used for OPT (Ooyala Player Token), entitlements, and DRM assets. More...
 
Float32 timeout
 How long to wait, in seconds, for the authorization requests previous to downloading an asset. More...
 
NSNumber * minimumBitrate
 The lowest media bitrate greater than or equal to this value will be selected. More...
 
BOOL allowsCellularAccess
 When this property is enabled users will be able to download an asset using cellular data, e.g. More...
 
OOAssetLoaderDelegate * assetLoaderDelegate
 This property can be used to pass Custom Implementation of AVAssetResourceLoaderDelegate from AVFoundation. More...
 
NSString * fakeURLScheme
 This property can be used to set a fake URL scheme. More...
 

Detailed Description

Options object used to create an OODtoAsset.

Here is an example on how to instantiate this class:

OOAssetDownloadOptions *downloadOptions = [OOAssetDownloadOptions new];
downloadOptions.pcode = @"MY_PCODE";
downloadOptions.embedCode = @"MY_EMBED_CODE";
downloadOptions.domain = [[OOPlayerDomain domainWithString:@"MY_DOMAIN"];
downloadOptions.embedTokenGenerator = myEmbedTokenGeneratorInstance;
downloadOptions.timeout = 10.0;
downloadOptions.minimumBitrate = @(10000);

You can then use the OOAssetDownloadOptions instance to create an OODtoAsset instance.

Property Documentation

- (BOOL) allowsCellularAccess
readwritenonatomicassign

When this property is enabled users will be able to download an asset using cellular data, e.g.

4G, LTE, 3G. Set it to false (NO) to only allow WiFi to be used. By default it is true (YES)

- (OOAssetLoaderDelegate*) assetLoaderDelegate
readwritenonatomicassign

This property can be used to pass Custom Implementation of AVAssetResourceLoaderDelegate from AVFoundation.

This SHOULD always be used with fakeURLScheme property available in OOAssetDownloadOptions. Note : This only for special purposes. It's NOT recommend to use this property. When this property is in use, you CAN NOT use FairPlay.

- (OOPlayerDomain*) domain
readwritenonatomicassign

Ooyala's whitelist domain, for example: "http://www.ooyala.com/".

- (NSString*) embedCode
readwritenonatomicassign

Ooyala's video embed code (asset id)

- (id<OOEmbedTokenGenerator>) embedTokenGenerator
readwritenonatomicassign

Generates an embed token used for OPT (Ooyala Player Token), entitlements, and DRM assets.

- (NSString*) fakeURLScheme
readwritenonatomicassign

This property can be used to set a fake URL scheme.

For example, it changes "http" or "https" TO "fakeScheme" in the 'assetLoaderDelegate' property. This SHOULD always be used with 'assetLoaderDelegate' property available in OOAssetDownloadOptions. Note: This is only for special purposes. It's not recommended to use this property.

- (NSNumber*) minimumBitrate
readwritenonatomicassign

The lowest media bitrate greater than or equal to this value will be selected.

Value should be a NSNumber in bps. If no suitable media bitrate is found, the highest media bitrate will be selected. A negative number or 0, will default to the highest media bitrate.

- (NSString*) pcode
readwritenonatomicassign

The Ooyala's account provider code.

- (Float32) timeout
readwritenonatomicassign

How long to wait, in seconds, for the authorization requests previous to downloading an asset.

Note the timeout is applied to every authorization request that happens in the background, so you might wait longer than specified if something is going wrong. Default: 10.0

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