AudioSession.AudioShouldDuck Property

Definition

Controls audio ducking for your application.

[ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.None, "AudioSession[Get|Set]Property are deprecated in iOS7")]
public static bool AudioShouldDuck { get; set; }
member this.AudioShouldDuck : bool with get, set

Property Value

Attributes

Remarks

When this property is set to true, if there is background music playing and you have configured this session to allow audio mixing, when your application produces sound, the background music volume is reduced. After you play your sound, you should reset the value to false.

By default, this property is set to false, and no audio ducking takes place.

If there is an error reading or setting the property, this will raise an AudioSessionException.

Applies to