react-native-firework-sdk
    Preparing search index...

    Interface StoryBlockConfiguration

    interface StoryBlockConfiguration {
        additionalControlsInset?: ControlsInset;
        buttonConfiguration?: VideoPlayerButtonConfiguration;
        countdownTimerConfiguration?: CountdownTimerConfiguration;
        ctaButtonStyle?: VideoPlayerCTAStyle;
        ctaDelay?: VideoPlayerCTADelay;
        ctaHighlightDelay?: VideoPlayerCTADelay;
        ctaWidth?: VideoPlayerCTAWidth;
        enableScrollForVertical?: boolean;
        feedCompleteAction?: FeedCompleteAction;
        isArrowButtonVisible?: boolean;
        isFullscreenArrowButtonVisible?: boolean;
        pipPlacement?: PipPlacement;
        playerStyle?: VideoPlayerStyle;
        replayBadgeConfiguration?: ReplayBadgeConfiguration;
        scrollDirection?: ScrollDirection;
        shareBaseURL?: string;
        shouldExtendMediaOutsideSafeArea?: boolean;
        showBranding?: boolean;
        showMuteButton?: boolean;
        showPlaybackButton?: boolean;
        showShareButton?: boolean;
        showVideoDetailTitle?: boolean;
        statusBarHidden?: boolean;
        statusBarStyle?: StatusBarStyle;
        videoCompleteAction?: VideoPlayerCompleteAction;
        videoPlayerLogoConfiguration?: VideoPlayerLogoConfiguration;
    }
    Index

    Properties

    additionalControlsInset? buttonConfiguration? countdownTimerConfiguration? ctaButtonStyle? ctaDelay? ctaHighlightDelay? ctaWidth? enableScrollForVertical? feedCompleteAction? isArrowButtonVisible? isFullscreenArrowButtonVisible? pipPlacement? playerStyle? replayBadgeConfiguration? scrollDirection? shareBaseURL? shouldExtendMediaOutsideSafeArea? showBranding? showMuteButton? showPlaybackButton? showShareButton? showVideoDetailTitle? statusBarHidden? statusBarStyle? videoCompleteAction? videoPlayerLogoConfiguration?

    Properties

    additionalControlsInset?: ControlsInset

    Specifies the additional controls inset for embedded mode.

    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. Note: iOSFontInfo property is only supported on iOS.

    ctaDelay?: VideoPlayerCTADelay

    Specifies the delay before showing the CTA.

    ctaHighlightDelay?: VideoPlayerCTADelay

    Specifies the delay before the highlight animation occurs.

    ctaWidth?: VideoPlayerCTAWidth

    Specifies the desired width for the Video Player CTA button.

    enableScrollForVertical?: boolean

    Specifies scroll enabled for vertical. This property only takes effect when scrollDirection is set to vertical.

    feedCompleteAction?: FeedCompleteAction

    Behavior occurring after feed plays the last video. This property only applies to full screen mode. Defaults to loop.

    isArrowButtonVisible?: boolean

    Indicates if the navigation arrow buttons for switching between previous and next videos are enabled in embedded story block mode. Defaults to true.

    isFullscreenArrowButtonVisible?: boolean

    Indicates if the navigation arrow buttons for switching between previous and next videos are enabled in fullscreen mode. Defaults to true.

    pipPlacement?: PipPlacement

    Specifies the placement for in-app PiP. Defaults to bottomRight. Only supported on iOS.

    playerStyle?: VideoPlayerStyle

    Sets the proportion of the video player to its container.

    replayBadgeConfiguration?: ReplayBadgeConfiguration

    The configuration of replay badge. Only supported on iOS.

    scrollDirection?: ScrollDirection

    Specifies the scroll direction for the story block.

    shareBaseURL?: string

    The share base URL of the video.

    shouldExtendMediaOutsideSafeArea?: boolean

    Specifies if the media should be extended outside the safe area. This property only applies to full screen mode.

    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.

    statusBarHidden?: boolean

    Specifies if the status bar should be hidden during video playback. This property only applies to full screen mode.

    statusBarStyle?: StatusBarStyle

    Specifies the status bar style during video playback. This property only applies to full screen mode.

    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' }

    Settings

    Member Visibility

    On This Page

    Properties