Package com.tagtraum.audiokern.player

Class AVPlayer

java.lang.Object

com.tagtraum.audiokern.player.AVPlayer

All Implemented Interfaces:

AudioPlayer

public class AVPlayer
extends Object
implements AudioPlayer

AVFoundation-based AudioPlayer. Available on 64-bit macOS > 10.7.

Author:

Hendrik Schreiber

See Also:

isSupported()

Constructor Summary

Constructors

Constructor	Description
AVPlayer()
AVPlayer(ExecutorService serializer)

Method Summary

Modifier and Type	Method	Description
void	addAudioPlayerListener(AudioPlayerListener listener)
void	addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener propertyChangeListener)
void	close()	Closes the audio file and associated player resources.
void	fastForward()	Plays the file forward at accelerated speed.
protected void	finalize()
AudioDevice	getAudioDevice()	Current audio device.
long	getDuration()	Duration of the song in ms.
float	getPreGain()
ReplayGain.Type	getReplayGainType()	Currently configured type of replay gain.
AudioSong	getSong()	Returns the currently opened song.
com.tagtraum.audiokern.player.AVPlayer.AVPlayerStatus	getStatus()
long	getTime()	Returns the current time in ms.
com.tagtraum.audiokern.player.AVPlayer.AVPlayerTimeControlStatus	getTimeControlStatus()
float	getVolume()	Returns the volume.
boolean	isDone()	True, if the song was played to the end.
boolean	isMuted()	Indicates whether the player is muted.
boolean	isPaused()	Indicates whether the song is currently playing.
static boolean	isSupported()	Indicates, whether an AVFoundation player is available.
boolean	isVolumeNormalizationEnabled()
void	open(AudioSong song)	Opens a song.
void	pause()	Stops playback.
void	play()	Starts playback.
void	playPause()	Starts playback, if song is paused, otherwise pauses playback.
void	removeAudioPlayerListener(AudioPlayerListener listener)
void	removePropertyChangeListener(PropertyChangeListener propertyChangeListener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener propertyChangeListener)
void	reset()	Positions the player at the beginning of the file.
void	setAudioDevice(AudioDevice audioDevice)	Sets the desired audio device.
void	setMuted(boolean muted)	Un/mutes this player.
void	setPreGain(float preGain)
void	setReplayGainType(ReplayGain.Type type)	Asks the player to respect the given kind of replay gain.
void	setTime(long time)	Sets the current time in ms.
void	setVolume(float volume)	Changes the volume.
void	setVolumeNormalizationEnabled(boolean volumeNormalizationEnabled)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AVPlayer

public AVPlayer()
         throws UnsupportedOperationException

Throws:

UnsupportedOperationException - if the player is not supported by the native platform

See Also:

isSupported()

AVPlayer

public AVPlayer(ExecutorService serializer)
         throws UnsupportedOperationException

Throws:

UnsupportedOperationException - if the player is not supported by the native platform

See Also:

isSupported()

Method Detail

isSupported

public static boolean isSupported()

Indicates, whether an AVFoundation player is available.

Returns:

true or false

setAudioDevice

public void setAudioDevice(AudioDevice audioDevice)
                    throws IllegalArgumentException

Description copied from interface: AudioPlayer

Sets the desired audio device.

Specified by:

setAudioDevice in interface AudioPlayer

Parameters:

audioDevice - audio device

Throws:

IllegalArgumentException - if the device is not supported

getAudioDevice

public AudioDevice getAudioDevice()

Description copied from interface: AudioPlayer

Current audio device.

Specified by:

getAudioDevice in interface AudioPlayer

Returns:

currently used audio device

getSong

public AudioSong getSong()

Description copied from interface: AudioPlayer

Returns the currently opened song.

Specified by:

getSong in interface AudioPlayer

Returns:

currently opened song

open

public void open(AudioSong song)
          throws IOException

Description copied from interface: AudioPlayer

Opens a song.
Calling this method with null as argument has the same effect as calling AudioPlayer.close().

Specified by:

open in interface AudioPlayer

Parameters:

song - song

Throws:

IOException - if the song cannot be opened

play

public void play()

Description copied from interface: AudioPlayer

Starts playback.

Specified by:

play in interface AudioPlayer

pause

public void pause()

Description copied from interface: AudioPlayer

Stops playback.

Specified by:

pause in interface AudioPlayer

reset

public void reset()

Description copied from interface: AudioPlayer

