Music Class

SFML.Net

Music Class
Streamed music played from an audio file
Inheritance Hierarchy
SystemObject  SFMLObjectBase
    SFML.AudioMusic

Namespace: SFML.Audio
Assembly: sfmlnet-audio-2 (in sfmlnet-audio-2.dll) Version: 2.2.0.0 (2.2.0)
Syntax
public class Music : ObjectBase
Public Class Music
	Inherits ObjectBase
public ref class Music : public ObjectBase
type Music =  
    class
        inherit ObjectBase
    end

The Music type exposes the following members.

Constructors
  NameDescription
Public methodMusic(Byte)
Constructs a music from an audio file in memory
Public methodMusic(Stream)
Constructs a music from a custom stream
Public methodMusic(String)
Constructs a music from an audio file
Top
Methods
  NameDescription
Protected methodDestroy
Handle the destruction of the object
(Overrides ObjectBaseDestroy(Boolean).)
Public methodDispose
Explicitely dispose the object
(Inherited from ObjectBase.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Dispose the object
(Inherited from ObjectBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPause
Pause the audio stream. This function pauses the stream if it was playing, otherwise (stream already paused or stopped) it has no effect.
Public methodPlay
Start or resume playing the audio stream. This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the stream is played.
Public methodStop
Stop playing the audio stream. This function stops the stream if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike Pause()).
Public methodToString
Provide a string describing the object
(Overrides ObjectToString.)
Top
Properties
  NameDescription
Public propertyAttenuation
Attenuation factor of the music. The attenuation is a multiplicative factor which makes the music 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.
Public propertyChannelCount
Number of channels (1 = mono, 2 = stereo)
Public propertyCPointer
Access to the internal pointer of the object. For internal use only
(Inherited from ObjectBase.)
Public propertyDuration
Total duration of the music
Public propertyLoop
Flag if the music should loop after reaching the end. If set, the music will restart from beginning after reaching the end and so on, until it is stopped or Loop = false is set. The default looping state for music is false.
Public propertyMinDistance
Minimum distance of the music. 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.
Public propertyPitch
Pitch of the music. 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.
Public propertyPlayingOffset
Current playing position of the music. The playing position can be changed when the music is either paused or playing.
Public propertyPosition
3D position of the music in the audio scene. Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
Public propertyRelativeToListener
Make the music'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 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).
Public propertySampleRate
Sample rate of the music. The sample rate is the number of audio samples played per second. The higher, the better the quality.
Public propertyStatus
Current status of the music (see SoundStatus enum)
Public propertyVolume
Volume of the music. The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.
Top
See Also