Class AudioCaptureBase

Definition

Namespace:: Tizen.Multimedia

Assembly:: Tizen.Multimedia.AudioIO.dll

API Level:: 3

Privilege Level:: public

Privilege:: http://tizen.org/privilege/recorder

Provides the ability to directly manage the system audio input devices.


                C#
                
                    Copy
                    
                
            
public abstract class AudioCaptureBase : IDisposable

Inheritance: Object

AudioCaptureBase

Derived: AsyncAudioCapture

AsyncAudioCapture

AsyncAudioCapture

AsyncAudioCapture

AsyncAudioCapture

AsyncAudioCapture

AsyncAudioCapture

AudioCapture

AudioCapture

AudioCapture

AudioCapture

AudioCapture

AudioCapture

AudioCapture

Implements: System.IDisposable

Fields

View Source

MaxSampleRate

Specifies the maximum value allowed for the audio capture, in Hertz (Hz).

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly int MaxSampleRate

Field Value

Type	Description
System.Int32

MinSampleRate

Specifies the minimum value allowed for the audio capture, in Hertz (Hz).

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly int MinSampleRate

Field Value

Type	Description
System.Int32

Properties

View Source

Channel

Gets the channel type of the audio input data stream.

Declaration


                C#
                
                    Copy
                    
                
            
public AudioChannel Channel { get; }

Property Value

Type	Description
AudioChannel

API Level: 3

View Source

SampleRate

Gets the sample rate of the audio input data stream, in Hertz (Hz).

Declaration


                C#
                
                    Copy
                    
                
            
public int SampleRate { get; }

Property Value

Type	Description
System.Int32

API Level: 3

View Source

SampleType

Gets the sample type of the audio input data stream.

Declaration


                C#
                
                    Copy
                    
                
            
public AudioSampleType SampleType { get; }

Property Value

Type	Description
AudioSampleType

API Level: 3

Methods

View Source

ApplyStreamPolicy(AudioStreamPolicy)

Sets the sound stream information to the audio input.

Declaration


                C#
                
                    Copy
                    
                
            
public void ApplyStreamPolicy(AudioStreamPolicy streamPolicy)

Parameters

Type	Name	Description
AudioStreamPolicy	streamPolicy	The AudioStreamPolicy to apply for the AudioCapture.

Exceptions

Type	Condition
ArgumentNullException	`streamPolicy` is null.
ObjectDisposedException	`streamPolicy` has already been disposed of. -or- The AudioCaptureBase has already been disposed of.
System.NotSupportedException	`streamPolicy` is not supported.
System.ArgumentException	Not able to retrieve information from `streamPolicy`.

API Level: 3

View Source

Dispose()

Releases all resources used by the AudioCaptureBase object.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

API Level: 3

View Source

Dispose(Boolean)

Releases the resources used by the AudioCaptureBase object.

Declaration


                C#
                
                    Copy
                    
                
            
protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

API Level: 3

View Source

Finalize()

Finalizes an instance of the AudioCaptureBase class.

Declaration


                C#
                
                    Copy
                    
                
            
protected void Finalize()

View Source

Flush()

Flushes and discards buffered audio data from the input stream.

Declaration


                C#
                
                    Copy
                    
                
            
public void Flush()

Exceptions

Type	Condition
InvalidOperationException	The current state is Idle.
ObjectDisposedException	The AudioCaptureBase has already been disposed of.

API Level: 3

View Source

GetBufferSize()

Gets the size allocated for the audio input buffer.

Declaration


                C#
                
                    Copy
                    
                
            
public int GetBufferSize()

Returns

Type	Description
System.Int32

Exceptions

Type	Condition
ObjectDisposedException	The AudioCaptureBase has already been disposed of.

API Level: 3

View Source

Pause()

Pauses buffering of audio data from the device.

Declaration


                C#
                
                    Copy
                    
                
            
public void Pause()

Exceptions

Type	Condition
InvalidOperationException	The current state is Idle. -or- The method is called in the DataAvailable event handler.
ObjectDisposedException	The AudioCaptureBase has already been disposed of.

Prepare()

Prepares the AudioCapture for reading audio data by starting buffering of audio data from the device.

Declaration


                C#
                
                    Copy
                    
                
            
public void Prepare()

Exceptions

Type	Condition
InvalidOperationException	Operation failed due to an internal error. -or- The current state is not Idle.
ObjectDisposedException	The AudioCaptureBase has already been disposed of.

Resume()

Resumes buffering audio data from the device.

Declaration


                C#
                
                    Copy
                    
                
            
public void Resume()

Exceptions

Type	Condition
InvalidOperationException	The current state is Idle. -or- The method is called in the DataAvailable event handler.
ObjectDisposedException	The AudioCaptureBase has already been disposed of.

Unprepare()

Unprepares the AudioCapture.

Declaration


                C#
                
                    Copy
                    
                
            
public void Unprepare()

Exceptions

Type	Condition
InvalidOperationException	Operation failed due to an internal error. -or- The current state is Idle.
ObjectDisposedException	The AudioCaptureBase has already been disposed of.

Events

View Source

StateChanged

Occurs when the state of the AudioCapture is changed.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<AudioIOStateChangedEventArgs> StateChanged

Event Type

Type	Description
System.EventHandler<AudioIOStateChangedEventArgs>

API Level: 3

Implements

System.IDisposable

Class AudioCaptureBase

Definition

Fields

MaxSampleRate

Declaration

Field Value

See Also

API Level: 3

MinSampleRate

Declaration

Field Value

See Also

API Level: 3

Properties

Channel

Declaration

Property Value

API Level: 3

SampleRate

Declaration

Property Value

API Level: 3

SampleType

Declaration

Property Value

API Level: 3

Methods

ApplyStreamPolicy(AudioStreamPolicy)

Declaration

Parameters

Exceptions

API Level: 3

Dispose()

Declaration

API Level: 3

Dispose(Boolean)

Declaration

Parameters

API Level: 3

Finalize()

Declaration

Flush()

Declaration

Exceptions

API Level: 3

GetBufferSize()

Declaration

Returns

Exceptions

API Level: 3

Pause()

Declaration

Exceptions

See Also

API Level: 3

Prepare()

Declaration

Exceptions

See Also

API Level: 3

Resume()

Declaration

Exceptions

See Also

API Level: 3

Unprepare()

Declaration

Exceptions

See Also

API Level: 3

Events

StateChanged

Declaration

Event Type

API Level: 3

Implements