Interface StoryBlockConfiguration

Hierarchy

  • StoryBlockConfiguration

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.

ctaButtonStyle?: VideoPlayerCTAStyle

The 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.

Specifies the delay before showing the CTA.

ctaHighlightDelay?: VideoPlayerCTADelay

Specifies the delay before the highlight animation occurs.

Specifies the desired width for the Video Player CTA button.

playerStyle?: VideoPlayerStyle

Sets the proportion of the video player to its container.

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.

showMuteButton?: boolean

Indicates if the video player shows mute button.

showPlaybackButton?: boolean

Indicates if the video player shows playback button.

showShareButton?: boolean

Indicates if the video player shows share button.

showVideoDetailTitle?: boolean

Specifies if the title should be shown.

videoCompleteAction?: VideoPlayerCompleteAction

Behavior 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.

videoPlayerLogoConfiguration?: VideoPlayerLogoConfiguration

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

Generated using TypeDoc