React Native THEOplayer SDK
    Preparing search index...

    Interface IntegrationExperimental

    Describes optional playback overrides supplied by a player facade integration.


    - Requires PlayerConfiguration.usePlayerFacade when creating the player.
    - Registration takes place on the Web native handle or through the Android native API, not on the React Native player API.
    - Omitted hooks and nullish getter results delegate to the content player.
    - The integration owns playback synchronization and must dispatch events when its public state changes.

    This API is subject to change or removal without notice.

    Android
    Web
    interface Integration {
        getCurrentTime?(): number | null | undefined;
        getDuration?(): number | null | undefined;
        getMuted?(): boolean | null | undefined;
        getVolume?(): number | null | undefined;
        isPaused?(): boolean | null | undefined;
        isSeeking?(): boolean | null | undefined;
        pause?(): boolean;
        play?(): boolean;
        setCurrentTime?(currentTime: number): boolean;
        setMuted?(muted: boolean): boolean;
        setVolume?(volume: number): boolean;
    }
    Index
    getCurrentTime? getDuration? getMuted? getVolume? isPaused? isSeeking? pause? play? setCurrentTime? setMuted? setVolume?
    • Experimental

      Returns the current playback time, in seconds.

      Returns number | null | undefined

      A finite, non-negative time, or null or undefined to use the content player's time. Invalid times also fall back to the content player.

    • Experimental

      Returns the playback duration, in seconds.

      Returns number | null | undefined

      The duration, or null or undefined to use the content player's duration. Infinity and NaN are preserved for live or unknown durations.

    • Experimental

      Returns whether audio is muted.

      Returns boolean | null | undefined

      The muted state, or null or undefined to use the content player's state.

    • Experimental

      Returns the audio volume.

      Returns number | null | undefined

      A volume between 0 and 1, or null or undefined to use the content player's volume.

    • Experimental

      Returns whether playback is paused.

      Returns boolean | null | undefined

      The paused state, or null or undefined to use the content player's state.

    • Experimental

      Returns whether a seek is in progress.

      Returns boolean | null | undefined

      The seeking state, or null or undefined to use the content player's state.

    • Experimental

      Requests playback to pause.

      Returns boolean

      true if handled, or false to pause the content player instead.

    • Experimental

      Requests playback to start or resume.

      Returns boolean

      true if handled, or false to play the content player instead.

    • Experimental

      Requests a seek to the given playback time.

      Parameters

      • currentTime: number

        The requested time, in seconds.

      Returns boolean

      true if handled, or false to seek the content player instead.

    • Experimental

      Requests a change to the muted state.

      Parameters

      • muted: boolean

        Whether audio should be muted.

      Returns boolean

      true if handled, or false to update the content player instead.

    • Experimental

      Requests a change to the audio volume.

      Parameters

      • volume: number

        The requested volume, between 0 and 1.

      Returns boolean

      true if handled, or false to update the content player instead.

    Settings
    Member Visibility

    On This Page
    Methods