AudioHost

Audio host for interaction component

Hierarchy

• WithLogger
  • AudioHost

Index

Constructors

• constructor

Properties

• logger

Accessors

• destroyed

Methods

• addAudio
• addSrtSubtitleToAudio
• addSubtitleToAudio
• destroy
• destroyAudio
• fade
• hasAudio
• pause
• play
• seek
• setManagedStateEnabled
• setVolume
• stop
• updateLoop
• updateManagedState
• updateVolume

Constructors

constructor

• new AudioHost(station: AudioStation, instanceId: string, managedCoreStateManager: ManagedCoreStateManager): AudioHost

• Overrides WithLogger.constructor

  Parameters

  • station: AudioStation

  • instanceId: string

  • managedCoreStateManager: ManagedCoreStateManager

  Returns AudioHost

Properties

logger

logger: Logger = defaultLogger

Inherited from WithLogger.logger

Accessors

destroyed

• get destroyed(): boolean

• Returns boolean

Methods

addAudio

• addAudio(id: string, audioClipResponsePromise: Promise<AudioElementInit>): Promise<void>

• Add audio definition to the host, and trigger the loading process of this element.

  ---

  Parameters

  • id: string

    The id of the request.

  • audioClipResponsePromise: Promise<AudioElementInit>

    The detailed spec of the request.

  Returns Promise<void>

addSrtSubtitleToAudio

• addSrtSubtitleToAudio(subtitles: { id: string; srt: string }[]): void

• Add SRT subtitle to audio.

  ---

  Parameters

  • subtitles: { id: string; srt: string }[]

    Parsed SRT subtitle.

  Returns void

addSubtitleToAudio

• addSubtitleToAudio(subtitles: AdditionalSubtitleDefine[]): void

• Add manually written subtitle.

  ---

  Parameters

  • subtitles: AdditionalSubtitleDefine[]

    Subtitle configurations.

  Returns void

destroy

• destroy(): void

• Release all loadable audio element and managed core state.

  ---

  Returns void

destroyAudio

• destroyAudio(id: string): void

• Release the memory resource of the single audio element.

  ---

  Parameters

  • id: string

    The id of the element loading request

  Returns void

fade

• fade(id: string, startVolume: number, endVolume: number, duration: number): void

• Parameters

  • id: string

  • startVolume: number

  • endVolume: number

  • duration: number

  Returns void

hasAudio

• hasAudio(id: string): boolean

• Parameters

  • id: string

  Returns boolean

pause

• pause(id: string): void

• Parameters

  • id: string

  Returns void

play

• play(id: string, resetProgress?: boolean): void

• Parameters

  • id: string

  • optionalresetProgress: boolean

  Returns void

seek

• seek(id: string, time?: number): number

• Parameters

  • id: string

  • optionaltime: number

  Returns number

setManagedStateEnabled

• setManagedStateEnabled(enabled: boolean): void

• Parameters

  • enabled: boolean

  Returns void

setVolume

• setVolume(volume: number): void

• Parameters

  • volume: number

  Returns void

stop

• stop(id: string): void

• Parameters

  • id: string

  Returns void

updateLoop

• updateLoop(id: string, loop?: boolean): boolean

• Parameters

  • id: string

  • optionalloop: boolean

  Returns boolean

updateManagedState

• updateManagedState(): boolean

• Seek all the managed state based on the time of each source.

  ---

  Returns boolean

  If the state list is dirty

updateVolume

• updateVolume(id: string, volume?: number): number

• Parameters

  • id: string

  • optionalvolume: number

  Returns number