SFML.Net
SoundBufferRecorder Class |
Specialized SoundRecorder which saves the captured
audio data into a sound buffer
Inheritance Hierarchy
Namespace: SFML.Audio
Assembly: sfmlnet-audio-2 (in sfmlnet-audio-2.dll) Version: 2.2.0.0 (2.2.0)
Syntax
The SoundBufferRecorder type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SoundBufferRecorder | Initializes a new instance of the SoundBufferRecorder class |
Methods
Name | Description | |
---|---|---|
Destroy |
Handle the destruction of the object
(Inherited from SoundRecorder.) | |
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.) | |
GetDevice |
Get the name of the current audio capture device
(Inherited from SoundRecorder.) | |
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.) | |
OnProcessSamples |
Process a new chunk of recorded samples
(Overrides SoundRecorderOnProcessSamples(Int16).) | |
OnStart |
Called when a new capture starts
(Overrides SoundRecorderOnStart.) | |
OnStop |
Called when the current capture stops
(Overrides SoundRecorderOnStop.) | |
SetDevice |
Set the audio capture device
(Inherited from SoundRecorder.) | |
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.
(Inherited from SoundRecorder.) | |
Start |
Start the capture using the default sample rate (44100 Hz).
Please note that only one capture can happen at the same time.
(Inherited from SoundRecorder.) | |
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.
(Inherited from SoundRecorder.) | |
Stop |
Stop the capture
(Inherited from SoundRecorder.) | |
ToString |
Provide a string describing the object
(Overrides SoundRecorderToString.) |
Properties
Name | Description | |
---|---|---|
CPointer |
Access to the internal pointer of the object.
For internal use only
(Inherited from ObjectBase.) | |
SampleRate |
Sample rate of the sound recorder.
The sample rate defines the number of audio samples
captured per second. The higher, the better the quality
(for example, 44100 samples/sec is CD quality).
(Inherited from SoundRecorder.) | |
SoundBuffer |
Sound buffer containing the captured audio data
The sound buffer is valid only after the capture has ended.
This function provides a reference to the internal
sound buffer, but you should make a copy of it if you want
to make any modifications to it.
|
See Also