Class SpatialAudio

Index

Constructors

Methods

disable dispose enable init initNpcSpeaker pause play resumeAudioContext sayUtteranceBySrc setAudioElementsMuted setVolumeAnalyses stop stopVolumeAnalyses update

Constructors

constructor

new SpatialAudio(): SpatialAudio
Returns SpatialAudio

Methods

disable

disable(): Promise<void>
关闭空间音频效果

Returns Promise<void>
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:51

dispose

dispose(): void
清除空间音频，换房时需要调用

Returns void
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:67

enable

enable(): Promise<string | void>
开启空间音频效果

Returns Promise<string | void>
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:33

init

init(data): Promise<void>
初始化空间音频
Parameters
- data: IInitAudioData
  IInitAudioData 初始化空间音频
Returns Promise<void>
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:14

initNpcSpeaker

initNpcSpeaker(uniqueId, spatialAudioConfTypeName, volumeChangeEventFunction?, audioElement?): Promise<unknown>
初始化Npc speaker
Parameters
- uniqueId: number
- spatialAudioConfTypeName: string
- Optional volumeChangeEventFunction: any
- Optional audioElement: HTMLAudioElement
Returns Promise<unknown>
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:128

pause

pause(idxs): void
暂停某个序号或序号列表中的音效
Parameters
- idxs: number | number[]
Returns void
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:91

play

play(idxs): void
播放某个序号或序号列表中的音效
Parameters
- idxs: number | number[]
Returns void
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:83

resumeAudioContext

resumeAudioContext(): void
重新唤起空间音频上下文

Returns void
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:109

sayUtteranceBySrc

sayUtteranceBySrc(uniqueId, utteranceSrc): 1 | 10102 | 10101
Parameters
- uniqueId: number
- utteranceSrc: string
Returns 1 | 10102 | 10101
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:142

setAudioElementsMuted

setAudioElementsMuted(mute): void
对所有使用空间音频的音源进行全局静音设置，全局静音/解除静音
Parameters
- mute: boolean
Returns void
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:117

setVolumeAnalyses

setVolumeAnalyses(uniqueId, volumeChangeEventFunction): 1 | 10201
Parameters
- uniqueId: number
- volumeChangeEventFunction: any
Returns 1 | 10201
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:150

stop

stop(idxs): void
停止某个序号或序号列表中的音效
Parameters
- idxs: number | number[]
Returns void
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:75

stopVolumeAnalyses

stopVolumeAnalyses(uniqueId): 1 | 10201
Parameters
- uniqueId: number
Returns 1 | 10201
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:146

update

update(avatarPos): void
刷新空间音频
Parameters
- avatarPos: IPoint
  用户当前位置
Returns void
- Defined in packages/core/src/gameplay/spatial-audio/spatial-audio.ts:99

Generated using TypeDoc