Scala Native SFML
DocsAPI
Generated with
Scala Native SFML/sfml/sfml.audio/SoundSource

SoundSource

sfml.audio.SoundSource
See theSoundSource companion object
trait SoundSource(using ctor: ctor)

Base class defining a sound's properties.

SoundSource is not meant to be used directly, it only serves as a common base for all audio objects that can live in the audio environment.

It defines several properties for the sound: pitch, volume, position, attenuation, etc. All of them can be changed at any time with no impact on performances.

Attributes

See also

Sound, SoundStream

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def pause(): Unit

Pause the sound source.

Pause the sound source.

This function pauses the source if it was playing, otherwise (source already paused or stopped) it has no effect.

Attributes

See also
def play(): Unit

Start or resume playing the sound source.

Start or resume playing the sound source.

This function starts the source if it was stopped, resumes it if it was paused, and restarts it from the beginning if it was already playing.

Attributes

See also
def status: Status

Get the current status of the sound (stopped, paused, playing).

Get the current status of the sound (stopped, paused, playing).

Attributes

Returns

Current status of the sound

def stop(): Unit

Stop playing the sound source.

Stop playing the sound source.

This function stops the source if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause).

Attributes

See also

Concrete methods

def attenuation: Float

Get the attenuation factor of the sound.

Get the attenuation factor of the sound.

Attributes

Returns

Attenuation factor of the sound

See also
def attenuation_=(attenuation: Float): Unit

Set the attenuation factor of the sound.

Set the attenuation factor of the sound.

The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.

Value parameters

attenuation

New attenuation factor of the sound

Attributes

See also
def directionalAttenuationFactor: Float

Get the directional attenuation factor of the sound.

Get the directional attenuation factor of the sound.

Attributes

Returns

Directional attenuation factor of the sound

See also
def directionalAttenuationFactor_=(factor: Float): Unit

Set the directional attenuation factor of the sound.

Set the directional attenuation factor of the sound.

Depending on the virtual position of an output channel relative to the listener (such as in surround sound setups), sounds will be attenuated when emitting them from certain channels. This factor determines how strong the attenuation based on output channel position relative to the listener is.

Attributes

See also
def dopplerFactor: Float

Get the doppler factor of the sound.

Get the doppler factor of the sound.

Attributes

Returns

Doppler factor of the sound

See also
def dopplerFactor_=(factor: Float): Unit

Set the doppler factor of the sound.

Set the doppler factor of the sound.

The doppler factor determines how strong the doppler shift will be.

Value parameters

factor

New doppler factor to apply to the sound

Attributes

See also
def maxDistance: Float

Get the maximum distance of the sound.

Get the maximum distance of the sound.

Attributes

Returns

Maximum distance of the sound

See also
def maxDistance_=(distance: Float): Unit

Set the maximum distance of the sound.

Set the maximum distance of the sound.

The "maximum distance" of a sound is the minimum distance at which it is heard at its minimum volume. Closer than the maximum distance, it will start to fade in according to its attenuation factor. The default value of the maximum distance is the maximum value a float can represent.

Value parameters

distance

New maximum distance of the sound

Attributes

See also
def maxGain: Float

Get the maximum gain of the sound.

Get the maximum gain of the sound.

Attributes

Returns

Maximum gain of the sound

See also
def maxGain_=(gain: Float): Unit

Set the maximum gain of the sound.

Set the maximum gain of the sound.

When the sound is closer from the listener than the "minimum distance" the attenuated gain is clamped so it cannot go above the maximum gain value.

Value parameters

gain

New maximum gain of the sound

Attributes

See also
def minDistance: Float

Get the minimum distance of the sound.

Get the minimum distance of the sound.

Attributes

Returns

Minimum distance of the sound

See also
def minDistance_=(distance: Float): Unit

Set the minimum distance of the sound.

Set the minimum distance of the sound.

The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.

Value parameters

distance

New minimum distance of the sound

Attributes

See also
def minGain: Float

Get the minimum gain of the sound.

Get the minimum gain of the sound.

Attributes

Returns

Minimum gain of the sound

See also
def minGain_=(gain: Float): Unit

Set the minimum gain of the sound.

Set the minimum gain of the sound.

When the sound is further away from the listener than the "maximum distance" the attenuated gain is clamped so it cannot go below the minimum gain value.

Value parameters

gain

New minimum gain of the sound

Attributes

See also
def pan: Float

Get the pan of the sound.

Get the pan of the sound.

Attributes

Returns

Pan of the sound

See also
def pan_=(pan: Float): Unit

Set the pan of the sound.

Set the pan of the sound.

Using panning, a mono sound can be panned between stereo channels. When the pan is set to -1, the sound is played only on the left channel, when the pan is set to +1, the sound is played only on the right channel.

Attributes

See also

pan

def pitch: Float

Get the pitch of the sound.

Get the pitch of the sound.

Attributes

Returns

Pitch of the sound

See also
def pitch_=(pitch: Float): Unit

Set the pitch of the sound.

Set the pitch of the sound.

The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.

Attributes

See also
def relativeToListener: Boolean

Tell whether the sound's position is relative to the listener or is absolute.

Tell whether the sound's position is relative to the listener or is absolute.

Attributes

Returns

true if the position is relative, false if it's absolute

See also
def relativeToListener_=(relative: Boolean): Unit

Make the sound's position relative to the listener or absolute.

Make the sound's position relative to the listener or absolute.

Making a sound relative to the listener will ensure that it will always be played the same way regardless of the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).

Value parameters

relative

true to set the position relative, false to set it absolute

Attributes

See also
def spatializationEnabled: Boolean

Tell whether spatialization of the sound is enabled.

Tell whether spatialization of the sound is enabled.

Attributes

Returns

true if spatialization is enabled, false if it's disabled

See also
def spatializationEnabled_=(enabled: Boolean): Unit

Set whether spatialization of the sound is enabled.

Set whether spatialization of the sound is enabled.

Spatialization is the application of various effects to simulate a sound being emitted at a virtual position in 3D space and exhibiting various physical phenomena such as directional attenuation and doppler shift.

Value parameters

enabled

true to enable spatialization, false to disable

Attributes

See also
def volume: Float

Get the volume of the sound.

Get the volume of the sound.

Attributes

Returns

Volume of the sound, in the range [0, 100]

See also
def volume_=(volume: Float): Unit

Set the volume of the sound.

Set the volume of the sound.

The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.

Value parameters

volume

Volume of the sound

Attributes

See also
Generated with