AudioSourceNode | 小游戏框架

音频源节点类。可用于播放audioclip资源。

Hierarchy

AudioBaseNode
- AudioSourceNode

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new AudioSourceNode(creator?: any, clip?: AudioClip): AudioSourceNode

Overrides AudioBaseNode.constructor
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:346
构造函数

memberof

AudioSourceNode

Parameters
- Optional creator: any
  
  节点创造者。可为空
- Optional clip: AudioClip
  
  audioclip资源
Returns AudioSourceNode

Accessors

canplay

get canplay(): boolean

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:287
资源是否就绪，可以播放。

memberof

AudioSourceNode

Returns boolean

clip

get clip(): AudioClip
set clip(val: AudioClip): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:123
要播放的音频剪辑audioclip资源。

memberof

AudioSourceNode

Returns AudioClip
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:126
要播放的音频剪辑audioclip资源。

Parameters
- val: AudioClip
Returns void

creator

get creator(): any
set creator(val: any): void

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:135
节点的创造者。即节点被谁创造

memberof

AudioBaseNode

Returns any
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:138
节点的创造者。即节点被谁创造

Parameters
- val: any
Returns void

currentTime

get currentTime(): number

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:325
当前音频的播放时间。

memberof

AudioSourceNode

Returns number

duration

get duration(): number

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:270
音频时长。

memberof

AudioSourceNode

Returns number

id

get id(): string
set id(val: string): void

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:52
节点id

memberof

AudioBaseNode

Returns string
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:55
节点id

Parameters
- val: string
Returns void

input

get input(): AudioNode

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:71
节点主路路由输入接口

memberof

AudioBaseNode

Returns AudioNode

inputList

get inputList(): AudioBaseNode[]

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:103
节点主路路由输入信号的发送者节点列表

memberof

AudioBaseNode

Returns AudioBaseNode[]

isDestroyed

get isDestroyed(): boolean

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:146
节点是否已销毁

memberof

AudioBaseNode

Returns boolean

loop

get loop(): boolean
set loop(val: boolean): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:164
是否循环播放。

memberof

AudioSourceNode

Returns boolean
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:167
是否循环播放。

Parameters
- val: boolean
Returns void

mute

get mute(): boolean
set mute(val: boolean): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:144
是否静音。

memberof

AudioSourceNode

Returns boolean
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:147
是否静音。

Parameters
- val: boolean
Returns void

name

get name(): string

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:63
节点名称

memberof

AudioBaseNode

Returns string

numberOfSideChain

get numberOfSideChain(): number

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:127
节点的侧链接口数量

memberof

AudioBaseNode

Returns number

output

get output(): AudioNode

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:79
节点主路路由输出接口

memberof

AudioBaseNode

Returns AudioNode

outputList

get outputList(): AudioBaseNode[]

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:95
节点主路路由输出信号的接收者节点列表

memberof

AudioBaseNode

Returns AudioBaseNode[]

outputSideChain

get outputSideChain(): AudioNode

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:87
节点侧链路由输出接口

memberof

AudioBaseNode

Returns AudioNode

outputSideChainList

get outputSideChainList(): Map<AudioNode | AudioParam, ISideChainInterfaceInfo>

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:119
节点侧链输出信号的接收者节点列表。列表描述了信号被哪些节点的哪个侧链接口所接收。

memberof

AudioBaseNode

Returns Map<AudioNode | AudioParam, ISideChainInterfaceInfo>

paused

get paused(): boolean

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:278
是否暂停中

memberof

AudioSourceNode

Returns boolean

pitch

get pitch(): number
set pitch(val: number): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:229
声音播放速率。
值1：表示正常播放速度。慢速或快速播放会引起音高的变化。

memberof

AudioSourceNode

Returns number
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:232
声音播放速率。
值1：表示正常播放速度。慢速或快速播放会引起音高的变化。

Parameters
- val: number
Returns void

playing

get playing(): boolean

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:296
是否播放中。

memberof

AudioSourceNode

Returns boolean

sideChainInputList

get sideChainInputList(): AudioBaseNode[][]

- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:111
节点侧链输入信号的发送者列表

memberof

AudioBaseNode

Returns AudioBaseNode[][]

volume

get volume(): number
set volume(val: number): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:207
声音的原始音量。
值1：表示音量不变；值0：表示静音。

memberof

AudioSourceNode

Returns number
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:210
声音的原始音量。
值1：表示音量不变；值0：表示静音。

Parameters
- val: number
Returns void

Methods

addEventListener

