SFML.Net
| SoundRecorder Class |
Base class intended for capturing sound data
Inheritance HierarchyNamespace: SFML.Audio
Assembly: sfmlnet-audio-2 (in sfmlnet-audio-2.dll) Version: 2.2.0.0 (2.2.0)
SyntaxThe SoundRecorder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoundRecorder |
Default constructor
|
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.) |
| GetDevice |
Get the name of the current audio capture device
|
| 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.
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.).
|
| 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.
|
| 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.
|
| SetDevice |
Set the audio capture device
|
| 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.
|
| Start |
Start the capture using the default sample rate (44100 Hz).
Please note that only one capture can happen at the same time.
|
| 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.
|
| Stop |
Stop the capture
|
| ToString |
Provide a string describing the object
(Overrides ObjectToString.) |
Properties| Name | Description | |
|---|---|---|
  | AvailableDevices |
Get the list of the names of all available audio capture devices
|
| CPointer |
Access to the internal pointer of the object.
For internal use only
(Inherited from ObjectBase.) |
| DefaultDevice |
Get the name of the default audio capture device
|
| IsAvailable |
Check if the system supports audio capture.
This function should always be called before using
the audio capture features. If it returns false, then
any attempt to use the SoundRecorder or one of its derived
classes will fail.
|
| 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).
|
See Also