THEOplayer React Native Connectors
    Preparing search index...

    Interface ClusterEntity

    An Entity that can be part of a cluster, "Continuation", "Recommendation" or "Featured".

    interface ClusterEntity {
        availabilityTimeWindows?: DisplayTimeWindow[];
        id?: string;
        lastEngagementTime?: number;
        lastPlaybackPosition?: number;
        name: string;
        playbackUri?: string;
        posters: Poster[];
        type: EntityType;
        watchNextType?: WatchNextType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    availabilityTimeWindows? id? lastEngagementTime? lastPlaybackPosition? name playbackUri? posters type watchNextType?

    Properties

    availabilityTimeWindows?: DisplayTimeWindow[]

    A list of time windows at which the entity is available.

    id?: string

    The optional entity id.

    lastEngagementTime?: number

    The last engagement time in milliseconds. Must be provided when the item is in the Continuation cluster.

    lastPlaybackPosition?: number

    The last playback position in milliseconds. Must be provided when the item is in the Continuation cluster and WatchNextType is CONTINUE. In epoch milliseconds.

    name: string

    The entity's name or title.

    playbackUri?: string

    The deep link to the provider app to start playing the entity.

    posters: Poster[]

    At least one image is required, and must be provided with an aspect ratio. (Landscape is preferred but passing both portrait and landscape images for different scenarios is recommended.)

    type: EntityType

    The entity's type.

    watchNextType?: WatchNextType

    WatchNext type in case the entity is in a continuation cluster. Either continue, new, next or watchlist.

    Settings

    Member Visibility

    On This Page

    Properties