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

    Interface IVideoFeedProps

    The props of VideoFeed component.

    interface IVideoFeedProps {
        adConfiguration?: AdConfiguration;
        channel?: string;
        contentId?: string;
        dynamicContentParameters?: { [key: string]: string[] };
        enablePictureInPicture?: boolean;
        hashtagFilterExpression?: string;
        mode?: VideoFeedMode;
        onVideoFeedDidStartPictureInPicture?: (error?: FWError) => void;
        onVideoFeedDidStopPictureInPicture?: (error?: FWError) => void;
        onVideoFeedEmpty?: (error?: FWError) => void;
        onVideoFeedGetFeedId?: (feedId: string) => void;
        onVideoFeedLoadFinished?: (error?: FWError) => void;
        playlist?: string;
        playlistGroup?: string;
        productIds?: string[];
        source: VideoFeedSource;
        style?: StyleProp<ViewStyle>;
        videoFeedConfiguration?: VideoFeedConfiguration;
        videoPlayerConfiguration?: VideoPlayerConfiguration;
    }
    Index

    Properties

    adConfiguration? channel? contentId? dynamicContentParameters? enablePictureInPicture? hashtagFilterExpression? mode? onVideoFeedDidStartPictureInPicture? onVideoFeedDidStopPictureInPicture? onVideoFeedEmpty? onVideoFeedGetFeedId? onVideoFeedLoadFinished? playlist? playlistGroup? productIds? source style? videoFeedConfiguration? videoPlayerConfiguration?

    Properties

    adConfiguration?: AdConfiguration

    Ad configuration of the feed.

    channel?: string

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

    contentId?: string

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

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

    The dynamic content parameters of the feed. Required when the source is set as dynamicContent.

    enablePictureInPicture?: boolean

    Specifies if Picture in Picture is enabled.

    hashtagFilterExpression?: string

    Hashtag filter expression is an s-expression used to provide feeds filtered by hashtags with specified criteria. Queries are specified with boolean predicates on what hashtags are there on the video. For instance, (and sport food) (or sport food) (and sport (or food comedy)) sport are all valid expressions. Non-UTF-8 characters are not allowed. If using boolean predicates, the expression needs to be wrapped with parenthesis. Required when the source is set as hashtagPlaylist.

    mode?: VideoFeedMode

    One of three available display modes. Defaults to row.

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

    Start Picture in Picture callback. Only supported on iOS.

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

    Stop Picture in Picture callback. Only supported on iOS.

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

    The callback is triggered when there are no items in the story block. The callback is triggered in the following cases:

    1. Loading successfully but the back end returns an empty list.
    2. The load failed and list is empty. onVideoFeedLoadFinished will also be triggered when onVideoFeedEmpty is triggered.
    onVideoFeedGetFeedId?: (feedId: string) => void

    The host app could use this callback to get feed id. The feed id can be used for conversion tracking.

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

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

    playlist?: string

    Playlist id of the feed. Please note channel id is necessary. Required when the source is set as playlist.

    playlistGroup?: string

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

    productIds?: string[]

    Product ids used to generate the sku feed

    source: VideoFeedSource

    One of five available video feed sources.The playlistGroup is only supported on iOS. Defaults to discover.

    style?: StyleProp<ViewStyle>

    Standard React Native View Style.

    videoFeedConfiguration?: VideoFeedConfiguration

    Configuration of the feed.

    videoPlayerConfiguration?: VideoPlayerConfiguration

    Configuration of the player.

    Settings

    Member Visibility

    On This Page

    Properties