SoundSource

Static ReadonlyCone

Static ReadonlyStatus

assign

• assign(source: SoundSource): this

  Copy source attributes, retaining this source's content and playback.

  Parameters

  source

  SoundSource

  Returns

  this

  Source & inheritance

getAttenuation

• getAttenuation(): number

  Return the distance attenuation factor.

  Returns

  number

  Source & inheritance

getCone

• getCone(): Cone

  Return a copy of the directional cone parameters.

  Returns

  Cone

  Source & inheritance

getDirection

• getDirection(): Vector3f

  Return a copy of the emission direction.

  Returns

  Vector3f

  Source & inheritance

getDirectionalAttenuationFactor

• getDirectionalAttenuationFactor(): number

  Return the directional attenuation factor.

  Returns

  number

  Source & inheritance

getDopplerFactor

• getDopplerFactor(): number

  Return the Doppler effect multiplier.

  Returns

  number

  Source & inheritance

getMaxDistance

• getMaxDistance(): number

  Return the maximum distance.

  Returns

  number

  Source & inheritance

getMaxGain

• getMaxGain(): number

  Return the maximum gain.

  Returns

  number

  Source & inheritance

getMinDistance

• getMinDistance(): number

  Return the minimum reference distance.

  Returns

  number

  Source & inheritance

getMinGain

• getMinGain(): number

  Return the minimum gain.

  Returns

  number

  Source & inheritance

getPan

• getPan(): number

  Return the stereo pan.

  Returns

  number

  Source & inheritance

getPitch

• getPitch(): number

  Return the pitch multiplier.

  Returns

  number

  Source & inheritance

getPlayingOffset

• getPlayingOffset(): Time

  Return a copy of the current playback position as a time.

  Returns

  Time

  Source & inheritance

getPosition

• getPosition(): Vector3f

  Return a copy of the 3D position.

  Returns

  Vector3f

  Source & inheritance

getStatus

• getStatus(): SoundStatus

  Query the native engine's current playback status.

  Returns

  SoundStatus

  Source & inheritance

getVelocity

• getVelocity(): Vector3f

  Return a copy of the velocity.

  Returns

  Vector3f

  Source & inheritance

getVolume

• getVolume(): number

  Return the volume percentage.

  Returns

  number

  Source & inheritance

isLooping

• isLooping(): boolean

  Return whether playback loops.

  Returns

  boolean

  Source & inheritance

isRelativeToListener

• isRelativeToListener(): boolean

  Return whether listener-relative coordinates are used.

  Returns

  boolean

  Source & inheritance

isSpatializationEnabled

• isSpatializationEnabled(): boolean

  Return whether spatialization is enabled.

  Returns

  boolean

  Source & inheritance

pause

• pause(): void

  Pause and retain the playback position.

  Returns

  void

  Source & inheritance

play

• play(): void

  Start or resume playback; if already playing, restart per SFML semantics.

  Returns

  void

  Source & inheritance

setAttenuation

• setAttenuation(value: number): void

  Set the distance attenuation factor; 0 disables distance attenuation.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setCone

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

  Set the inner and outer cone angles and outer gain, updating the native audio engine.

  Parameters

  value

  Readonly<ConeInput>

  Returns

  void

  Source & inheritance

setDirection

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

  Set the sound source's emission direction.

  Parameters

  value

  ReadonlyValue<Vector3f>

  Returns

  void

  Source & inheritance

setDirectionalAttenuationFactor

• setDirectionalAttenuationFactor(value: number): void

  Set the factor controlling the source direction's effect on attenuation.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setDopplerFactor

• setDopplerFactor(value: number): void

  Set the Doppler effect multiplier; 0 disables it.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setEffectProcessor

• setEffectProcessor(processor?: EffectProcessor): void

  Bind and retain an effect processor reference; undefined removes it.

  Parameters

  processorOptional

  EffectProcessor

  Returns

  void

  Source & inheritance

setLooping

• setLooping(value: boolean): void

  Set whether playback loops after reaching the end.

  Parameters

  value

  boolean

  Returns

  void

  Source & inheritance

setMaxDistance

• setMaxDistance(value: number): void

  Set the maximum distance used for distance attenuation.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setMaxGain

• setMaxGain(value: number): void

  Set the maximum gain after distance attenuation.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setMinDistance

• setMinDistance(value: number): void

  Set the minimum reference distance at which maximum volume is maintained.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setMinGain

• setMinGain(value: number): void

  Set the minimum gain after distance attenuation.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setPan

• setPan(value: number): void

  Set stereo pan: -1 is left, 0 is center, and 1 is right.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setPitch

• setPitch(value: number): void

  Set the pitch and playback rate multiplier; 1 is the original rate.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

setPlayingOffset

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

  Set the playback time relative to the beginning of the sound.

  Parameters

  value

  ReadonlyValue<Time>

  Returns

  void

  Source & inheritance

setPosition

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

  Set the 3D position using the same units as the listener and distances.

  Parameters

  value

  ReadonlyValue<Vector3f>

  Returns

  void

  Source & inheritance

setRelativeToListener

• setRelativeToListener(value: boolean): void

  Set whether the position is relative to the listener; false uses world coordinates.

  Parameters

  value

  boolean

  Returns

  void

  Source & inheritance

setSpatializationEnabled

• setSpatializationEnabled(value: boolean): void

  Enable or disable spatial effects from position, distance, and direction.

  Parameters

  value

  boolean

  Returns

  void

  Source & inheritance

setVelocity

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

  Set the 3D velocity for the Doppler effect, in position units per second.

  Parameters

  value

  ReadonlyValue<Vector3f>

  Returns

  void

  Source & inheritance

setVolume

• setVolume(value: number): void

  Set volume as a percentage; 0 is silent and 100 is the original volume.

  Parameters

  value

  number

  Returns

  void

  Source & inheritance

stop

• stop(): void

  Stop and reset the playback position to zero.

  Returns

  void

  Source & inheritance

Readonly[audioHandle]