Instance Methods | Properties | List of all members
OOOptions Class Reference
Most Commonly Used Classes

Configurations to change the behavior of the OoyalaPlayer. More...

#import <OOOptions.h>

+ Inheritance diagram for OOOptions:

Instance Methods

(instancetype) - init
 Initialize an OOOptions object with the all properties with default values. More...
 
(void) - logProperties
 Logs all properties that are part of this OOOptions. More...
 

Properties

OOFCCTVRatingConfiguration * tvRatingConfiguration
 tvRatingConfiguration TV rating configuration object for current OoyalaPlayer; Default: default setting object for OOFCCTVRatingConfiguration More...
 
OOIQConfiguration * iqConfiguration
 iqConfiguration iq configuration object for current player; Default: default analytics values object like playerID for OOiqConfiguration More...
 
BOOL showCuePoints
 Show cue points for ads if this is set to YES; Default: YES. More...
 
BOOL showLiveContentScrubber
 If set to YES, show the live content scrubber during live content playback (for live stream only). More...
 
BOOL showAdsControls
 If set to YES, show ads controls (show the scrubber) during ad playback. More...
 
BOOL preloadContent
 If set to YES, load the content when the required information and authorization is available.If set to NO, load the content after the pre-roll (if a pre-roll is available). More...
 
BOOL showPromoImage
 If set to YES, show the promo image if a promo image is available. More...
 
NSTimeInterval connectionTimeout
 The timeout value for network requests. More...
 
id< OOSecureURLGenerator > secureURLGenerator
 Helper for signing URLs with provider's secret and API key. More...
 
BOOL enablePictureInPictureSupport
 Enables PiP mode for devices that support it. More...
 
id< AVPictureInPictureControllerDelegate > pipDelegate
 The picture in picture delegate to receive PIP events. More...
 
BOOL bypassPCodeMatching
 Bypass the check to ensure the provided PCode matches the asset's Pcode. More...
 
id< OOPlayerInfo > playerInfo
 The PlayerInfo used when making network requests to the Ooyala servers. More...
 
BOOL disableVASTOoyalaAds
 Disable the support of VAST and Ooyala Ads that is enabled in the SDK by default. More...
 
NSArray< NSString * > * dynamicFilters
 Dynamic Filters to be sent to Azure. More...
 
BOOL HEVCEnabled
 Will try to play the video using HEVC, if possible. More...
 
Float64 initialPlaybackSpeedRate
 The initial playback speed rate. More...
 

Detailed Description

Configurations to change the behavior of the OoyalaPlayer.

Method Documentation

- (instancetype) init

Initialize an OOOptions object with the all properties with default values.

Returns
the initialized OOOptions
- (void) logProperties

Logs all properties that are part of this OOOptions.

Property Documentation

- (BOOL) bypassPCodeMatching
readwritenonatomicassign

Bypass the check to ensure the provided PCode matches the asset's Pcode.

- (NSTimeInterval) connectionTimeout
readwritenonatomicassign

The timeout value for network requests.

Default: 60.0 seconds

- (BOOL) disableVASTOoyalaAds
readwritenonatomicassign

Disable the support of VAST and Ooyala Ads that is enabled in the SDK by default.

- (NSArray<NSString *>*) dynamicFilters
readwritenonatomicassign

Dynamic Filters to be sent to Azure.

- (BOOL) enablePictureInPictureSupport
readwritenonatomicassign

Enables PiP mode for devices that support it.

This does not activate PiP, it will only instantiate the necessary objects needed for PiP mode. Default: NO

- (BOOL) HEVCEnabled
readwritenonatomicassign

Will try to play the video using HEVC, if possible.

- (Float64) initialPlaybackSpeedRate
readwritenonatomicassign

The initial playback speed rate.

Default 1.0.

Warning
: Not working for live, Ad's and VR assets.
- (OOIQConfiguration*) iqConfiguration
readwritenonatomicassign

iqConfiguration iq configuration object for current player; Default: default analytics values object like playerID for OOiqConfiguration

- (id<AVPictureInPictureControllerDelegate>) pipDelegate
readwritenonatomicweak

The picture in picture delegate to receive PIP events.

- (id<OOPlayerInfo>) playerInfo
readwritenonatomicassign

The PlayerInfo used when making network requests to the Ooyala servers.

- (BOOL) preloadContent
readwritenonatomicassign

If set to YES, load the content when the required information and authorization is available.If set to NO, load the content after the pre-roll (if a pre-roll is available).

Default: YES

- (id<OOSecureURLGenerator>) secureURLGenerator
readwritenonatomicassign

Helper for signing URLs with provider's secret and API key.

- (BOOL) showAdsControls
readwritenonatomicassign

If set to YES, show ads controls (show the scrubber) during ad playback.

Default: YES

- (BOOL) showCuePoints
readwritenonatomicassign

Show cue points for ads if this is set to YES; Default: YES.

- (BOOL) showLiveContentScrubber
readwritenonatomicassign

If set to YES, show the live content scrubber during live content playback (for live stream only).

Default: YES

- (BOOL) showPromoImage
readwritenonatomicassign

If set to YES, show the promo image if a promo image is available.

Default: NO

- (OOFCCTVRatingConfiguration*) tvRatingConfiguration
readwritenonatomicassign

tvRatingConfiguration TV rating configuration object for current OoyalaPlayer; Default: default setting object for OOFCCTVRatingConfiguration

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