Sound

播放内存中的短音效，持有 SoundBuffer 以保留样本存储。

继承关系

层级 (查看层级一览)

SoundSource
- Sound

源码与继承

成员目录53

构造函数

constructor

属性

[audioHandle]
times
values
Conestatic
Statusstatic

构造函数

constructor

new Sound(
    bufferOrSource:
        | Readonly<
            Pick<
                SoundBuffer,
                | typeof audioHandle
                | "getSamples"
                | "getSampleCount"
                | "getSampleRate"
                | "getChannelCount"
                | "getChannelMap"
                | "getDuration"
                | "saveToFile",
            >,
        >
        | Sound,
): Sound
绑定音频缓冲区，或复制 Sound 的属性和缓冲区引用。

参数
bufferOrSource

    | Readonly<
        Pick<
            SoundBuffer,
            | typeof audioHandle
            | "getSamples"
            | "getSampleCount"
            | "getSampleRate"
            | "getChannelCount"
            | "getChannelMap"
            | "getDuration"
            | "saveToFile",
        >,
    >
    | Sound
返回值
Sound
源码与继承
重写了 SoundSource.constructor
- 定义于 src/audio/sound.ts:22

属性

`受保护` `只读`times

times: BigInt64Array

源码与继承

`受保护` `只读`values

values: Float32Array

源码与继承

`静态` `只读`Cone

Cone: typeof Cone = Cone

方向锥配置类型。

源码与继承

`静态` `只读`Status

Status: typeof SoundStatus = SoundStatus

播放状态枚举。

源码与继承

方法

assign

assign(source: Sound): this
复制属性和缓冲区绑定；停止当前 Sound 并将播放位置归零。

参数
source
Sound
返回值
this
源码与继承
重写了 SoundSource.assign
- 定义于 src/audio/sound.ts:38

`受保护`command

command(command: number): void
参数
command
number
返回值
void
源码与继承
继承自 SoundSource.command
- 定义于 src/audio/sound-source.ts:370

`受保护`field

field(field: number, write: boolean): void
参数
field
number
write
boolean
返回值
void
源码与继承
继承自 SoundSource.field
- 定义于 src/audio/sound-source.ts:373

`受保护`get

get(field: number): number
参数
field
number
返回值
number
源码与继承
继承自 SoundSource.get
- 定义于 src/audio/sound-source.ts:376

getAttenuation

getAttenuation(): number
返回距离衰减因子。

返回值
number
源码与继承
继承自 SoundSource.getAttenuation
- 定义于 src/audio/sound-source.ts:294

getBuffer

getBuffer(): Readonly
返回当前绑定缓冲区的只读引用。

返回值
Readonly
源码与继承
- 定义于 src/audio/sound.ts:62

getCone

getCone(): Cone
返回方向锥参数副本。

返回值
Cone
源码与继承
继承自 SoundSource.getCone
- 定义于 src/audio/sound-source.ts:163

getDirection

getDirection(): Vector3f
返回发声方向副本。

返回值
Vector3f
源码与继承
继承自 SoundSource.getDirection
- 定义于 src/audio/sound-source.ts:141

getDirectionalAttenuationFactor

getDirectionalAttenuationFactor(): number
返回方向衰减因子。

返回值
number
源码与继承
继承自 SoundSource.getDirectionalAttenuationFactor
- 定义于 src/audio/sound-source.ts:209

getDopplerFactor

getDopplerFactor(): number
返回多普勒效应倍率。

返回值
number
源码与继承
继承自 SoundSource.getDopplerFactor
- 定义于 src/audio/sound-source.ts:195

getMaxDistance

getMaxDistance(): number
返回最大距离。

返回值
number
源码与继承
继承自 SoundSource.getMaxDistance
- 定义于 src/audio/sound-source.ts:252

getMaxGain

getMaxGain(): number
返回最大增益。

返回值
number
源码与继承
继承自 SoundSource.getMaxGain
- 定义于 src/audio/sound-source.ts:280

getMinDistance

getMinDistance(): number
返回最小参考距离。

返回值
number
源码与继承
继承自 SoundSource.getMinDistance
- 定义于 src/audio/sound-source.ts:238

getMinGain

getMinGain(): number
返回最小增益。

返回值
number
源码与继承
继承自 SoundSource.getMinGain
- 定义于 src/audio/sound-source.ts:266

