Interface VideoPlayerConfiguration

Hierarchy

Properties

buttonConfiguration?: VideoPlayerButtonConfiguration

The host app could use this property to customize the button images of the video player.

countdownTimerConfiguration?: CountdownTimerConfiguration

Specifies countdown timer configuration. Only supported on iOS.

ctaButtonStyle?: VideoPlayerCTAStyle

The style of CTA button style. Only supported on iOS.

Specifies the delay before showing the CTA. Defaults to { type: constant, value: 3 }.

ctaHighlightDelay?: VideoPlayerCTADelay

Specifies the delay before the highlight animation occurs. Defaults to { type: constant, value: 2 }.

Specifies the desired width for the Video Player CTA button. Defaults to fullWidth.

playerStyle?: VideoPlayerStyle

Sets the proportion of the video player to its container. Defaults to full.

replayBadgeConfiguration?: ReplayBadgeConfiguration

The configuration of replay badge. Only supported on iOS.

shareBaseURL?: string

The share base URL of the video.

showBranding?: boolean

Indicates if Firework branding should be showed or not. Defaults to true.

showMuteButton?: boolean

Indicates if the video player shows mute button. Defaults to true.

showPlaybackButton?: boolean

Indicates if the video player shows playback button. Defaults to false on iOS. Default to true on Android.

showShareButton?: boolean

Indicates if the video player shows share button. Defaults to true.

showVideoDetailTitle?: boolean

Indicates if the video player shows title.

videoCompleteAction?: VideoPlayerCompleteAction

Behavior occurring after video is complete. Defaults to advanceToNext.

videoPlayerLogoConfiguration?: VideoPlayerLogoConfiguration

Specifies the logo configuration Defaults to { option: 'disabled' }

Generated using TypeDoc