Class AudioPlayback
Definition
- Namespace:
- Tizen.Multimedia
- Assembly:
- Tizen.Multimedia.AudioIO.dll
Provides the ability to directly manage the system audio output devices and play the PCM (pulse-code modulation) data.
public class AudioPlayback : IDisposable
- Inheritance
-
objectAudioPlayback
- Implements
-
System.IDisposable
Constructors
View SourceAudioPlayback(int, AudioChannel, AudioSampleType)
Initializes a new instance of the AudioPlayback class with the specified sample rate, channel, and sample type.
Declaration
public AudioPlayback(int sampleRate, AudioChannel channel, AudioSampleType sampleType)
Parameters
Type | Name | Description |
---|---|---|
int | sampleRate | The audio sample rate (8000 ~ 48000Hz). |
AudioChannel | channel | The audio channel type. |
AudioSampleType | sampleType | The audio sample type. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException |
|
System.ArgumentException |
|
Fields
View SourceMaxSampleRate
Specifies the maximum value allowed for the audio capture, in Hertz (Hz).
Declaration
public static readonly int MaxSampleRate
Field Value
Type | Description |
---|---|
int |
See Also
View SourceMinSampleRate
Specifies the minimum value allowed for the audio capture, in Hertz (Hz).
Declaration
public static readonly int MinSampleRate
Field Value
Type | Description |
---|---|
int |
See Also
Properties
View SourceChannel
Gets the channel type of the audio output data stream.
Declaration
public AudioChannel Channel { get; }
Property Value
Type | Description |
---|---|
AudioChannel |
SampleRate
Gets the sample rate of the audio output data stream, in Hertz (Hz).
Declaration
public int SampleRate { get; }
Property Value
Type | Description |
---|---|
int |
SampleType
Gets the sample type of the audio output data stream.
Declaration
public AudioSampleType SampleType { get; }
Property Value
Type | Description |
---|---|
AudioSampleType |
StreamType
Gets the sound type supported by the audio output device.
Declaration
public AudioStreamType StreamType { get; }
Property Value
Type | Description |
---|---|
AudioStreamType |
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
Methods
View SourceApplyStreamPolicy(AudioStreamPolicy)
Applies the sound stream information to the AudioPlayback.
Declaration
public void ApplyStreamPolicy(AudioStreamPolicy streamPolicy)
Parameters
Type | Name | Description |
---|---|---|
AudioStreamPolicy | streamPolicy | The AudioStreamPolicy to apply for the AudioPlayback. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ObjectDisposedException |
|
System.NotSupportedException |
|
System.ArgumentException | Not able to retrieve information from |
Dispose()
Releases all resources used by the AudioPlayback object.
Declaration
public void Dispose()
Dispose(bool)
Releases the resources used by the AudioPlayback object.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
Drain()
Drains the buffered audio data from the output stream. It blocks the calling thread until the drain of the stream buffer is complete, for example, at the end of playback.
Declaration
public void Drain()
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
System.InvalidOperationException | The current state is Idle. |
~AudioPlayback()
Finalizes an instance of the AudioPlayback class.
Declaration
protected ~AudioPlayback()
Flush()
Flushes and discards the buffered audio data from the output stream.
Declaration
public void Flush()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The current state is Idle. |
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
GetBufferSize()
Gets the size allocated for the audio output buffer.
Declaration
public int GetBufferSize()
Returns
Type | Description |
---|---|
int |
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
Pause()
Pauses feeding of the audio data to the device.
Declaration
public void Pause()
Remarks
It has no effect if the current state is Paused.
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The current state is Idle. |
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
See Also
View SourcePrepare()
Prepares the AudioPlayback.
Declaration
public void Prepare()
Remarks
This must be called before Write(byte[]).
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Operation failed due to an internal error. |
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
See Also
View SourceResume()
Resumes feeding of the audio data to the device.
Declaration
public void Resume()
Remarks
It has no effect if the current state is Running.
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The current state is Idle. |
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
See Also
View SourceUnprepare()
Unprepares the AudioPlayback.
Declaration
public void Unprepare()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Operation failed due to an internal error. |
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
See Also
View SourceWrite(byte[])
Starts writing the audio data to the device.
Declaration
public int Write(byte[] buffer)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | The buffer to write. |
Returns
Type | Description |
---|---|
int | The written size. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ArgumentException | The length of |
System.InvalidOperationException | The current state is not Running. |
System.ObjectDisposedException | The AudioPlayback has already been disposed of. |
Events
View SourceBufferAvailable
Occurs when the audio playback data can be written.
Declaration
public event EventHandler<AudioPlaybackBufferAvailableEventArgs> BufferAvailable
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><AudioPlaybackBufferAvailableEventArgs> |
See Also
View SourceStateChanged
Occurs when the state of the AudioPlayback is changed.
Declaration
public event EventHandler<AudioIOStateChangedEventArgs> StateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><AudioIOStateChangedEventArgs> |