getPan

getPan(): number
返回立体声声像。

返回值
number
源码与继承
继承自 SoundSource.getPan
- 定义于 src/audio/sound-source.ts:85

getPitch

getPitch(): number
返回音高倍率。

返回值
number
源码与继承
继承自 SoundSource.getPitch
- 定义于 src/audio/sound-source.ts:71

getPlayingOffset

getPlayingOffset(): Time
返回当前播放位置的时间副本。

返回值
Time
源码与继承
继承自 SoundSource.getPlayingOffset
- 定义于 src/audio/sound-source.ts:366

getPosition

getPosition(): Vector3f
返回三维位置副本。

返回值
Vector3f
源码与继承
继承自 SoundSource.getPosition
- 定义于 src/audio/sound-source.ts:127

getStatus

getStatus(): SoundStatus
查询原生引擎的当前播放状态。

返回值
SoundStatus
源码与继承
继承自 SoundSource.getStatus
- 定义于 src/audio/sound-source.ts:315

getVelocity

getVelocity(): Vector3f
返回速度副本。

返回值
Vector3f
源码与继承
继承自 SoundSource.getVelocity
- 定义于 src/audio/sound-source.ts:181

getVolume

getVolume(): number
返回音量百分比。

返回值
number
源码与继承
继承自 SoundSource.getVolume
- 定义于 src/audio/sound-source.ts:99

isLooping

isLooping(): boolean
返回是否循环播放。

返回值
boolean
源码与继承
继承自 SoundSource.isLooping
- 定义于 src/audio/sound-source.ts:308

isRelativeToListener

isRelativeToListener(): boolean
返回是否使用监听者相对坐标。

返回值
boolean
源码与继承
继承自 SoundSource.isRelativeToListener
- 定义于 src/audio/sound-source.ts:224

isSpatializationEnabled

isSpatializationEnabled(): boolean
返回是否启用空间音效。

返回值
boolean
源码与继承
继承自 SoundSource.isSpatializationEnabled
- 定义于 src/audio/sound-source.ts:113

pause

pause(): void
暂停并保留播放位置。

返回值
void
源码与继承
继承自 SoundSource.pause
- 定义于 src/audio/sound-source.ts:342

play

play(): void
开始播放或恢复暂停；已播放时按 SFML 语义重新开始。

返回值
void
源码与继承
继承自 SoundSource.play
- 定义于 src/audio/sound-source.ts:335

setAttenuation

setAttenuation(value: number): void
设置距离衰减因子，0 禁用距离衰减。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setAttenuation
- 定义于 src/audio/sound-source.ts:287

setBuffer

setBuffer(buffer: Readonly): void
替换并保留音频缓冲区引用，同时更新原生播放源。

参数
buffer
Readonly
返回值
void
源码与继承
- 定义于 src/audio/sound.ts:51

setCone

setCone(value: Readonly<ConeInput>): void
设置内外方向锥角度及外部增益，并更新原生音频引擎。

参数
value
Readonly<ConeInput>
返回值
void
源码与继承
继承自 SoundSource.setCone
- 定义于 src/audio/sound-source.ts:150

setDirection

setDirection(value: ReadonlyValue<Vector3f>): void
设置声源发声方向。

参数
value
ReadonlyValue<Vector3f>
返回值
void
源码与继承
继承自 SoundSource.setDirection
- 定义于 src/audio/sound-source.ts:134

setDirectionalAttenuationFactor

setDirectionalAttenuationFactor(value: number): void
设置声源方向对衰减的影响因子。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setDirectionalAttenuationFactor
- 定义于 src/audio/sound-source.ts:202

setDopplerFactor

setDopplerFactor(value: number): void
设置多普勒效应倍率，0 禁用。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setDopplerFactor
- 定义于 src/audio/sound-source.ts:188

setEffectProcessor

setEffectProcessor(processor?: EffectProcessor): void
绑定并保留效果处理器引用；undefined 移除处理器。

参数
processor可选
EffectProcessor
返回值
void
源码与继承
继承自 SoundSource.setEffectProcessor
- 定义于 src/audio/sound-source.ts:322

setLooping

setLooping(value: boolean): void
设置到达末尾后是否循环播放。

