Class AudioDucking
Definition
- Namespace:
- Tizen.Multimedia
- Assembly:
- Tizen.Multimedia.dll
Provides the functionalities to control audio ducking.
public sealed class AudioDucking : IDisposable
- Inheritance
-
objectAudioDucking
- Implements
-
System.IDisposable
Constructors
View SourceAudioDucking(AudioStreamType)
Initializes a new instance of the AudioDucking class with AudioStreamType.
Declaration
public AudioDucking(AudioStreamType targetType)
Parameters
Type | Name | Description |
---|---|---|
AudioStreamType | targetType | The type of sound stream affected by this new instance. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
System.InvalidOperationException | Operation failed; internal error. |
See Also
Properties
View SourceIsDucked
Gets the ducking state of the stream.
Declaration
public bool IsDucked { get; }
Property Value
Type | Description |
---|---|
bool | true if the audio stream is ducked; otherwise, false. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Operation failed; internal error. |
System.ObjectDisposedException | The AudioDucking has already been disposed of. |
See Also
Methods
View SourceActivate(uint, double)
Activate audio ducking
Declaration
public void Activate(uint duration, double ratio)
Parameters
Type | Name | Description |
---|---|---|
uint | duration | The duration for ducking in milliseconds. |
double | ratio | The volume ratio when ducked. |
Remarks
To activate ducking, the specified privilege is required.
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException |
|
System.InvalidOperationException | Operation failed; internal error. |
System.UnauthorizedAccessException | The caller does not have required privilege to set volume. |
System.ObjectDisposedException | The AudioDucking has already been disposed of. |
See Also
View SourceDeactivate()
Deactivate audio ducking
Declaration
public void Deactivate()
Remarks
To deactivate ducking, the specified privilege is required.
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Operation failed; internal error. |
System.UnauthorizedAccessException | The caller does not have required privilege to set volume. |
System.ObjectDisposedException | The AudioDucking has already been disposed of. |
See Also
View SourceDispose()
Releases all resources used by the AudioDucking.
Declaration
public void Dispose()
See Also
Events
View SourceDuckingStateChanged
Occurs when the ducking state is changed.
Declaration
public event EventHandler<AudioDuckingStateChangedEventArgs> DuckingStateChanged
Event Type
Type | Description |
---|---|
System.EventHandler<TEventArgs><AudioDuckingStateChangedEventArgs> |