SoundSource

静态 只读Cone

静态 只读Status

assign

• assign(source: SoundSource): this

  复制声源属性，保留当前声源的内容和播放状态。

  参数

  source

  SoundSource

  返回值

  this

  源码与继承

getAttenuation

• getAttenuation(): number

  返回距离衰减因子。

  返回值

  number

  源码与继承

getCone

• getCone(): Cone

  返回方向锥参数副本。

  返回值

  Cone

  源码与继承

getDirection

• getDirection(): Vector3f

  返回发声方向副本。

  返回值

  Vector3f

  源码与继承

getDirectionalAttenuationFactor

• getDirectionalAttenuationFactor(): number

  返回方向衰减因子。

  返回值

  number

  源码与继承

getDopplerFactor

• getDopplerFactor(): number

  返回多普勒效应倍率。

  返回值

  number

  源码与继承

getMaxDistance

• getMaxDistance(): number

  返回最大距离。

  返回值

  number

  源码与继承

getMaxGain

• getMaxGain(): number

  返回最大增益。

  返回值

  number

  源码与继承

getMinDistance

• getMinDistance(): number

  返回最小参考距离。

  返回值

  number

  源码与继承

getMinGain

• getMinGain(): number

  返回最小增益。

  返回值

  number

  源码与继承

getPan

• getPan(): number

  返回立体声声像。

  返回值

  number

  源码与继承

getPitch

• getPitch(): number

  返回音高倍率。

  返回值

  number

  源码与继承

getPlayingOffset

• getPlayingOffset(): Time

  返回当前播放位置的时间副本。

  返回值

  Time

  源码与继承

getPosition

• getPosition(): Vector3f

  返回三维位置副本。

  返回值

  Vector3f

  源码与继承

getStatus

• getStatus(): SoundStatus

  查询原生引擎的当前播放状态。

  返回值

  SoundStatus

  源码与继承

getVelocity

• getVelocity(): Vector3f

  返回速度副本。

  返回值

  Vector3f

  源码与继承

getVolume

• getVolume(): number

  返回音量百分比。

  返回值

  number

  源码与继承

isLooping

• isLooping(): boolean

  返回是否循环播放。

  返回值

  boolean

  源码与继承

isRelativeToListener

• isRelativeToListener(): boolean

  返回是否使用监听者相对坐标。

  返回值

  boolean

  源码与继承

isSpatializationEnabled

• isSpatializationEnabled(): boolean

  返回是否启用空间音效。

  返回值

  boolean

  源码与继承

pause

• pause(): void

  暂停并保留播放位置。

  返回值

  void

  源码与继承

play

• play(): void

  开始播放或恢复暂停；已播放时按 SFML 语义重新开始。

  返回值

  void

  源码与继承

setAttenuation

• setAttenuation(value: number): void

  设置距离衰减因子，0 禁用距离衰减。

  参数

  value

  number

  返回值

  void

  源码与继承

setCone

• setCone(value: Readonly<ConeInput>): void

  设置内外方向锥角度及外部增益，并更新原生音频引擎。

  参数

  value

  Readonly<ConeInput>

  返回值

  void

  源码与继承

setDirection

• setDirection(value: ReadonlyValue<Vector3f>): void

  设置声源发声方向。

  参数

  value

  ReadonlyValue<Vector3f>

  返回值

  void

  源码与继承

setDirectionalAttenuationFactor

• setDirectionalAttenuationFactor(value: number): void

  设置声源方向对衰减的影响因子。

  参数

  value

  number

  返回值

  void

  源码与继承

setDopplerFactor

• setDopplerFactor(value: number): void

  设置多普勒效应倍率，0 禁用。

  参数

  value

  number

  返回值

  void

  源码与继承

setEffectProcessor

• setEffectProcessor(processor?: EffectProcessor): void

  绑定并保留效果处理器引用；undefined 移除处理器。

  参数

  processor可选

  EffectProcessor

  返回值

  void

  源码与继承

setLooping

• setLooping(value: boolean): void

  设置到达末尾后是否循环播放。

  参数

  value

  boolean

  返回值

  void

  源码与继承

setMaxDistance

• setMaxDistance(value: number): void

  设置距离衰减使用的最大距离。

  参数

  value

  number

  返回值

  void

  源码与继承

setMaxGain

• setMaxGain(value: number): void

  设置距离衰减后的最大增益。

  参数

  value

  number

  返回值

  void

  源码与继承

setMinDistance

• setMinDistance(value: number): void

  设置保持最大音量的最小参考距离。

  参数

  value

  number

  返回值

  void

  源码与继承

setMinGain

• setMinGain(value: number): void

  设置距离衰减后的最小增益。

  参数

  value

  number

  返回值

  void

  源码与继承

setPan

• setPan(value: number): void

  设置立体声声像，-1 为左、0 为中、1 为右。

  参数

  value

  number

  返回值

  void

  源码与继承

setPitch

• setPitch(value: number): void

  设置音高及播放速率倍率，1 为原速。

  参数

  value

  number

  返回值

  void

  源码与继承

setPlayingOffset

• setPlayingOffset(value: ReadonlyValue<Time>): void

  设置相对于声音起点的播放时间。

  参数

  value

  ReadonlyValue<Time>

  返回值

  void

  源码与继承

setPosition

• setPosition(value: ReadonlyValue<Vector3f>): void

  设置三维位置，单位须与监听者位置及距离参数一致。

  参数

  value

  ReadonlyValue<Vector3f>

  返回值

  void

  源码与继承

setRelativeToListener

• setRelativeToListener(value: boolean): void

  设置位置是否相对于监听者；false 使用世界坐标。

  参数

  value

  boolean

  返回值

  void

  源码与继承

setSpatializationEnabled

• setSpatializationEnabled(value: boolean): void

  设置是否启用位置、距离和方向引起的空间音效。

  参数

  value

  boolean

  返回值

  void

  源码与继承

setVelocity

• setVelocity(value: ReadonlyValue<Vector3f>): void

  设置三维速度，用于多普勒效应，单位为位置单位/秒。

  参数

  value

  ReadonlyValue<Vector3f>

  返回值

  void

  源码与继承

setVolume

• setVolume(value: number): void

  设置音量百分比，0 为静音，100 为原始音量。

  参数

  value

  number

  返回值

  void

  源码与继承

stop

• stop(): void

  停止并将播放位置归零。

  返回值

  void

  源码与继承

只读[audioHandle]