fl-player-ads-ima/com.quickplay.vstb7.player.ima/IMADaiAdsPlayerBuilder

IMADaiAdsPlayerBuilder

class IMADaiAdsPlayerBuilder : PlayerBuilder

Constructors

constructor()

Functions

fun adFrequencyControl(config: AdFrequencyControlConfiguration = AdFrequencyControlConfiguration()): <Error class: unknown class>

Configures Ad Frequency Control for this playback.

adPlaybackPolicy

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

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

adUIElementVisibilityPreference

fun adUIElementVisibilityPreference(adUIElementVisibilityPreference: IMAAdUIVisibilityPreference): <Error class: unknown class>

Allows to control if Ad UI elements, that show e.g. the number of Ads and Ad progress, should be disabled or not if custom Ad UI is required.

build

open fun build(platformContext: PlatformContext): Player

suspend fun build(platformContext: <Error class: unknown class>, adsRequest: SSAIAdsRequest, imaDaiSessionConfig: IMADaiSessionConfig): Result<IMAPlayer?, Error?>

Builds and returns an instance of IMAPlayer configured for Server Side Ad Insertion (SSAI) with DAI support.

copyFrom

fun copyFrom(other: PlayerBuilder)

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

pauseAdView

fun pauseAdView(pauseAdView: ViewGroup): <Error class: unknown class>

Sets the View that represents a UI container for a displayed ad when the playback is paused. "Pause" Ads are a new advertising format for the VOD playback experience. This feature introduces non-intrusive advertisements that appear when a user pauses playback on CTV devices. These ads aim to provide advertisers with a unique opportunity to engage users during natural breaks in their viewing experience, maximizing ad visibility without disrupting content consumption.

playbackProperties

fun playbackProperties(properties: PlaybackProperties): PlayerBuilder

preferredAudioLanguage

fun preferredAudioLanguage(language: AudioLanguageInfo): PlayerBuilder

preferredAudioMimeTypes

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

preferredSubtitleLanguage

fun preferredSubtitleLanguage(languageCode: 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

setStreamURLLoadTimeoutMs

fun setStreamURLLoadTimeoutMs(streamURLLoadTimeoutMs: Long): <Error class: unknown class>

Sets the time in milliseconds to wait for the stream URL to be fetched This is useful for controlling how long the player should wait before proceeding with playback.

sidecarSubtitleTracks

fun sidecarSubtitleTracks(tracks: List<SidecarSubtitleTrack>): PlayerBuilder

thumbnailPreviewProperties

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

userAgent

fun userAgent(agent: String): PlayerBuilder