pauseAudioPlayback

Pauses the active audio-playback operation.

Declaration

public func pauseAudioPlayback() -> STResult

Overview

Requests a pause of active playback asynchronously. Returning .success means the pause request was accepted, not that playback has already paused. Observe the playback event .paused to confirm completion.

Prerequisite

The audio-player component must be initialized.

Return value

Returns .audioPlayerNotInitialized when the player is unavailable. Otherwise returns the result of the pause request.

See Also

• STResult