Class AudioDucking

    Definition

    Namespace:
    Tizen.Multimedia
    Assembly:
    Tizen.Multimedia.dll

    Provides the functionalities to control audio ducking.

    public sealed class AudioDucking : IDisposable
    Inheritance
    object
    AudioDucking

    Constructors

    View Source

    AudioDucking(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.

    See Also
    AudioManager

    Properties

    View Source

    IsDucked

    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.

    See Also
    AudioManager

    Methods

    View Source

    Activate(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.

    See Also
    AudioManager
    View Source

    Deactivate()

    Deactivate audio ducking

    Declaration
    public void Deactivate()
    Remarks

    To deactivate ducking, the specified privilege is required.

    See Also
    AudioManager
    View Source

    Dispose()

    Releases all resources used by the AudioDucking.

    Declaration
    public void Dispose()
    See Also
    AudioManager

    Events

    View Source

    DuckingStateChanged

    Occurs when the ducking state is changed.

    Declaration
    public event EventHandler<AudioDuckingStateChangedEventArgs> DuckingStateChanged
    Event Type
    Type Description
    EventHandler<><AudioDuckingStateChangedEventArgs>
    See Also
    AudioManager

    Extension Methods

    EXamlExtensions.LoadFromEXaml<T>(T, string)
    EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)
    EXamlExtensions.LoadFromEXamlPath<TXaml>(TXaml, string)
    EXamlExtensions.LoadFromEXamlPath<T>(T, Type)
    Extensions.LoadFromXaml<TXaml>(TXaml, string)
    Extensions.LoadFromXaml<TXaml>(TXaml, Type)
    Extensions.LoadFromXamlFile<TXaml>(TXaml, string)

    See Also

    AudioManager
    • View Source
    Back to top Copyright © 2016-2025 Samsung
    Generated by DocFX