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

    Interface OpenVideoPlayerConfiguration

    interface OpenVideoPlayerConfiguration {
        buttonConfiguration?: VideoPlayerButtonConfiguration;
        countdownTimerConfiguration?: CountdownTimerConfiguration;
        ctaButtonStyle?: VideoPlayerCTAStyle;
        ctaDelay?: VideoPlayerCTADelay;
        ctaHighlightDelay?: VideoPlayerCTADelay;
        ctaWidth?: VideoPlayerCTAWidth;
        enablePictureInPicture?: 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;
    }

    Hierarchy (View Summary)

    Index

    Properties

    buttonConfiguration? countdownTimerConfiguration? ctaButtonStyle? ctaDelay? ctaHighlightDelay? ctaWidth? enablePictureInPicture? pipPlacement? playerStyle? replayBadgeConfiguration? scrollDirection? shareBaseURL? shouldExtendMediaOutsideSafeArea? showBranding? showMuteButton? showPlaybackButton? showShareButton? showVideoDetailTitle? statusBarHidden? statusBarStyle? videoCompleteAction? videoPlayerLogoConfiguration?

    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. Only supported on iOS.

    ctaDelay?: VideoPlayerCTADelay

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

    ctaWidth?: VideoPlayerCTAWidth

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

    enablePictureInPicture?: boolean

    Specifies if Picture in Picture is enabled.

    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. Defaults to full.

    replayBadgeConfiguration?: ReplayBadgeConfiguration

    The configuration of replay badge. Only supported on iOS.

    scrollDirection?: ScrollDirection

    Specifies the scroll direction.

    shareBaseURL?: string

    The share base URL of the video.

    shouldExtendMediaOutsideSafeArea?: boolean

    Specifies if the media should be extended outside the safe area.

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

    showShareButton?: boolean

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

    showVideoDetailTitle?: boolean

    Indicates if the video player shows title.

    statusBarHidden?: boolean

    Specifies if the status bar should be hidden during video playback.

    statusBarStyle?: StatusBarStyle

    Specifies the status bar style during video playback.

    videoCompleteAction?: VideoPlayerCompleteAction

    Behavior occurring after video is complete. Defaults to advanceToNext.

    videoPlayerLogoConfiguration?: VideoPlayerLogoConfiguration

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

    Settings

    Member Visibility

    On This Page

    Properties