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

    Interface PlayerDeckConfiguration

    interface PlayerDeckConfiguration {
        autoplay?: PlayerDeckAutoplayConfiguration;
        backgroundColor?: string;
        contentPadding?: PlayerDeckPadding;
        cornerRadius?: number;
        fullScreen?: PlayerDeckFullScreenConfiguration;
        itemSpacing?: number;
        muteButton?: PlayerDeckMuteButtonConfiguration;
        onFirstDisplayMuteState?: PlayerDeckMuteState;
        playIcon?: PlayerDeckPlayIconConfiguration;
        shareButton?: PlayerDeckShareButtonConfiguration;
        showAdBadge?: boolean;
        subtitleConfiguration?: PlayerDeckSubtitleConfiguration;
    }
    Index

    Properties

    autoplay? backgroundColor? contentPadding? cornerRadius? fullScreen? itemSpacing? muteButton? onFirstDisplayMuteState? playIcon? shareButton? showAdBadge? subtitleConfiguration?

    Properties

    autoplay?: PlayerDeckAutoplayConfiguration

    Configuration of autoplay.

    backgroundColor?: string

    The background color of the player deck in hex string (e.g. "#FFFFFF").

    contentPadding?: PlayerDeckPadding

    The insets to be applied to the content of the deck.

    cornerRadius?: number

    The corner radius of each deck item. Defaults to 8 on iOS.

    fullScreen?: PlayerDeckFullScreenConfiguration

    Configuration of the full screen behavior.

    itemSpacing?: number

    The spacing between each item within the deck.

    muteButton?: PlayerDeckMuteButtonConfiguration

    Configuration of the mute button. Only supported on iOS.

    onFirstDisplayMuteState?: PlayerDeckMuteState

    The mute state when the player deck is first displayed. Defaults to 'default'. Only supported on iOS.

    playIcon?: PlayerDeckPlayIconConfiguration

    Configuration of the play icon.

    shareButton?: PlayerDeckShareButtonConfiguration

    Configuration of the share button.

    showAdBadge?: boolean

    Whether to show the ad badge (sponsored label). Defaults to false.

    subtitleConfiguration?: PlayerDeckSubtitleConfiguration

    The subtitle configuration. Only supported on iOS.

    Settings

    Member Visibility

    On This Page

    Properties