SoundBuffer Class

previous page next page

SFML.Net

SoundBuffer Class

Storage for audio samples defining a sound

Inheritance Hierarchy

SystemObject SFMLObjectBase
SFML.AudioSoundBuffer

Namespace: SFML.Audio
Assembly: sfmlnet-audio-2 (in sfmlnet-audio-2.dll) Version: 2.2.0.0 (2.2.0)

Syntax

public class SoundBuffer : ObjectBase

Public Class SoundBuffer
	Inherits ObjectBase

public ref class SoundBuffer : public ObjectBase

type SoundBuffer =  
    class
        inherit ObjectBase
    end

The SoundBuffer type exposes the following members.

Constructors

	Name	Description
	SoundBuffer(Byte)	Construct a sound buffer from a file in memory. Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
	SoundBuffer(Stream)	Construct a sound buffer from a custom stream. Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
	SoundBuffer(String)	Construct a sound buffer from a file Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
	SoundBuffer(SoundBuffer)	Construct a sound buffer from another sound buffer
	SoundBuffer(Int16, UInt32, UInt32)	Construct a sound buffer from an array of samples

Methods

	Name	Description
	Destroy	Handle the destruction of the object (Overrides ObjectBaseDestroy(Boolean).)
	Dispose	Explicitely dispose the object (Inherited from ObjectBase.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Dispose the object (Inherited from ObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SaveToFile	Save the sound buffer to an audio file. Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
	ToString	Provide a string describing the object (Overrides ObjectToString.)

Properties

	Name	Description
	ChannelCount	Number of channels (1 = mono, 2 = stereo)
	CPointer	Access to the internal pointer of the object. For internal use only (Inherited from ObjectBase.)
	Duration	Total duration of the buffer
	SampleRate	Sample rate of the sound buffer. The sample rate is the number of audio samples played per second. The higher, the better the quality.
	Samples	Array of audio samples stored in the buffer. The format of the returned samples is 16 bits signed integer (sf::Int16).

previous page start next page