Class AudioStreamPolicy
Definition
- Namespace:
- Tizen.Multimedia
- Assembly:
- Tizen.Multimedia.dll
Provides the ability to control the sound stream.
public class AudioStreamPolicy : IDisposable
- Inheritance
-
objectAudioStreamPolicy
- Implements
-
System.IDisposable
Constructors
View SourceAudioStreamPolicy(AudioStreamType)
Initializes a new instance of the AudioStreamPolicy class with AudioStreamType.
Declaration
public 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 |
|
Properties
View SourceFocusReacquisitionEnabled
Gets or sets the auto focus reacquisition.
Declaration
public bool FocusReacquisitionEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool | 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 |
---|---|
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
PlaybackFocusState
Gets the state of focus for the playback.
Declaration
public AudioStreamFocusState PlaybackFocusState { get; }
Property Value
Type | Description |
---|---|
AudioStreamFocusState | The state of focus for playback. |
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
RecordingFocusState
Gets the state of focus for the recording.
Declaration
public AudioStreamFocusState RecordingFocusState { get; }
Property Value
Type | Description |
---|---|
AudioStreamFocusState | The state of focus for recording. |
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
VolumeType
Gets the AudioVolumeType.
Declaration
public 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 |
---|---|
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
Methods
View SourceAcquireFocus(AudioStreamFocusOptions, AudioStreamBehaviors, string)
Acquires the stream focus.
Declaration
public 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. |
string | extraInfo | The extra information for this request. This value can be null. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
System.ArgumentOutOfRangeException |
|
System.InvalidOperationException | The focus has already been acquired. |
AudioPolicyException | Called in FocusStateChanged raised by releasing focus. |
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
AddDeviceForStreamRouting(AudioDevice)
Adds a device for the stream routing.
Declaration
public 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 |
---|---|
System.InvalidOperationException | The device is not connected. |
System.ArgumentNullException |
|
AudioPolicyException | AudioStreamType of |
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
See Also
View SourceApplyStreamRouting()
Applies the stream routing.
Declaration
public void ApplyStreamRouting()
Remarks
If the stream has not been made yet, this will be applied when the stream starts to play.
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
See Also
View SourceDispose()
Releases all resources used by the AudioStreamPolicy.
Declaration
public void Dispose()
Dispose(bool)
Releases the unmanaged resources used by the AudioStreamPolicy.
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. |
ReleaseFocus(AudioStreamFocusOptions, AudioStreamBehaviors, string)
Releases the acquired focus.
Declaration
public 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. |
string | extraInfo | The extra information for this request. This value can be null. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
System.ArgumentOutOfRangeException |
|
System.InvalidOperationException | The focus has not been acquired. |
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
RemoveDeviceForStreamRouting(AudioDevice)
Removes the device for the stream routing.
Declaration
public 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 |
---|---|
System.InvalidOperationException | An internal error occurs. |
System.ArgumentNullException |
|
System.ObjectDisposedException | The AudioStreamPolicy has already been disposed of. |
See Also
Events
View SourceFocusStateChanged
Occurs when the state of focus that belongs to the current AudioStreamPolicy is changed.
Declaration
public event EventHandler<AudioStreamPolicyFocusStateChangedEventArgs> FocusStateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><AudioStreamPolicyFocusStateChangedEventArgs> |
Remarks
The event is raised in the internal thread.
StreamFocusStateChanged
Occurs when the focus state for stream types is changed regardless of the process.
Declaration
public static event EventHandler<StreamFocusStateChangedEventArgs> StreamFocusStateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><StreamFocusStateChangedEventArgs> |