参数
value
boolean
返回值
void
源码与继承
继承自 SoundSource.setLooping
- 定义于 src/audio/sound-source.ts:301

setMaxDistance

setMaxDistance(value: number): void
设置距离衰减使用的最大距离。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setMaxDistance
- 定义于 src/audio/sound-source.ts:245

setMaxGain

setMaxGain(value: number): void
设置距离衰减后的最大增益。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setMaxGain
- 定义于 src/audio/sound-source.ts:273

setMinDistance

setMinDistance(value: number): void
设置保持最大音量的最小参考距离。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setMinDistance
- 定义于 src/audio/sound-source.ts:231

setMinGain

setMinGain(value: number): void
设置距离衰减后的最小增益。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setMinGain
- 定义于 src/audio/sound-source.ts:259

setPan

setPan(value: number): void
设置立体声声像，-1 为左、0 为中、1 为右。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setPan
- 定义于 src/audio/sound-source.ts:78

setPitch

setPitch(value: number): void
设置音高及播放速率倍率，1 为原速。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setPitch
- 定义于 src/audio/sound-source.ts:64

setPlayingOffset

setPlayingOffset(value: ReadonlyValue<Time>): void
设置相对于声音起点的播放时间。

参数
value
ReadonlyValue<Time>
返回值
void
源码与继承
继承自 SoundSource.setPlayingOffset
- 定义于 src/audio/sound-source.ts:356

setPosition

setPosition(value: ReadonlyValue<Vector3f>): void
设置三维位置，单位须与监听者位置及距离参数一致。

参数
value
ReadonlyValue<Vector3f>
返回值
void
源码与继承
继承自 SoundSource.setPosition
- 定义于 src/audio/sound-source.ts:120

setRelativeToListener

setRelativeToListener(value: boolean): void
设置位置是否相对于监听者；false 使用世界坐标。

参数
value
boolean
返回值
void
源码与继承
继承自 SoundSource.setRelativeToListener
- 定义于 src/audio/sound-source.ts:217

setSpatializationEnabled

setSpatializationEnabled(value: boolean): void
设置是否启用位置、距离和方向引起的空间音效。

参数
value
boolean
返回值
void
源码与继承
继承自 SoundSource.setSpatializationEnabled
- 定义于 src/audio/sound-source.ts:106

setVelocity

setVelocity(value: ReadonlyValue<Vector3f>): void
设置三维速度，用于多普勒效应，单位为位置单位/秒。

参数
value
ReadonlyValue<Vector3f>
返回值
void
源码与继承
继承自 SoundSource.setVelocity
- 定义于 src/audio/sound-source.ts:174

setVolume

setVolume(value: number): void
设置音量百分比，0 为静音，100 为原始音量。

参数
value
number
返回值
void
源码与继承
继承自 SoundSource.setVolume
- 定义于 src/audio/sound-source.ts:92

stop

stop(): void
停止并将播放位置归零。

返回值
void
源码与继承
继承自 SoundSource.stop
- 定义于 src/audio/sound-source.ts:349

符号成员

`只读`[audioHandle]

"[audioHandle]": AudioHandle<"source">

源码与继承

Sound

层级 (查看层级一览)

构造函数

属性

方法

构造函数

constructor

参数

返回值

属性

受保护 只读times

受保护 只读values

静态 只读Cone

静态 只读Status

方法

assign

参数

返回值

受保护command

参数

返回值

受保护field

参数

返回值

受保护get

参数

返回值

getAttenuation

返回值

getBuffer

返回值

getCone

返回值

getDirection

返回值

getDirectionalAttenuationFactor

返回值

getDopplerFactor

返回值

getMaxDistance

返回值

getMaxGain

返回值

getMinDistance

返回值

getMinGain

返回值

getPan

返回值

getPitch

返回值

getPlayingOffset

返回值

getPosition

返回值

getStatus

返回值

getVelocity

返回值

getVolume

返回值

isLooping

返回值

isRelativeToListener

返回值

isSpatializationEnabled

返回值

pause

返回值

play

返回值

setAttenuation

参数

返回值

setBuffer

参数

返回值

setCone

参数

返回值

`受保护` `只读`times

`受保护` `只读`values

`静态` `只读`Cone

`静态` `只读`Status

`受保护`command

`受保护`field

`受保护`get

`只读`[audioHandle]