Interface PlayerAudioCommonApi

muted

onEvent$

state

volume

getHandler

• getHandler(playerAudioType: OUTPUT | MAIN): AudioHandlerApi | undefined

  Returns the audio handler for the given OUTPUT or MAIN audio type.

  Parameters

  • playerAudioType: OUTPUT | MAIN

    The audio type (OUTPUT or MAIN).

  Returns AudioHandlerApi | undefined

• getHandler(playerAudioType: SIDECAR, id: string): AudioHandlerApi | undefined

  Returns the audio handler for a specific SIDECAR track.

  Parameters

  • playerAudioType: SIDECAR

    Must be SIDECAR.

  • id: string

    ID of the sidecar audio track.

  Returns AudioHandlerApi | undefined

mute

• mute(): Observable<void>

  Mutes audio output.

  Returns Observable<void>

setMuted

• setMuted(muted: boolean): Observable<void>

  Mutes or unmutes audio output.

  Parameters

  • muted: boolean

    true to mute, false to unmute.

  Returns Observable<void>

setVolume

• setVolume(volume: number): Observable<void>

  Sets the volume level.

  Parameters

  • volume: number

    A value in the range [0, 1].

  Returns Observable<void>

switchTrack

• switchTrack(trackId: string, activate?: boolean): Observable<void>

  Switches the active audio track.

  Parameters

  • trackId: string

    ID of the track to switch to.

  • Optionalactivate: boolean

    Whether to immediately activate the track. Defaults to true.

  Returns Observable<void>

toggleMuted

• toggleMuted(): Observable<void>

  Toggles mute and unmute.

  Returns Observable<void>

unmute

• unmute(): Observable<void>

  Unmutes audio output.

  Returns Observable<void>