C# Class Accord.DirectSound.AudioCaptureDevice

Audio source for local audio capture device (i.e. a microphone).

This audio source captures audio data obtained from a local audio capture device such as the microphone. The audio is captured using DirectSound through SlimDX.

For instructions on how to list capture devices, please see the AudioDeviceCollection documentation page.

Inheritance: IAudioSource, IDisposable

Datei anzeigen Open project: accord-net/framework Class Usage Examples

Public Methods

Method	Description
AudioCaptureDevice ( ) : Accord.Audio	Initializes a new instance of the AudioCaptureDevice class.
AudioCaptureDevice ( AudioDeviceInfo device ) : Accord.Audio	Initializes a new instance of the AudioCaptureDevice class.
AudioCaptureDevice ( System.Guid device ) : Accord.Audio	Initializes a new instance of the AudioCaptureDevice class.
AudioCaptureDevice ( System.Guid device, string name ) : Accord.Audio	Initializes a new instance of the AudioCaptureDevice class.
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Seek ( int frameIndex ) : void	This source does not support seeking.
SignalToStop ( ) : void	Signals audio source to stop its work. Signals audio source to stop its background thread, stop to provide new frames and free resources.
Start ( ) : void	Start audio source. Starts audio source and return execution to caller. audio source object creates background thread and notifies about new frames with the help of NewFrame event.
Stop ( ) : void	Stop audio source. Stops audio source aborting its thread. Since the method aborts background thread, its usage is highly not preferred and should be done only if there are no other options. The correct way of stopping camera is signaling it stop and then waiting for background thread's completion.
WaitForStop ( ) : void	Wait for audio source has stopped. Waits for source stopping after it was signaled to stop using SignalToStop method.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases unmanaged and - optionally - managed resources
OnNewFrame ( Array frame ) : void	Notifies client about new block of frames.

Private Methods

Method	Description
Free ( ) : void	Free resource.
WorkerThread ( ) : void	Worker thread.

Method Details

AudioCaptureDevice() public method

Initializes a new instance of the AudioCaptureDevice class.

public AudioCaptureDevice ( ) : Accord.Audio
return	Accord.Audio

AudioCaptureDevice() public method

Initializes a new instance of the AudioCaptureDevice class.

public AudioCaptureDevice ( AudioDeviceInfo device ) : Accord.Audio
device	AudioDeviceInfo
return	Accord.Audio

AudioCaptureDevice() public method

Initializes a new instance of the AudioCaptureDevice class.

public AudioCaptureDevice ( System.Guid device ) : Accord.Audio
device	System.Guid	Global identifier of the audio capture device.
return	Accord.Audio

AudioCaptureDevice() public method

Initializes a new instance of the AudioCaptureDevice class.

public AudioCaptureDevice ( System.Guid device, string name ) : Accord.Audio
device	System.Guid	Global identifier of the audio capture device.
name	string	The device name or description string.
return	Accord.Audio

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public Dispose ( ) : void
return	void

Dispose() protected method

Releases unmanaged and - optionally - managed resources

protected Dispose ( bool disposing ) : void
disposing	bool	/// true to release both managed and unmanaged resources; /// false to release only unmanaged resources.
return	void

OnNewFrame() protected method

Notifies client about new block of frames.

protected OnNewFrame ( Array frame ) : void
frame	System.Array	New frame's audio.
return	void

Seek() public method

This source does not support seeking.

public Seek ( int frameIndex ) : void
frameIndex	int
return	void

SignalToStop() public method

Signals audio source to stop its work.

Signals audio source to stop its background thread, stop to provide new frames and free resources.

public SignalToStop ( ) : void
return	void

Start() public method

Start audio source.

Starts audio source and return execution to caller. audio source object creates background thread and notifies about new frames with the help of NewFrame event.

public Start ( ) : void
return	void

Stop() public method

Stop audio source.

Stops audio source aborting its thread.

Since the method aborts background thread, its usage is highly not preferred and should be done only if there are no other options. The correct way of stopping camera is signaling it stop and then waiting for background thread's completion.

public Stop ( ) : void
return	void

WaitForStop() public method

Wait for audio source has stopped.

Waits for source stopping after it was signaled to stop using SignalToStop method.

public WaitForStop ( ) : void
return	void