clearAudioPlaybackDuckVolume

Clears the temporary playback duck volume and returns playback toward its underlying volume.

Declaration

public func clearAudioPlaybackDuckVolume(
    fadeMs: Int = 0
) -> STResult

Overview

Ducking temporarily reduces audible playback without changing the normal playback-volume setting. Use setAudioPlaybackDuckVolume to apply the temporary reduction, then clearAudioPlaybackDuckVolume to remove it. A fadeMs value of 0 removes ducking immediately; a positive value requests a gradual restoration over that many milliseconds. Other active playback-volume adjustments may still affect the final audible level.

Parameters

fadeMs

The duration, in milliseconds, over which the ducking is removed.

Default: 0.

Return value

Returns .audioPlayerNotInitialized when the player is unavailable. Otherwise returns the result of clearing the duck volume.

See Also

• STResult