SoundRecorder Methods

SFML.Net

SoundRecorder Methods

The SoundRecorder type exposes the following members.

Methods
  Name Description
Protected method Destroy
Handle the destruction of the object
(Overrides ObjectBaseDestroy(Boolean).)
Public method Dispose
Explicitely dispose the object
(Inherited from ObjectBase.)
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Dispose the object
(Inherited from ObjectBase.)
Public method GetDevice
Get the name of the current audio capture device
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected method OnProcessSamples
Process a new chunk of recorded samples. This virtual function is called every time a new chunk of recorded data is available. The derived class can then do whatever it wants with it (storing it, playing it, sending it over the network, etc.).
Protected method OnStart
Start capturing audio data. This virtual function may be overriden by a derived class if something has to be done every time a new capture starts. If not, this function can be ignored; the default implementation does nothing.
Protected method OnStop
Stop capturing audio data. This virtual function may be overriden by a derived class if something has to be done every time the capture ends. If not, this function can be ignored; the default implementation does nothing.
Public method SetDevice
Set the audio capture device
Protected method SetProcessingInterval
The processing interval controls the period between calls to the onProcessSamples function. You may want to use a small interval if you want to process the recorded data in real time, for example. Note: this is only a hint, the actual period may vary. So don't rely on this parameter to implement precise timing. The default processing interval is 100 ms.
Public method Start
Start the capture using the default sample rate (44100 Hz). Please note that only one capture can happen at the same time.
Public method Start(UInt32)
Start the capture. The sampleRate parameter defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality). This function uses its own thread so that it doesn't block the rest of the program while the capture runs. Please note that only one capture can happen at the same time.
Public method Stop
Stop the capture
Public method ToString
Provide a string describing the object
(Overrides ObjectToString.)
Top
See Also