Interface IntegrationExperimental

Describes optional playback overrides supplied by a player facade integration.

Remarks


- 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.

Platform

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

Methods

getCurrentTime? getDuration? getMuted? getVolume? isPaused? isSeeking? pause? play? setCurrentTime? setMuted? setVolume?

Methods

Optional getCurrentTime

  • getCurrentTime(): undefined | null | number

  • Returns the current playback time, in seconds.

    Returns undefined | null | number

    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.

Optional getDuration

  • getDuration(): undefined | null | number

  • Returns the playback duration, in seconds.

    Returns undefined | null | number

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

Optional getMuted

  • getMuted(): undefined | null | boolean

  • Returns whether audio is muted.

    Returns undefined | null | boolean

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

Optional getVolume

  • getVolume(): undefined | null | number

  • Returns the audio volume.

    Returns undefined | null | number

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

Optional isPaused

  • isPaused(): undefined | null | boolean

  • Returns whether playback is paused.

    Returns undefined | null | boolean

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

Optional isSeeking

  • isSeeking(): undefined | null | boolean

  • Returns whether a seek is in progress.

    Returns undefined | null | boolean

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

Optional pause

  • pause(): boolean

  • Requests playback to pause.

    Returns boolean

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

Optional play

  • play(): boolean

  • Requests playback to start or resume.

    Returns boolean

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

Optional setCurrentTime

  • setCurrentTime(currentTime): boolean

  • 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.

Optional setMuted

  • setMuted(muted): boolean

  • 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.

Optional setVolume

  • setVolume(volume): boolean

  • 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

Theme

On This Page

getCurrentTimegetDurationgetMutedgetVolumeisPausedisSeekingpauseplaysetCurrentTimesetMutedsetVolume