Optional
buttonOptional
countdownSpecifies countdown timer configuration. Only supported on iOS.
Optional
ctaThe style of CTA button style. Only supported on iOS.
Optional
ctaSpecifies the delay before showing the CTA. Defaults to { type: constant, value: 3 }.
Optional
ctaSpecifies the delay before the highlight animation occurs. Defaults to { type: constant, value: 2 }.
Optional
ctaSpecifies the desired width for the Video Player CTA button. Defaults to fullWidth.
Optional
enableSpecifies if Picture in Picture is enabled.
Optional
playerSets the proportion of the video player to its container. Defaults to full.
Optional
replayThe configuration of replay badge. Only supported on iOS.
Optional
shareThe share base URL of the video.
Optional
showIndicates if Firework branding should be showed or not. Defaults to true.
Optional
showIndicates if the video player shows mute button. Defaults to true.
Optional
showIndicates if the video player shows playback button. Defaults to true.
Optional
showIndicates if the video player shows share button. Defaults to true.
Optional
showIndicates if the video player shows title.
Optional
videoBehavior occurring after video is complete. Defaults to advanceToNext.
Optional
videoSpecifies the logo configuration Defaults to { option: 'disabled' }
Generated using TypeDoc
The host app could use this property to customize the button images of the video player.