React Native THEOplayer SDK
    Preparing search index...

    Interface THEOplayer

    The THEOplayer API.

    interface THEOplayer {
        abr: ABRConfiguration | undefined;
        ads: AdsAPI;
        aspectRatio: AspectRatio;
        audioTracks: MediaTrack[];
        autoplay: boolean;
        backgroundAudioConfiguration: BackgroundAudioConfiguration;
        broadcast: EventBroadcastAPI;
        buffered: TimeRange[];
        cast: CastAPI;
        currentProgramDateTime: number | undefined;
        currentTime: number;
        duration: number;
        height: number | undefined;
        keepScreenOn: boolean;
        manageContentMatching: boolean;
        mediaControl?: MediaControlAPI;
        metrics: MetricsAPI;
        muted: boolean;
        nativeHandle: unknown;
        paused: boolean;
        pipConfiguration: PiPConfiguration;
        playbackRate: number;
        preload: PreloadType;
        presentationMode: PresentationMode;
        renderingTarget?: RenderingTarget;
        seekable: TimeRange[];
        seeking: boolean;
        selectedAudioTrack: number | undefined;
        selectedTextTrack: number | undefined;
        selectedVideoTrack: number | undefined;
        source: SourceDescription | undefined;
        targetVideoQuality: number | number[] | undefined;
        textTracks: TextTrack[];
        textTrackStyle: TextTrackStyle;
        theoads: TheoAdsAPI;
        theoLive: TheoLiveAPI;
        version: PlayerVersion;
        videoHeight: number | undefined;
        videoTracks: MediaTrack[];
        videoWidth: number | undefined;
        volume: number;
        width: number | undefined;
        addEventListener<TType extends keyof PlayerEventMap>(
            type: TType | readonly TType[],
            listener: EventListener<PlayerEventMap[TType]>,
        ): void;
        pause(): void;
        play(): void;
        removeEventListener<TType extends keyof PlayerEventMap>(
            type: TType | readonly TType[],
            listener: EventListener<PlayerEventMap[TType]>,
        ): void;
    }

    Hierarchy (View Summary)

    Index
    abr ads aspectRatio audioTracks autoplay backgroundAudioConfiguration broadcast buffered cast currentProgramDateTime currentTime duration height keepScreenOn manageContentMatching mediaControl? metrics muted nativeHandle paused pipConfiguration playbackRate preload presentationMode renderingTarget? seekable seeking selectedAudioTrack selectedTextTrack selectedVideoTrack source targetVideoQuality textTracks textTrackStyle theoads theoLive version videoHeight videoTracks videoWidth volume width
    addEventListener pause play removeEventListener
    abr: ABRConfiguration | undefined

    The player's adaptive bitrate (ABR) configuration.

    ads: AdsAPI

    The API for advertisements.

    aspectRatio: AspectRatio

    Used to set the aspect ratio of the player.

    iOS
    Android
    audioTracks: MediaTrack[]

    List of audio tracks of the current source.

    autoplay: boolean

    Whether the player should immediately start playback after source change.

    backgroundAudioConfiguration: BackgroundAudioConfiguration

    The active configuration for background audio playback.

    broadcast: EventBroadcastAPI

    Event Broadcast API.

    buffered: TimeRange[]

    Returns a list of TimeRanges that represents the ranges of the media resource that are buffered by the player.

    cast: CastAPI

    The API for casting devices.

    currentProgramDateTime: number | undefined

    The programDateTime for the current playback position of the media, in milliseconds.

    currentTime: number

    The current playback position of the media, in milliseconds.

    duration: number

    The duration of the media, in milliseconds.

    height: number | undefined

    The height of the player.

    keepScreenOn: boolean

    Toggle the wake-lock on the player view. The screen will time out if disabled.

    true

    Android
    manageContentMatching: boolean

    Whether the player manages the display criteria of the TV to match the content.

    false

    iOS


    - Only supported on tvOS.
    - When enabled, and while the player is presented fullscreen, the player sets the display's preferred frame rate and dynamic range to match the content before playback starts.
    - The display only follows these criteria when the viewer enabled content matching on tvOS in "Settings" > "Video and Audio" > "Match Content".
    - A display mode switch can briefly blank the screen, so only enable this on a single, fullscreen-presented player.

    mediaControl?: MediaControlAPI

    The API for media controls.

    metrics: MetricsAPI

    The API for player metrics.

    muted: boolean

    Determines whether audio is muted.

    nativeHandle: unknown

    Native player handle.

    paused: boolean

    Whether the player is paused.

    pipConfiguration: PiPConfiguration

    The active configuration for PiP.

    playbackRate: number

    Used to set the playback rate of the media.

    <br/> - `playbackRate = 0.70` will slow down the playback rate of the media by 30%.
    <br/> - `playbackRate = 1.25` will speed up the playback rate of the media by 25%.


    - Playback rate is represented by a number where 1 is default playback speed.
    - Playback rate must be a positive number.
    - It is recommended that you limit the range to between 0.5 and 4.

    preload: PreloadType

    The preload setting of the player.

    presentationMode: PresentationMode

    The PresentationMode of the player. Can be switched to: picture-in-picture, fullscreen or inline

    renderingTarget?: RenderingTarget

    Specifies where the player is displaying the video.

    SURFACE_VIEW

    Android
    seekable: TimeRange[]

    Returns a list of TimeRanges that represents the ranges of the media resource that are seekable by the player.

    seeking: boolean

    Whether the player is seeking.

    selectedAudioTrack: number | undefined

    Used to set the current selected audio track by passing its uid, or undefined to select none.

    selectedTextTrack: number | undefined

    Used to set the current selected text track by passing its uid, or undefined to select none.

    selectedVideoTrack: number | undefined

    Used to set the current selected video track by passing its uid, or undefined to select none.

    source: SourceDescription | undefined

    A source description that determines the current media resource.

    targetVideoQuality: number | number[] | undefined

    Used to set the current selected video quality by passing its uid, or undefined to select none.

    textTracks: TextTrack[]

    List of text tracks of the current source.

    textTrackStyle: TextTrackStyle

    The text track style API.

    theoads: TheoAdsAPI

    The API for THEOads advertisements.

    theoLive: TheoLiveAPI

    The API for THEOlive.

    version: PlayerVersion

    The player version.

    use sdkVersions instead.

    videoHeight: number | undefined

    The height of the active video rendition, in pixels.

    videoTracks: MediaTrack[]

    List of video tracks of the current source.

    videoWidth: number | undefined

    The width of the active video rendition, in pixels.

    volume: number

    Used to set the volume of the audio.


    - Volume is represented by a floating point number between 0.0 and 1.0.

    width: number | undefined

    The width of the player.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods