Optional
buttonOptional
countdownSpecifies countdown timer configuration.
Optional
ctaThe style of CTA button style. On iOS, the property only applies to full-screen story block but not to compact story block. Only supported on iOS.
Optional
ctaSpecifies the delay before showing the CTA.
Optional
ctaSpecifies the delay before the highlight animation occurs.
Optional
ctaSpecifies the desired width for the Video Player CTA button.
Optional
playerSets the proportion of the video player to its container.
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.
Optional
showIndicates if the video player shows mute button.
Optional
showIndicates if the video player shows playback button.
Optional
showIndicates if the video player shows share button.
Optional
showSpecifies if the title should be shown.
Optional
videoBehavior occurring after video is complete. On iOS, the property only applies to full screen mode but not to embedded mode. On Android, the property applies to both full screen and embedded modes.
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.