addEventListener(type: ended, callback: (e: { target: AudioSourceNode; type: ended }) => void): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:771
监听指定事件，在事件触发时执行指定回调。

memberof

AudioSourceNode

Parameters
- type: ended
  
  事件类型
- callback: (e: { target: AudioSourceNode; type: ended }) => void
  
  回调函数
  - - (e: { target: AudioSourceNode; type: ended }): void
    - 回调函数
      
      Parameters
      - e: { target: AudioSourceNode; type: ended }
        
        回调函数第一个参数
        
        target: AudioSourceNode
        
        事件触发者
        
        type: ended
        
        事件类型
      Returns void
Returns void

connect

connect(destination: AudioBaseNode): void

Inherited from AudioBaseNode.connect
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:453
与指定节点创建主路路由链接。即将主路路由信号输出指定节点

memberof

AudioBaseNode

Parameters
- destination: AudioBaseNode
  
  需要链接的节点
Returns void

connectSideChain

connectSideChain(destination: AudioBaseNode, index: number): void

Inherited from AudioBaseNode.connectSideChain
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:477
与指定节点的指定侧链接口创建链接。即将信号输出到指定节点的指定侧链接口。

memberof

AudioBaseNode

Parameters
- destination: AudioBaseNode
  
  需要链接的节点
- index: number
  
  侧链索引
Returns void

connectSideChainSource

connectSideChainSource(source: AudioBaseNode, index: number): void

Inherited from AudioBaseNode.connectSideChainSource
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:513
以本节点指定侧链接口，接收指定节点的信号

memberof

AudioBaseNode

Parameters
- source: AudioBaseNode
  
  信号源节点
- index: number
Returns void

connectSource

connectSource(source: AudioBaseNode): void

Inherited from AudioBaseNode.connectSource
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:503
接收指定节点的主路路由信号

memberof

AudioBaseNode

Parameters
- source: AudioBaseNode
  
  信号源节点
Returns void

destroy

destroy(): void

Overrides AudioBaseNode.destroy
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:1022
销毁节点。

memberof

AudioSourceNode

Returns void

disconnect

disconnect(destination?: AudioBaseNode): void

Inherited from AudioBaseNode.disconnect
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:286
断开与指定节点在主路路由上的输出链接。则主路路由信号不会再输出到该节点。

memberof

AudioBaseNode

Parameters
- Optional destination: AudioBaseNode
  
  需要断开链接的节点。为空则表示断开主路路由所有输出链接。
Returns void

disconnectSideChain

disconnectSideChain(): void
disconnectSideChain(sideChain: AudioNode | AudioParam): void
disconnectSideChain(baseNode: AudioBaseNode): void
disconnectSideChain(baseNode: AudioBaseNode, sideChainIndex: number): void

Inherited from AudioBaseNode.disconnectSideChain
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:322
断开侧链所有输出链接

memberof

AudioBaseNode

Returns void
Inherited from AudioBaseNode.disconnectSideChain
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:328
断开与指定侧链接口的输出链接

memberof

AudioBaseNode

Parameters
- sideChain: AudioNode | AudioParam
  
  需要断开的侧链接口。可以为被封装过的WebAudio AudioParam对象，或被封装过的WebAudio AudioNode对象
Returns void
Inherited from AudioBaseNode.disconnectSideChain
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:334
断开与指定节点的所有侧链接口的输出链接

memberof

AudioBaseNode

Parameters
- baseNode: AudioBaseNode
  
  需要断开所有侧链接口输出链接的节点
Returns void
Inherited from AudioBaseNode.disconnectSideChain
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:341
断开与指定节点的指定侧链接口的输出链接

memberof

AudioBaseNode

Parameters
- baseNode: AudioBaseNode
  
  需要断开侧链接口输出链接的节点
- sideChainIndex: number
  
  侧链接口索引
Returns void

disconnectSideChainSource

disconnectSideChainSource(): void
disconnectSideChainSource(index: number): void
disconnectSideChainSource(source: AudioBaseNode, index: number): any

Inherited from AudioBaseNode.disconnectSideChainSource
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:412
断开所有侧链接口的所有输入链接

memberof

AudioBaseNode

Returns void
Inherited from AudioBaseNode.disconnectSideChainSource
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:418
断开指定侧链接口的所有输入链接

memberof

AudioBaseNode

Parameters
- index: number
  
  侧链接口索引
Returns void
Inherited from AudioBaseNode.disconnectSideChainSource
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:425
断开指定侧链接口与指定节点的链接

memberof

AudioBaseNode

Parameters
- source: AudioBaseNode
  
  输入信号节点
- index: number
  
  侧链接口索引
