com.ooyala.android.configuration.Options.Builder Class Reference

Supports a fluid syntax for configuration. More...

Public Member Functions
	Builder ()
	Defaults to the following values: tvRatingConfiguration = FCCTVRatingConfiguration.s_getDefaultTVRatingConfiguration(); exoConfiguration = ExoConfiguration.buildDefaultExoConfiguration(); iqConfiguration = IqConfiguration.getDefaultIqConfiguration(); showCuePoints = true; showAdsControls = true; showLiveControls = true; preloadContent = true; showPromoImage = false; connectionTimeoutInMillisecond = 0; readTimeoutInMillisecond = 0; preventVideoViewSharing = false; playerInfo = null; showNativeLearnMore = true; bypassPCodeMatching = false; disableVASTOoyalaAds = false; dynamicFilters = null; hevcEnabled = false; widevineSecurityL3Enabled = false; initialPlaybackSpeed = PlaybackConstants.DEFAULT_PLAYBACK_SPEED;. More...
Builder	setTVRatingConfiguration (FCCTVRatingConfiguration tvRatingConfiguration)
	Set the TV Rating configuration. More...
Builder	setIqConfiguration (IqConfiguration iqConfiguration)
Builder	setExoConfiguration (ExoConfiguration exoConfig)
	Set the ExoPlayer configuration. More...
Builder	setShowCuePoints (boolean showCuePoints)
	Set show cue points. More...
Builder	setShowAdsControls (boolean showAdsControls)
	Set show ads controls. More...
Builder	setPreloadContent (boolean preloadContent)
	Set preload content. More...
Builder	setShowPromoImage (boolean showPromoImage)
	Set show promotion image. More...
Builder	setShowLiveControls (boolean showLiveControls)
	Set show live controls. More...
Builder	setConnectionTimeout (int connectionTimeoutInMillisecond)
	Set the connection timeout value used by networking operations. More...
Builder	setReadTimeout (int readTimeoutInMillisecond)
	Set the stream read timeout value used by networking operations. More...
Builder	setPreventVideoViewSharing (boolean preventVideoViewSharing)
Builder	setUseExoPlayer (boolean useExoPlayer)
	Set use exoplayer. More...
Builder	setAudioOnly (boolean audioOnly)
	Set audio only mode. More...
Builder	setUseAdobePlayer (boolean useAdobePlayer)
	Set use adobePlayer. More...
Builder	setPlayerInfo (PlayerInfo playerInfo)
	Set the player info to be communicated to the cloud. More...
Builder	setShowNativeLearnMoreButton (boolean showNativeLearnMoreButton)
	Set show native learn more button. More...
Builder	setBypassPCodeMatching (boolean bypassPCodeMatching)
	Set bypass PCode matching. More...
Builder	setDisableVASTOoyalaAds (boolean disableVASTOoyalaAds)
	Set disable VAST and Ooyala ads. More...
Builder	setDynamicFilters (List< String > dynamicFilters)
	Set the dynamic filters to be sent to Azure. More...
Builder	enableHevc (boolean hevcEnabled)
	If true, the player will try to play the video using HEVC if the device is capable of playing it. More...
Builder	setWidevineSecurityL3Enabled (boolean widevineSecurityL3Enabled)
	Enable the widevine security level to L3. More...
Builder	setInitialPlaybackSpeed (float initialPlaybackSpeed)
	Set the initial playback speed. More...
Options	build ()

Detailed Description

Supports a fluid syntax for configuration.

Constructor & Destructor Documentation

com.ooyala.android.configuration.Options.Builder.Builder

(

)

Defaults to the following values: tvRatingConfiguration = FCCTVRatingConfiguration.s_getDefaultTVRatingConfiguration(); exoConfiguration = ExoConfiguration.buildDefaultExoConfiguration(); iqConfiguration = IqConfiguration.getDefaultIqConfiguration(); showCuePoints = true; showAdsControls = true; showLiveControls = true; preloadContent = true; showPromoImage = false; connectionTimeoutInMillisecond = 0; readTimeoutInMillisecond = 0; preventVideoViewSharing = false; playerInfo = null; showNativeLearnMore = true; bypassPCodeMatching = false; disableVASTOoyalaAds = false; dynamicFilters = null; hevcEnabled = false; widevineSecurityL3Enabled = false; initialPlaybackSpeed = PlaybackConstants.DEFAULT_PLAYBACK_SPEED;.

Member Function Documentation

Options com.ooyala.android.configuration.Options.Builder.build

(

)

Builder com.ooyala.android.configuration.Options.Builder.enableHevc

(

boolean

hevcEnabled

)

If true, the player will try to play the video using HEVC if the device is capable of playing it.

Parameters

hevcEnabled

true to enable HEVC support, false otherwise.

Builder com.ooyala.android.configuration.Options.Builder.setAudioOnly

(

boolean

audioOnly

)

Set audio only mode.

Builder com.ooyala.android.configuration.Options.Builder.setBypassPCodeMatching

(

boolean

bypassPCodeMatching

)

Set bypass PCode matching.

Parameters

bypassPCodeMatching

- True to bypass PCode matching. The default value is false.

Builder com.ooyala.android.configuration.Options.Builder.setConnectionTimeout

(

int

connectionTimeoutInMillisecond

)

