Class PlayerAudio

Implements

PlayerAudioApi
Destroyable

Index

Constructors

Accessors

audioContext audioEffects muted onEvent$ state volume

Methods

destroy getHandler getTracks mute setMuted setVolume switchTrack toggleMuted unmute wirePlayer

Constructors

constructor

new PlayerAudio(
ompProvider: OmpProvider,
player: PlayerInternalApi,
): PlayerAudio
Parameters
- ompProvider: OmpProvider
- player: PlayerInternalApi
Returns PlayerAudio
- Defined in src/player/player-audio.ts:94

Accessors

audioContext

get audioContext(): AudioContext
Returns AudioContext
Implementation of PlayerAudioApi.audioContext
- Defined in src/player/player-audio.ts:134

audioEffects

get audioEffects(): AudioEffectsRegistry
Audio effects registry — use to register custom audio effect implementations.

Returns AudioEffectsRegistry
Implementation of PlayerAudioApi.audioEffects
- Defined in src/player/player-audio.ts:101

muted

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

Returns boolean
Implementation of PlayerAudioApi.muted
- Defined in src/player/player-audio.ts:195

onEvent$

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

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

state

get state(): PlayerAudioState
Current audio state snapshot.

Returns PlayerAudioState
Implementation of PlayerAudioApi.state
- Defined in src/player/player-audio.ts:142

volume

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

Returns number
Implementation of PlayerAudioApi.volume
- Defined in src/player/player-audio.ts:199

Methods

destroy

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

getHandler

getHandler(
playerAudioType: PlayerAudioType,
id?: string,
): AudioHandlerApi | undefined
Returns the audio handler for the given OUTPUT or MAIN audio type.
Parameters
- playerAudioType: PlayerAudioType
  The audio type (OUTPUT or MAIN).
- Optionalid: string
Returns AudioHandlerApi | undefined
Implementation of PlayerAudioApi.getHandler
- Defined in src/player/player-audio.ts:146

getTracks

getTracks(): Audio[]
Returns tracks loaded by player

Returns Audio[]
Implementation of PlayerAudioApi.getTracks
- Defined in src/player/player-audio.ts:157

mute

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

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

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 PlayerAudioApi.setMuted
- Defined in src/player/player-audio.ts:207

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 PlayerAudioApi.setVolume
- Defined in src/player/player-audio.ts:211

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>
Implementation of PlayerAudioApi.switchTrack
- Defined in src/player/player-audio.ts:174

toggleMuted

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

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

unmute

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

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

wirePlayer

wirePlayer(player: PlayerInternalApi): void
Parameters
- player: PlayerInternalApi
Returns void
- Defined in src/player/player-audio.ts:105