Positions the player at the beginning of the file. Equivalent to calling AudioPlayer.setTime(long) with 0 as argument.

Specified by:

reset in interface AudioPlayer

See Also:

AudioPlayer.setTime(long)

fastForward

public void fastForward()

Description copied from interface: AudioPlayer

Plays the file forward at accelerated speed.

Specified by:

fastForward in interface AudioPlayer

getTime

public long getTime()

Description copied from interface: AudioPlayer

Returns the current time in ms.

Specified by:

getTime in interface AudioPlayer

Returns:

current time in ms

setTime

public void setTime(long time)

Description copied from interface: AudioPlayer

Sets the current time in ms.

Specified by:

setTime in interface AudioPlayer

Parameters:

time - time in ms

See Also:

AudioPlayer.reset(), AudioPlayer.getDuration()

getDuration

public long getDuration()

Description copied from interface: AudioPlayer

Duration of the song in ms.

Specified by:

getDuration in interface AudioPlayer

Returns:

the overall duration of the song in ms.

getVolume

public float getVolume()

Description copied from interface: AudioPlayer

Returns the volume.

Specified by:

getVolume in interface AudioPlayer

Returns:

value between -1 and 1, negative values equating to silence

setVolume

public void setVolume(float volume)

Description copied from interface: AudioPlayer

Changes the volume.

Specified by:

setVolume in interface AudioPlayer

Parameters:

volume - value between -1 and 1, negative values equating to silence. A volume value outside the valid range will lead to an IllegalArgumentException

getPreGain

public float getPreGain()

setPreGain

public void setPreGain(float preGain)

isVolumeNormalizationEnabled

public boolean isVolumeNormalizationEnabled()

setVolumeNormalizationEnabled

public void setVolumeNormalizationEnabled(boolean volumeNormalizationEnabled)

isDone

public boolean isDone()

Description copied from interface: AudioPlayer

True, if the song was played to the end.

Specified by:

isDone in interface AudioPlayer

Returns:

true if the song was played to the end.

isMuted

public boolean isMuted()

Description copied from interface: AudioPlayer

Indicates whether the player is muted.

Specified by:

isMuted in interface AudioPlayer

Returns:

true to false

setMuted

public void setMuted(boolean muted)

Description copied from interface: AudioPlayer

Un/mutes this player.

Specified by:

setMuted in interface AudioPlayer

Parameters:

muted - muted

setReplayGainType

public void setReplayGainType(ReplayGain.Type type)

Description copied from interface: AudioPlayer

Asks the player to respect the given kind of replay gain. Some players may ignore this property.

Specified by:

setReplayGainType in interface AudioPlayer

Parameters:

type - type

getReplayGainType

public ReplayGain.Type getReplayGainType()

Description copied from interface: AudioPlayer

Currently configured type of replay gain.

Specified by:

getReplayGainType in interface AudioPlayer

Returns:

replay gain type

isPaused

public boolean isPaused()

Description copied from interface: AudioPlayer

Indicates whether the song is currently playing.

Specified by:

isPaused in interface AudioPlayer

Returns:

false if the song is playing

playPause

public void playPause()

Description copied from interface: AudioPlayer

Starts playback, if song is paused, otherwise pauses playback.

Specified by:

playPause in interface AudioPlayer

close

public void close()

Description copied from interface: AudioPlayer

Closes the audio file and associated player resources.

Specified by:

close in interface AudioPlayer

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener propertyChangeListener)

Specified by:

addPropertyChangeListener in interface AudioPlayer

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener propertyChangeListener)

Specified by:

removePropertyChangeListener in interface AudioPlayer

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener propertyChangeListener)

Specified by:

addPropertyChangeListener in interface AudioPlayer

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener propertyChangeListener)

Specified by:

removePropertyChangeListener in interface AudioPlayer

addAudioPlayerListener

public void addAudioPlayerListener(AudioPlayerListener listener)

Specified by:

addAudioPlayerListener in interface AudioPlayer

removeAudioPlayerListener

public void removeAudioPlayerListener(AudioPlayerListener listener)

Specified by:

removeAudioPlayerListener in interface AudioPlayer

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object

getStatus

public com.tagtraum.audiokern.player.AVPlayer.AVPlayerStatus getStatus()

getTimeControlStatus

public com.tagtraum.audiokern.player.AVPlayer.AVPlayerTimeControlStatus getTimeControlStatus()