fl-player-ads-brightcove/com.quickplay.vstb7.player.ad.brightcove/BrightcoveAdsPlayerBuilder

BrightcoveAdsPlayerBuilder

class BrightcoveAdsPlayerBuilder : PlayerBuilder

Provides extension to PlayerBuilder that builds a AdComposedPlayer instance that plays Brightcove curated streams with ads.

Constructors

constructor()

Functions

adPlaybackPolicy

fun adPlaybackPolicy(adPlaybackPolicy: AdPlaybackPolicy): <Error class: unknown class>

Sets the AdPlaybackPolicy instance that specifies the policy rules for Brightcove ads handling.

build

open override fun ~~build~~(platformContext: <Error class: unknown class>): Player

buildAsync

suspend fun buildAsync(platformContext: <Error class: unknown class>, logger: Logger = defaultPlayerLogger): Result<BrightcovePlayer?, Error?>

Builds a BrightcovePlayer instance based on the supplied builder params.

downloadID

fun downloadID(id: String): PlayerBuilder

drmLicenseURL

fun drmLicenseURL(url: String): PlayerBuilder

drmScheme

fun drmScheme(scheme: DRMScheme): PlayerBuilder

enableSecurityChecks

fun enableSecurityChecks(policies: List<Int>?): PlayerBuilder

excludeMediaSession

fun excludeMediaSession(excludeMediaSession: Boolean): PlayerBuilder

logger

fun logger(logger: Logger): PlayerBuilder

mediaMetadata

fun mediaMetadata(mediaMetadata: MediaMetadata): PlayerBuilder

mediaType

fun mediaType(type: MediaType): PlayerBuilder

mediaURL

fun mediaURL(url: String): PlayerBuilder

networkStack

fun networkStack(networkStack: NetworkStack): PlayerBuilder

palConfiguration

fun palConfiguration(palConfiguration: PALConfiguration, allowPALSessionDataStorage: Boolean = false): <Error class: unknown class>

Sets the PALConfiguration instance that is used in the PALSession initialization. Optionally sets the permission to store user data like cookies, device IDs, and advertising IDs when using PALSession calls. If the value is Boolean.true the user gives the consent to store data. The default value is Boolean.false - no consent.

playbackPolicyHandler

fun playbackPolicyHandler(playbackPolicyHandler: PlaybackPolicyHandler): <Error class: unknown class>

Sets the PlaybackPolicyHandler instance that enforces the policy rules related to the content with Brightcove ads.

playbackPolicyHandlerListener

fun playbackPolicyHandlerListener(playbackPolicyHandlerListener: PlaybackPolicyHandler.Listener): <Error class: unknown class>

Sets the PlaybackPolicyHandler.Listener instance that provides the notification for ad playback policy related events.

playbackProperties

fun playbackProperties(properties: PlaybackProperties): PlayerBuilder

preferredAudioMimeTypes

fun preferredAudioMimeTypes(preferredAudioMimeTypes: Array<String>): PlayerBuilder

preferredVideoMimeTypes

fun preferredVideoMimeTypes(preferredVideoMimeTypes: Array<String>): PlayerBuilder

repeatPlaybackOnStreamEnd

fun repeatPlaybackOnStreamEnd(repeatPlayback: Boolean): PlayerBuilder

seekPreference

fun seekPreference(seekPreference: SeekPreference): PlayerBuilder

setCustomHeaders

fun setCustomHeaders(customHeaders: Map<String, String>?): PlayerBuilder

setDecoderConfiguration

fun setDecoderConfiguration(decoderConfiguration: DecoderConfiguration): PlayerBuilder

setRenderingSurface

fun setRenderingSurface(surface: Surface): PlayerBuilder

setRenderingView

fun setRenderingView(view: View): PlayerBuilder

thumbnailPreviewProperties

fun thumbnailPreviewProperties(thumbnailPreviewEndpointUrl: String, maxConcurrentThumbnailDownloads: Int?, thumbnailPreviewConfig: ThumbnailPreviewConfig?): PlayerBuilder

userAgent

fun userAgent(agent: String): PlayerBuilder

vmapURL

fun vmapURL(vmapURL: String): <Error class: unknown class>

Sets the URL to remote VMAP document that contains ads cue point metadata.