Class PlayerAudioInternal

Implements

PlayerAudioInternalApi
Destroyable

Index

Constructors

constructor

new PlayerAudioInternal(config: PlayerAudioConfig): PlayerAudioInternal
Parameters
- config: PlayerAudioConfig
Returns PlayerAudioInternal
- Defined in src/player/player-audio.ts:254

Accessors

muted

get muted(): boolean
Whether audio is currently muted.

Returns boolean
Implementation of PlayerAudioInternalApi.muted
- Defined in src/player/player-audio.ts:832

onEvent$

get onEvent$(): Observable<PlayerAudioEvent>
Observable that emits audio events as they occur.

Returns Observable<PlayerAudioEvent>
Implementation of PlayerAudioInternalApi.onEvent$
- Defined in src/player/player-audio.ts:820

state

get state(): PlayerAudioState
Current audio state snapshot.

Returns PlayerAudioState
Implementation of PlayerAudioInternalApi.state
- Defined in src/player/player-audio.ts:741

volume

get volume(): number
Current volume level, in the range [0, 1].

Returns number
Implementation of PlayerAudioInternalApi.volume
- Defined in src/player/player-audio.ts:837

Methods

_removeAllSidecarTracks

_removeAllSidecarTracks(): Observable<void>
Returns Observable<void>
- Defined in src/player/player-audio.ts:734

destroy

destroy(): void
Returns void
Implementation of Destroyable.destroy
- Defined in src/player/player-audio.ts:862

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
Implementation of PlayerAudioInternalApi.getHandler
- Defined in src/player/player-audio.ts:507
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
Implementation of PlayerAudioInternalApi.getHandler
- Defined in src/player/player-audio.ts:508

getTracks

getTracks(): AudioState[]
Returns AudioState[]
Implementation of PlayerAudioInternalApi.getTracks
- Defined in src/player/player-audio.ts:491
getTracks(playerAudioType: MAIN): AudioState[]
Parameters
- playerAudioType: MAIN
Returns AudioState[]
Implementation of PlayerAudioInternalApi.getTracks
- Defined in src/player/player-audio.ts:492
getTracks(playerAudioType: SIDECAR): AudioState[]
Parameters
- playerAudioType: SIDECAR
Returns AudioState[]
Implementation of PlayerAudioInternalApi.getTracks
- Defined in src/player/player-audio.ts:493

loadSidecarTrack

loadSidecarTrack(
    trackState: AudioState,
    trackUpdater: (attrs: AudioUpdateableAttrs) => Observable<AudioState>,
    loadOptions?: PlayerAudioLoadOptions,
): Observable<AudioState>
Parameters
- trackState: AudioState
- trackUpdater: (attrs: AudioUpdateableAttrs) => Observable<AudioState>
- OptionalloadOptions: PlayerAudioLoadOptions
Returns Observable<AudioState>
Implementation of PlayerAudioInternalApi.loadSidecarTrack
- Defined in src/player/player-audio.ts:527

mute

mute(): Observable<void>
Mutes audio output.

Returns Observable<void>
Implementation of PlayerAudioInternalApi.mute
- Defined in src/player/player-audio.ts:842

removeAllSidecarTracks

removeAllSidecarTracks(): Observable<void>
Returns Observable<void>
Implementation of PlayerAudioInternalApi.removeAllSidecarTracks
- Defined in src/player/player-audio.ts:730

removeSidecarTrack

removeSidecarTrack(id: string): Observable<void>
Parameters
- id: string
Returns Observable<void>
Implementation of PlayerAudioInternalApi.removeSidecarTrack
- Defined in src/player/player-audio.ts:684

restoreState

restoreState(state: PlayerAudioState): Observable<void>
Parameters
- state: PlayerAudioState
Returns Observable<void>
- Defined in src/player/player-audio.ts:756

setMuted

setMuted(muted: boolean): Observable<void>
Mutes or unmutes audio output.
Parameters
- muted: boolean
  true to mute, false to unmute.
Returns Observable<void>
Implementation of PlayerAudioInternalApi.setMuted
- Defined in src/player/player-audio.ts:846

setup

setup(playerController: PlayerController, mainMediaState: MainMediaState): void
Parameters
- playerController: PlayerController
- mainMediaState: MainMediaState
Returns void
- Defined in src/player/player-audio.ts:333

setVolume

setVolume(volume: number): Observable<void>
Sets the volume level.
Parameters
- volume: number
  A value in the range [0, 1].
Returns Observable<void>
Implementation of PlayerAudioInternalApi.setVolume
- Defined in src/player/player-audio.ts:850

switchTrack

switchTrack(trackId: string, activate?: boolean): Observable<void>
Switches the active audio track.
Parameters
- trackId: string
  ID of the track to switch to.
- activate: boolean = true
  Whether to immediately activate the track. Defaults to true.
Returns Observable<void>
Implementation of PlayerAudioInternalApi.switchTrack
- Defined in src/player/player-audio.ts:421

teardown

teardown(): void
Returns void
- Defined in src/player/player-audio.ts:283

toggleMuted

toggleMuted(): Observable<void>
Toggles mute and unmute.

Returns Observable<void>
Implementation of PlayerAudioInternalApi.toggleMuted
- Defined in src/player/player-audio.ts:854

unmute

unmute(): Observable<void>
Unmutes audio output.

Returns Observable<void>
Implementation of PlayerAudioInternalApi.unmute
- Defined in src/player/player-audio.ts:858

updateTrack

updateTrack(trackState: AudioState): void
Parameters
- trackState: AudioState
Returns void
Implementation of PlayerAudioInternalApi.updateTrack
- Defined in src/player/player-audio.ts:485

Class PlayerAudioInternal

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PlayerAudioInternal

Accessors

muted

Returns boolean

onEvent$

Returns Observable<PlayerAudioEvent>

state

Returns PlayerAudioState

volume

Returns number

Methods

_removeAllSidecarTracks

Returns Observable<void>

destroy

Returns void

getHandler

Parameters

Returns AudioHandlerApi | undefined

Parameters

Returns AudioHandlerApi | undefined

getTracks

Returns AudioState[]

Parameters

Returns AudioState[]

Parameters

Returns AudioState[]

loadSidecarTrack

Parameters

Returns Observable<AudioState>

mute

Returns Observable<void>

removeAllSidecarTracks

Returns Observable<void>

removeSidecarTrack

Parameters

Returns Observable<void>

restoreState

Parameters

Returns Observable<void>

setMuted

Parameters

Returns Observable<void>

setup

Parameters

Returns void

setVolume

Parameters

Returns Observable<void>

switchTrack

Parameters

Returns Observable<void>

teardown

Returns void

toggleMuted

Returns Observable<void>

unmute

Returns Observable<void>

updateTrack

Parameters

Returns void

Settings

On This Page