Returns any

disconnectSource

disconnectSource(source?: AudioBaseNode): void

Inherited from AudioBaseNode.disconnectSource
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:395
断开与指定节点的主路路由输入链接。

memberof

AudioBaseNode

Parameters
- Optional source: AudioBaseNode
  
  需要断开链接的节点。为空则表示断开主路路由所有输入链接
Returns void

getParameterIdByName

getParameterIdByName(name: string): string

Inherited from AudioBaseNode.getParameterIdByName
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:257
根据参数名，获取可被快照捕获的参数（即该参数可应用Transition）对应的id

memberof

AudioBaseNode

Parameters
- name: string
Returns string

getSideChain

getSideChain(index: number): AudioNode | AudioParam

Inherited from AudioBaseNode.getSideChain
- Defined in src/engine/game/3D/audio/AudioBaseNode.ts:266
根据索引获取侧链接口

memberof

AudioBaseNode

Parameters
- index: number
  
  侧链接口索引
Returns AudioNode | AudioParam

pause

pause(): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:909
暂停播放

memberof

AudioSourceNode

Returns void

play

play(time?: number): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:826
从音频的指定时间开始播放或者从暂停状态恢复播放

memberof

AudioSourceNode

Parameters
- time: number = 0
  
  音频开始播放的时间，单位秒。缺省值为0。小于等于0：表示；从暂停状态恢复播放或者重新播放
Returns void

playScheduled

playScheduled(startCtxTime: number, startTime: number): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:865
计划播放。
在音频系统时间坐标系上指定时间点，从音频的指定时间开始播放。
播放状态下不能调用playScheduled。

memberof

AudioSourceNode

Parameters
- startCtxTime: number
  
  音频系统时间坐标系上的时间点，单位秒。0或者小于音频系统当前时间，表示立刻播放。
- startTime: number
  
  以音频文件时间为参考的时间，单位秒。
Returns void

removeEventListener

removeEventListener(type: ended): any
removeEventListener(type: ended, callback: (e: { target: AudioSourceNode; type: ended }) => void): any

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:793
移除指定事件的所有监听。

memberof

AudioSourceNode

Parameters
- type: ended
  
  事件类型
Returns any
- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:800
移除指定事件的指定监听。

memberof

AudioSourceNode

Parameters
- type: ended
  
  事件类型。
- callback: (e: { target: AudioSourceNode; type: ended }) => void
  
  调用addEventListener时传入的回调函数。
  - - (e: { target: AudioSourceNode; type: ended }): void
    - Parameters
      - e: { target: AudioSourceNode; type: ended }
        
        target: AudioSourceNode
        
        type: ended
      Returns void
Returns any

seek

seek(time: number): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:930
从音频的指定时间点播放。
只有暂停状态或者调用过play和playScheduled方法后才能调用seek，否则出错。

memberof

AudioSourceNode

Parameters
- time: number
  
  以音频文件时间为参考的时间，单位秒。
Returns void

stop

stop(): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:961
停止播放

memberof

AudioSourceNode

Returns void

stopScheduled

stopScheduled(startCtxTime: number): void

- Defined in src/engine/game/3D/audio/AudioSourceNode.ts:975
计划停止播放。
在音频系统时间坐标系上指定时间点，停止播放

memberof

AudioSourceNode

Parameters
- startCtxTime: number
  
  音频系统时间坐标系上的时间点，单位秒。0或者小于音频系统当前时间，表示立刻停止。
Returns void

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional creator: any

Optional clip: AudioClip

Returns AudioSourceNode

Accessors

canplay

Returns boolean

clip

Returns AudioClip

Parameters

val: AudioClip

Returns void

creator

Returns any

Parameters

val: any

Returns void

currentTime

Returns number

duration

Returns number

id

Returns string

Parameters

val: string

Returns void

input

Returns AudioNode

inputList

Returns AudioBaseNode[]

isDestroyed

Returns boolean

loop

Returns boolean

Parameters

val: boolean

Returns void

mute

Returns boolean

Parameters

val: boolean

Returns void

name

Returns string

numberOfSideChain

Returns number

output

Returns AudioNode

outputList

Returns AudioBaseNode[]

outputSideChain

Returns AudioNode

outputSideChainList

Returns Map<AudioNode | AudioParam, ISideChainInterfaceInfo>

paused

Returns boolean

pitch

Returns number

Parameters

val: number

Returns void

playing

Returns boolean

sideChainInputList

Returns AudioBaseNode[][]

volume

Returns number

Parameters

val: number

Returns void

Methods

addEventListener

Parameters