crossmobile.ios.avfoundation

Class AVAudioPlayer

java.lang.Object

crossmobile.ios.foundation.NSObject

crossmobile.ios.avfoundation.AVAudioPlayer

public class AVAudioPlayer
extends NSObject

AVAudioPlayer class defines an object that represents the audio player of the application.

Method Summary

Modifier and Type	Method and Description
double	currentTime() Returns the current location of the playback of this AVAudioPlayer.
NSData	data() Returns an NSData object that represents the sound of the audio player.
AVAudioPlayerDelegate	delegate() Returns the delegate of this AVAudioPlayer.
double	duration() Returns the duration of the sound of this AVAudioPlayer expressed in seconds.
static AVAudioPlayer	initWithContentsOfURL(NSURL url, crossmobile.rt.StrongReference<NSError> error) Constructs and returns an AVAudioPlayer with the specified URL for the sound and error handing values.
static AVAudioPlayer	initWithData(NSData data, crossmobile.rt.StrongReference<NSError> error) Constructs and returns an AVAudioPlayer with the specified NSData and error handing values.
boolean	isPlaying() Returns a Boolean that shows whether this AVAudioPlayer is playing a sound.
int	numberOfChannels() Returns the number of audio channels of this AVAudioPlayer.
int	numberOfLoops() Returns the number of repeats of the audio of this AVAudioPlayer.
void	pause() Pauses the playback of this AVAudioPlayer.
boolean	play() Plays a sound.
boolean	playAtTime(double time) Plays a sound at a certain delay.
boolean	prepareToPlay() Prepares the buffers of this AVAudioPlayer for playing.
void	setCurrentTime(double currentTime) Sets the current location of the playback for this AVAudioPlayer.
void	setDelegate(AVAudioPlayerDelegate delegate) Sets the delegate for this AVAudioPlayer.
void	setNumberOfLoops(int numberOfLoops) Sets the number of repeats of the audio of this AVAudioPlayer.
void	setVolume(float volume) Sets the sound of this AVAudioPlayer.
void	stop() Stops the playback of this AVAudioPlayer.
NSURL	url() Returns the URL of the sound of this AVAudioPlayer.
float	volume() Returns a number that represents the sound of this AVAudioPlayer.

Methods inherited from class crossmobile.ios.foundation.NSObject

addObserver, observeValueForKeyPath, performSelector, performSelectorOnMainThread, release, removeObserver, removeObserver, retain, setValueForKey, setValueForUndefinedKey, valueForKey, valueForUndefinedKey

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initWithContentsOfURL

public static AVAudioPlayer initWithContentsOfURL(NSURL url,
                                                  crossmobile.rt.StrongReference<NSError> error)

Constructs and returns an AVAudioPlayer with the specified URL for the sound and error handing values.

Parameters:

url - The URL of the sound to play.

error - The error that occurs in case of failure.

initWithData

public static AVAudioPlayer initWithData(NSData data,
                                         crossmobile.rt.StrongReference<NSError> error)

Constructs and returns an AVAudioPlayer with the specified NSData and error handing values.

Parameters:

data - The data of the sound to play.

error - The error that occurs in case of failure.

play

public boolean play()

Plays a sound.

Returns:

TRUE if the operation was successfully completed.

playAtTime

public boolean playAtTime(double time)

Plays a sound at a certain delay.

Parameters:

time - The time to begin playback.

Returns:

TRUE if the operation was successfully completed.

stop

public void stop()

Stops the playback of this AVAudioPlayer.

pause

public void pause()

Pauses the playback of this AVAudioPlayer.

prepareToPlay

public boolean prepareToPlay()

Prepares the buffers of this AVAudioPlayer for playing.

Returns:

TRUE if the operation was successfully completed.

numberOfLoops

public int numberOfLoops()

Returns the number of repeats of the audio of this AVAudioPlayer.

Returns:

The number of repeats of the audio of this AVAudioPlayer.

setNumberOfLoops

public void setNumberOfLoops(int numberOfLoops)

Sets the number of repeats of the audio of this AVAudioPlayer.

Parameters:

numberOfLoops - The number of repeats of the audio of this AVAudioPlayer.

delegate

public AVAudioPlayerDelegate delegate()

Returns the delegate of this AVAudioPlayer.

Returns:

The delegate of this AVAudioPlayer.

setDelegate

public void setDelegate(AVAudioPlayerDelegate delegate)

Sets the delegate for this AVAudioPlayer.

Parameters:

delegate - The delegate for this AVAudioPlayer.

isPlaying

public boolean isPlaying()

Returns a Boolean that shows whether this AVAudioPlayer is playing a sound.

Returns:

TRUE then this AVAudioPlayer is playing a sound.

setCurrentTime

public void setCurrentTime(double currentTime)

Sets the current location of the playback for this AVAudioPlayer.

Parameters:

currentTime - The current location of the playback of this AVAudioPlayer.

currentTime

public double currentTime()

Returns the current location of the playback of this AVAudioPlayer.

Returns:

The current location of the playback of this AVAudioPlayer.

setVolume

public void setVolume(float volume)

Sets the sound of this AVAudioPlayer.

Parameters:

volume - The sound of this AVAudioPlayer.

volume

public float volume()

Returns a number that represents the sound of this AVAudioPlayer.

Returns:

A number that represents the sound of this AVAudioPlayer.

numberOfChannels

public int numberOfChannels()

Returns the number of audio channels of this AVAudioPlayer.

Returns:

The number of audio channels of this AVAudioPlayer.

duration

public double duration()

Returns the duration of the sound of this AVAudioPlayer expressed in seconds.

Returns:

The duration of the sound of this AVAudioPlayer expressed in seconds.

url

public NSURL url()

Returns the URL of the sound of this AVAudioPlayer.

Returns:

The URL of the sound of this AVAudioPlayer.

data

public NSData data()

Returns an NSData object that represents the sound of the audio player.

Returns:

NULL if the audio player has no audio data.