Set the connection timeout value used by networking operations.

Parameters

connectionTimeoutInMillisecond

- The connection timeout in milliseconds. The default value is 0 (never times out).

Builder com.ooyala.android.configuration.Options.Builder.setDisableVASTOoyalaAds

(

boolean

disableVASTOoyalaAds

)

Set disable VAST and Ooyala ads.

This does not affect IMA, Freewheel, Pulse, or other third party ad managers This only affects VAST and Ooyala ads, as defined in the backlot ad sets

Parameters

disableVASTOoyalaAds

- True to disable VAST and Ooyala Ad Managers

Builder com.ooyala.android.configuration.Options.Builder.setDynamicFilters

(

List< String >

dynamicFilters

)

Set the dynamic filters to be sent to Azure.

Parameters

dynamicFilters

- True to disable VAST and Ooyala Ad Managers

Builder com.ooyala.android.configuration.Options.Builder.setExoConfiguration

(

ExoConfiguration

exoConfig

)

Set the ExoPlayer configuration.

Parameters

exoConfig

- The configuration.

Returns

this.

Builder com.ooyala.android.configuration.Options.Builder.setInitialPlaybackSpeed

(

float

initialPlaybackSpeed

)

Set the initial playback speed.

Parameters

initialPlaybackSpeed

- The default factor by which playback will be sped up. Must be more than MIN_PLAYBACK_SPEED and less than MAX_PLAYBACK_SPEED (see com.ooyala.android.playback.PlaybackConstants). If the initial playback speed is out of the allowed range, the playback rate will be set to closest MIN_PLAYBACK_SPEED or MAX_PLAYBACK_SPEED level.

Returns

this.

Builder com.ooyala.android.configuration.Options.Builder.setIqConfiguration

(

IqConfiguration

iqConfiguration

)

Builder com.ooyala.android.configuration.Options.Builder.setPlayerInfo

(

PlayerInfo

playerInfo

)

Set the player info to be communicated to the cloud.

Parameters

playerInfo

- The info

Builder com.ooyala.android.configuration.Options.Builder.setPreloadContent

(

boolean

preloadContent

)

Set preload content.

Parameters

preloadContent

- True to preload, false otherwise. The default value is true.

Returns

this.

Builder com.ooyala.android.configuration.Options.Builder.setPreventVideoViewSharing

(

boolean

preventVideoViewSharing

)

Builder com.ooyala.android.configuration.Options.Builder.setReadTimeout

(

int

readTimeoutInMillisecond

)

Set the stream read timeout value used by networking operations.

Parameters

readTimeoutInMillisecond

- The read timeout in milliseconds. The default value is 0, (never times out).

Builder com.ooyala.android.configuration.Options.Builder.setShowAdsControls

(

boolean

showAdsControls

)

Set show ads controls.

Parameters

showAdsControls

- True to show controls while playing ads, false otherwise. The default value is true.

Returns

this.

Builder com.ooyala.android.configuration.Options.Builder.setShowCuePoints

(

boolean

showCuePoints

)

Set show cue points.

Parameters

showCuePoints

- True to show, false otherwise, the default value is true.

Returns

this.

Builder com.ooyala.android.configuration.Options.Builder.setShowLiveControls

(

boolean

showLiveControls

)

Set show live controls.

Parameters

showLiveControls

- True to show, false otherwise. The default value is true.

Returns

Builder com.ooyala.android.configuration.Options.Builder.setShowNativeLearnMoreButton

(

boolean

showNativeLearnMoreButton

)

Set show native learn more button.

Parameters

showNativeLearnMoreButton

- True to show, false otherwise. The default value is true.

Builder com.ooyala.android.configuration.Options.Builder.setShowPromoImage

(

boolean

showPromoImage

)

Set show promotion image.

Parameters

showPromoImage

- True to show, false otherwise. The default value is false.

Returns

this.

Builder com.ooyala.android.configuration.Options.Builder.setTVRatingConfiguration

(

FCCTVRatingConfiguration

tvRatingConfiguration

)

Set the TV Rating configuration.

Parameters

tvRatingConfiguration

- The configuration.

Returns

this.

Builder com.ooyala.android.configuration.Options.Builder.setUseAdobePlayer

(

boolean

useAdobePlayer

)

Set use adobePlayer.

Parameters

useAdobePlayer

- True to use, false otherwise. The default value is false.

Builder com.ooyala.android.configuration.Options.Builder.setUseExoPlayer

(

boolean

useExoPlayer

)

Set use exoplayer.

Parameters

useExoPlayer

- True to use ExoPlayer, false uses MediaPlayer. The default value is true.

Builder com.ooyala.android.configuration.Options.Builder.setWidevineSecurityL3Enabled

(

boolean

widevineSecurityL3Enabled

)

Enable the widevine security level to L3.

Parameters

widevineSecurityL3Enabled

- True to enable Widevine Security level to L3. Default is false

CAUTION: This flag is only used for very specific use case where android devices originally shipped with android 4.3.x-4.4.x and updated to 5.x later on. Android OS identify these type of devices as Widevine L1 but in reality they do not have hardware capability to handle L1 security. So, we need to force player to use Widevine L3.

As this is very specific to devices, we recommend to set this flag to true by identifying error prone devices. You can identify device by using android (android.os.Build) api.