stopAudioPlayback

Stops the active audio-playback operation.

Declaration

public func stopAudioPlayback() -> STResult

Overview

Requests playback termination asynchronously. Do not assume audio has stopped when this method returns .success; wait for the corresponding playback stop/completion event.

Prerequisite

The audio-player component must be initialized.

Return value

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

Playback state changes and completion are reported through media events.

See Also

• STResult