THEOplayer React Native Connectors
    Preparing search index...

    Interface VideoClip

    The VideoClipEntity object represents a video entity coming from social media, such as TikTok or YouTube.

    VideoClipEntity.

    interface VideoClip {
        availabilityTimeWindows?: DisplayTimeWindow[];
        createdTime: number;
        creator: string;
        creatorImage?: string;
        downloadedOnDevice?: boolean;
        duration: number;
        id?: string;
        lastEngagementTime?: number;
        lastPlaybackPosition?: number;
        name: string;
        platformSpecificPlaybackUri?: PlatformUri[];
        playbackUri: string;
        posters: Poster[];
        type: VideoClip;
        viewCount?: string;
        watchNextType?: WatchNextType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    availabilityTimeWindows? createdTime creator creatorImage? downloadedOnDevice? duration id? lastEngagementTime? lastPlaybackPosition? name platformSpecificPlaybackUri? playbackUri posters type viewCount? watchNextType?

    Properties

    availabilityTimeWindows?: DisplayTimeWindow[]

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

    createdTime: number

    The time at which this entity was created. In epoch milliseconds.

    creator: string

    The creator of this entity.

    creatorImage?: string

    The creator's image uri.

    downloadedOnDevice?: boolean

    Whether the entity was downloaded on the device for offline viewing.

    duration: number

    Duration in milliseconds.

    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.

    platformSpecificPlaybackUri?: PlatformUri[]

    A list of platform-specific deep links to the provider app to start playing the entity.

    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: VideoClip

    The entity type.

    viewCount?: string

    The view count.

    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