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

SoundSource

sfml.audio.SoundSource
See theSoundSource companion object
abstract trait SoundSource

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.

Attributes

See also
Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Sound
trait SoundStream
trait Music

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 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 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 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 position: Unit
def position_=(x: Float, y: Float, z: Float): Unit

Set the 3D position of the sound in the audio scene.

Set the 3D position of the sound in the audio scene.

Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).

Value parameters

x

X coordinate of the position of the sound in the scene

y

Y coordinate of the position of the sound in the scene

z

Z coordinate of the position of the sound in the scene

Attributes

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 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 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