Class AudioStreamPolicy
Definition
- Namespace:
- Tizen.Multimedia
- Assembly:
- Tizen.Multimedia.dll
- API Level:
- 3
Provides the ability to control the sound stream.
C#Copypublic class AudioStreamPolicy : IDisposable
- Inheritance
-
AudioStreamPolicy
- Implements
-
System.IDisposable
Constructors
AudioStreamPolicy(AudioStreamType)
Initializes a new instance of the AudioStreamPolicy class with AudioStreamType.
Declaration
C#Copypublic AudioStreamPolicy(AudioStreamType streamType)
Parameters
Type | Name | Description |
---|---|---|
AudioStreamType | streamType | The type of the sound stream for which the policy needs to be created. |
Remarks
To apply the stream policy according to this stream information, the AudioStreamPolicy should be passed to other APIs related to playback or recording. (For example., Player, WavPlayer , etc.)
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
API Level: 3
Properties
Declaration
C#Copypublic bool FocusReacquisitionEnabled { get; set; }
Property Value
Type | Description |
---|---|
Boolean | true if the auto focus reacquisition is enabled; otherwise, false. |
Remarks
If you don't want to reacquire the focus you've lost automatically, disable the focus reacquisition.
Exceptions
Type | Condition |
---|---|
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Declaration
C#Copypublic AudioStreamFocusState PlaybackFocusState { get; }
Property Value
Type | Description |
---|---|
AudioStreamFocusState | The state of focus for playback. |
Exceptions
Type | Condition |
---|---|
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Declaration
C#Copypublic AudioStreamFocusState RecordingFocusState { get; }
Property Value
Type | Description |
---|---|
AudioStreamFocusState | The state of focus for recording. |
Exceptions
Type | Condition |
---|---|
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Declaration
C#Copypublic AudioVolumeType VolumeType { get; }
Property Value
Type | Description |
---|---|
AudioVolumeType | The AudioVolumeType of the policy instance. |
Remarks
If the AudioStreamType of the current AudioStreamPolicy is Emergency, it returns None.
Exceptions
Type | Condition |
---|---|
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Methods
AcquireFocus(AudioStreamFocusOptions, AudioStreamBehaviors, String)
Acquires the stream focus.
Declaration
C#Copypublic void AcquireFocus(AudioStreamFocusOptions options, AudioStreamBehaviors behaviors, string extraInfo)
Parameters
Type | Name | Description |
---|---|---|
AudioStreamFocusOptions | options | The focuses that you want to acquire. |
AudioStreamBehaviors | behaviors | The requesting behaviors. |
System.String | extraInfo | The extra information for this request. This value can be null. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
ArgumentOutOfRangeException |
|
InvalidOperationException | The focus has already been acquired. |
AudioPolicyException | Called in FocusStateChanged raised by releasing focus. |
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Declaration
C#Copypublic void AddDeviceForStreamRouting(AudioDevice device)
Parameters
Type | Name | Description |
---|---|---|
AudioDevice | device | The device to add. |
Remarks
The available AudioStreamType is Voip and MediaExternalOnly.
Exceptions
Type | Condition |
---|---|
InvalidOperationException | The device is not connected. |
ArgumentNullException |
|
AudioPolicyException | AudioStreamType of |
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Declaration
C#Copypublic void ApplyStreamRouting()
Remarks
If the stream has not been made yet, this will be applied when the stream starts to play.
Exceptions
Type | Condition |
---|---|
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Declaration
C#Copypublic void Dispose()
API Level: 3
Declaration
C#Copyprotected 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
ReleaseFocus(AudioStreamFocusOptions, AudioStreamBehaviors, String)
Releases the acquired focus.
Declaration
C#Copypublic void ReleaseFocus(AudioStreamFocusOptions options, AudioStreamBehaviors behaviors, string extraInfo)
Parameters
Type | Name | Description |
---|---|---|
AudioStreamFocusOptions | options | The focus mask that you want to release. |
AudioStreamBehaviors | behaviors | The requesting behaviors. |
System.String | extraInfo | The extra information for this request. This value can be null. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
ArgumentOutOfRangeException |
|
InvalidOperationException | The focus has not been acquired. |
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
API Level: 3
Declaration
C#Copypublic void RemoveDeviceForStreamRouting(AudioDevice device)
Parameters
Type | Name | Description |
---|---|---|
AudioDevice | device | The device to remove. |
Remarks
The available AudioStreamType is Voip and MediaExternalOnly.
Exceptions
Type | Condition |
---|---|
InvalidOperationException | An internal error occurs. |
ArgumentNullException |
|
ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
See Also
API Level: 3
Events
FocusStateChanged
Occurs when the state of focus that belongs to the current AudioStreamPolicy is changed.
Declaration
C#Copypublic event EventHandler<AudioStreamPolicyFocusStateChangedEventArgs> FocusStateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<AudioStreamPolicyFocusStateChangedEventArgs> |
Remarks
The event is raised in the internal thread.
API Level: 4
StreamFocusStateChanged
Occurs when the focus state for stream types is changed regardless of the process.
Declaration
C#Copypublic static event EventHandler<StreamFocusStateChangedEventArgs> StreamFocusStateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<StreamFocusStateChangedEventArgs> |