Instance Method

stop

Stops playback and undoes the setup needed for playback.

Declaration

- (void)stop;

Discussion

Calling this method, or allowing a sound to finish playing, undoes the setup performed upon calling the play or prepareToPlay methods.

The stop method does not reset the value of the currentTime property to 0. In other words, if you call stop during playback and then call play, playback resumes at the point where it left off.

See Also

Configuring and Controlling Playback

- play

Plays a sound asynchronously.

- playAtTime:

Plays a sound asynchronously, starting at a specified point in the audio output device’s timeline.

- pause

Pauses playback; sound remains ready to resume playback from where it left off.

- prepareToPlay

Prepares the audio player for playback by preloading its buffers.

- setVolume:fadeDuration:

Fades to a new volume over a specific duration.

playing

A Boolean value that indicates whether the audio player is playing (YES) or not (NO).

volume

The playback volume for the audio player, ranging from 0.0 through 1.0 on a linear scale.

pan

The audio player’s stereo pan position.

rate

The audio player’s playback rate.

enableRate

A Boolean value that specifies whether playback rate adjustment is enabled for an audio player.

numberOfLoops

The number of times a sound will return to the beginning, upon reaching the end, to repeat playback.

delegate

The delegate object for the audio player.

AVAudioPlayerDelegate

A protocol that allows a delegate to respond to audio interruptions and audio decoding errors, and to the completion of a sound’s playback.

settings

The audio player’s settings dictionary, containing information about the sound associated with the player.