Class AudioPlayback

View Source

Definition

Namespace:
Tizen.Multimedia
Assembly:
Tizen.Multimedia.AudioIO.dll
API Level:
3

Provides the ability to directly manage the system audio output devices and play the PCM (pulse-code modulation) data.


                
C#

                

                    
Copy

                    

                

            
public class AudioPlayback : IDisposable
Inheritance
System.Object
AudioPlayback
Implements
System.IDisposable

Constructors

View Source

AudioPlayback(Int32, AudioChannel, AudioSampleType)

Initializes a new instance of the AudioPlayback class with the specified sample rate, channel, and sample type.

Declaration

                
C#

                

                    
Copy

                    

                

            
public AudioPlayback(int sampleRate, AudioChannel channel, AudioSampleType sampleType)
Parameters
Type Name Description
System.Int32 sampleRate

The audio sample rate (8000 ~ 192000Hz).
AudioChannel channel

The audio channel type.
AudioSampleType sampleType

The audio sample type.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

sampleRate is less than MinSampleRate.
-or-
sampleRate is greater than MaxSampleRate.
System.ArgumentException

channel is invalid.
-or-
sampleType is invalid.
API Level: 3

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
See Also
API Level: 3
View Source

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
See Also
API Level: 3

Properties

View Source

Channel

Gets the channel type of the audio output 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 output 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 output data stream.

Declaration

                
C#

                

                    
Copy

                    

                

            
public AudioSampleType SampleType { get; }
Property Value
Type Description
AudioSampleType
API Level: 3
View Source

StreamType

Gets the sound type supported by the audio output device.

Declaration

                
C#

                

                    
Copy

                    

                

            
public AudioStreamType StreamType { get; }
Property Value
Type Description
AudioStreamType
Exceptions
Type Condition
ObjectDisposedException

The AudioPlayback has already been disposed of.
API Level: 3

Methods

View Source

ApplyStreamPolicy(AudioStreamPolicy)

Applies the sound stream information to the AudioPlayback.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void ApplyStreamPolicy(AudioStreamPolicy streamPolicy)
Parameters
Type Name Description
AudioStreamPolicy streamPolicy

The AudioStreamPolicy to apply for the AudioPlayback.
Exceptions
Type Condition
ArgumentNullException

streamPolicy is null.
ObjectDisposedException

streamPolicy has already been disposed of.
-or-
The AudioPlayback 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 AudioPlayback object.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
API Level: 3
View Source

Dispose(Boolean)

Releases the resources used by the AudioPlayback object.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
API Level: 3
View Source

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

                
C#

                

                    
Copy

                    

                

            
public void Drain()
Exceptions
Type Condition
ObjectDisposedException

The AudioPlayback has already been disposed of.
System.InvalidOperationException

The current state is Idle.
API Level: 3
View Source

Finalize()

Finalizes an instance of the AudioPlayback class.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected void Finalize()
View Source

Flush()

Flushes and discards the buffered audio data from the output stream.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Flush()
Exceptions
Type Condition
System.InvalidOperationException

The current state is Idle.
ObjectDisposedException

The AudioPlayback has already been disposed of.
API Level: 3
View Source

GetBufferSize()

Gets the size allocated for the audio output buffer.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int GetBufferSize()
Returns
Type Description
System.Int32
Exceptions
Type Condition
ObjectDisposedException

The AudioPlayback has already been disposed of.
API Level: 3
View Source

Pause()

Pauses feeding of the audio data to the device.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Pause()
Remarks

It has no effect if the current state is Paused.

Exceptions
Type Condition
System.InvalidOperationException

The current state is Idle.
-or-
The method is called in the BufferAvailable event handler.
ObjectDisposedException

The AudioPlayback has already been disposed of.
See Also
API Level: 3
View Source

Prepare()

Prepares the AudioPlayback.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Prepare()
Remarks

This must be called before Write(Byte[]).

Exceptions
Type Condition
System.InvalidOperationException

Operation failed due to an internal error.
-or-
The current state is not Idle.
ObjectDisposedException

The AudioPlayback has already been disposed of.
See Also
API Level: 3
View Source

Resume()

Resumes feeding of the audio data to the device.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Resume()
Remarks

It has no effect if the current state is Running.

Exceptions
Type Condition
System.InvalidOperationException

The current state is Idle.
-or-
The method is called in an event handler.
ObjectDisposedException

The AudioPlayback has already been disposed of.
See Also
API Level: 3
View Source

Unprepare()

Unprepares the AudioPlayback.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Unprepare()
Exceptions
Type Condition
System.InvalidOperationException

Operation failed due to an internal error.
-or-
The current state is Idle.
ObjectDisposedException

The AudioPlayback has already been disposed of.
See Also
API Level: 3
View Source

Write(Byte[])

Starts writing the audio data to the device.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int Write(byte[] buffer)
Parameters
Type Name Description
System.Byte[] buffer

The buffer to write.
Returns
Type Description
System.Int32

The written size.
Exceptions
Type Condition
ArgumentNullException

buffer is null.
System.ArgumentException

The length of buffer is zero.
System.InvalidOperationException

The current state is not Running.
ObjectDisposedException

The AudioPlayback has already been disposed of.
API Level: 3

Events

View Source

BufferAvailable

Occurs when the audio playback data can be written.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<AudioPlaybackBufferAvailableEventArgs> BufferAvailable
Event Type
Type Description
System.EventHandler<AudioPlaybackBufferAvailableEventArgs>
See Also
API Level: 3
View Source

StateChanged

Occurs when the state of the AudioPlayback is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<AudioIOStateChangedEventArgs> StateChanged
Event Type
Type Description
System.EventHandler<AudioIOStateChangedEventArgs>
API Level: 3

Implements

System.IDisposable