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

    Interface IPlayerDeckProps

    interface IPlayerDeckProps {
        channel?: string;
        contentId?: string;
        dynamicContentParameters?: { [key: string]: string[] };
        enablePictureInPicture?: boolean;
        enableSystemPictureInPicture?: boolean;
        hashtagFilterExpression?: string;
        onPlayerDeckDidStartPictureInPicture?: (error?: FWError) => void;
        onPlayerDeckDidStopPictureInPicture?: (error?: FWError) => void;
        onPlayerDeckEmpty?: (error?: FWError) => void;
        onPlayerDeckGetFeedId?: (feedId: string) => void;
        onPlayerDeckLoadFinished?: (error?: FWError) => void;
        onPlayerDeckVideosLoaded?: (videos: VideoPlaybackDetails[]) => void;
        playerDeckConfiguration?: PlayerDeckConfiguration;
        playlist?: string;
        playlistGroup?: string;
        productIds?: string[];
        source: PlayerDeckSource;
        style?: StyleProp<ViewStyle>;
        videoPlayerConfiguration?: VideoPlayerConfiguration;
    }
    Index

    Properties

    channel? contentId? dynamicContentParameters? enablePictureInPicture? enableSystemPictureInPicture? hashtagFilterExpression? onPlayerDeckDidStartPictureInPicture? onPlayerDeckDidStopPictureInPicture? onPlayerDeckEmpty? onPlayerDeckGetFeedId? onPlayerDeckLoadFinished? onPlayerDeckVideosLoaded? playerDeckConfiguration? playlist? playlistGroup? productIds? source style? videoPlayerConfiguration?

    Properties

    channel?: string

    Channel id. Required when the source is set as channel, playlist, or dynamicContent.

    contentId?: string

    The video or live stream id. Only supported on iOS.

    dynamicContentParameters?: { [key: string]: string[] }

    Dynamic content parameters. Required when the source is set as dynamicContent.

    enablePictureInPicture?: boolean

    Specifies if Picture in Picture is enabled.

    enableSystemPictureInPicture?: boolean

    Controls whether the system (native iOS) Picture-in-Picture is enabled. Defaults to true. Only supported on iOS.

    hashtagFilterExpression?: string

    Hashtag filter expression. Required when the source is set as hashtagPlaylist.

    onPlayerDeckDidStartPictureInPicture?: (error?: FWError) => void

    Start Picture in Picture callback. Only supported on iOS.

    onPlayerDeckDidStopPictureInPicture?: (error?: FWError) => void

    Stop Picture in Picture callback. Only supported on iOS.

    onPlayerDeckEmpty?: (error?: FWError) => void

    The callback is triggered when there are no items in the player deck.

    onPlayerDeckGetFeedId?: (feedId: string) => void

    The host app could use this callback to get feed id.

    onPlayerDeckLoadFinished?: (error?: FWError) => void

    The feed loading result callback. It means loading successfully when error equals to undefined.

    onPlayerDeckVideosLoaded?: (videos: VideoPlaybackDetails[]) => void

    The callback is triggered when videos are loaded in the player deck. It fires for the initial page and again for every subsequent page (load more), and each call delivers only the newly loaded batch of videos rather than the accumulated list. On Android it also fires for pull-to-refresh and for the pages loaded by the full-screen player opened from this player deck.

    playerDeckConfiguration?: PlayerDeckConfiguration

    Configuration of the player deck.

    playlist?: string

    Playlist id. Required when the source is set as playlist.

    playlistGroup?: string

    PlaylistGroup id. Required when the source is set as playlistGroup. Only supported on iOS.

    productIds?: string[]

    Product ids used to generate the sku feed.

    source: PlayerDeckSource

    The video feed source for the player deck. Defaults to discover.

    style?: StyleProp<ViewStyle>

    Standard React Native View Style.

    videoPlayerConfiguration?: VideoPlayerConfiguration

    Configuration of the video player (for full-screen playback).

    Settings

    Member Visibility

    On This Page

    Properties