|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectamip.api.highlevel.Player
public class Player
Interface to the player, allows to control the playback and get info about state and modes. For more advanced
functions and variables, consider using Client.execute(String)
and Client.evaluate(String)
.
Field Summary | |
---|---|
static int |
STATUS_PAUSED
|
static int |
STATUS_PLAYING
|
static int |
STATUS_STOPPED
|
Method Summary | |
---|---|
void |
fastForward()
5 seconds forward. |
java.lang.String |
getAMIPVersion()
Gets AMIP version string. |
int |
getListPosition()
Gets position in the playlist, zero based. |
java.lang.String |
getName()
Gets player name string. |
int |
getSongLength()
Gets current song length. |
int |
getStatus()
Returns player status. |
java.lang.String |
getVersion()
Gets player version string. |
boolean |
isRepeat()
Returns current repeat mode. |
boolean |
isShuffle()
Returns current shuffle state. |
void |
jump(int time)
Jumps to specified time from the beginning of the current song. |
void |
minimizeWindow()
Minimizes player window (Winamp only at the moment). |
void |
next()
Moves to the next song in the playlist (if shuffle is enabled, then moves to the random song). |
void |
pause()
Toggles pause. |
void |
play()
Starts plating if player was paused or stopped, otherwise plays the song from the beginning. |
void |
play(int i)
Plays song with zero based index. |
void |
previous()
Moves to the previous song in the playlist. |
void |
restoreWindow()
Restores player window (Winamp only at the moment). |
void |
rewind()
Rewind 5 seconds. |
void |
setRepeat(boolean repeat)
Controls repeat mode. |
void |
setShuffle(boolean shuffle)
Allows to control shuffle mode. |
void |
setVolume(int volume)
Sets player volume. |
void |
showAMIPHelp()
Opens AMIP help. |
void |
showAMIPOptions()
Displays AMIP options (native dialog in case AMIP Configurator is not installed or runs AMIP Configurator if CFG_JCONFIG in plugin.ini is set to 1). |
void |
showAMIPSearch()
Opens AMIP Search/Jump dialog. |
void |
stop()
Stops the player. |
void |
volumeDown()
|
void |
volumeUp()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int STATUS_PLAYING
public static final int STATUS_PAUSED
public static final int STATUS_STOPPED
Method Detail |
---|
public void play() throws GeneralClientException
GeneralClientException
public void play(int i) throws GeneralClientException
i
- song index, zero based.
GeneralClientException
public void pause() throws GeneralClientException
GeneralClientException
public void stop() throws GeneralClientException
GeneralClientException
public void next() throws GeneralClientException
GeneralClientException
public void previous() throws GeneralClientException
GeneralClientException
public void setVolume(int volume) throws GeneralClientException
volume
- 0-255
GeneralClientException
public void volumeUp() throws GeneralClientException
GeneralClientException
public void volumeDown() throws GeneralClientException
GeneralClientException
public void fastForward() throws GeneralClientException
GeneralClientException
public void rewind() throws GeneralClientException
GeneralClientException
public void jump(int time) throws GeneralClientException
time
- jump time in seconds.
GeneralClientException
public void minimizeWindow() throws GeneralClientException
GeneralClientException
public void restoreWindow() throws GeneralClientException
GeneralClientException
public void setShuffle(boolean shuffle) throws GeneralClientException
shuffle
- true to enable, false to disable.
GeneralClientException
public boolean isShuffle() throws GeneralClientException
GeneralClientException
public void setRepeat(boolean repeat) throws GeneralClientException
repeat
- true or false.
GeneralClientException
public boolean isRepeat() throws GeneralClientException
GeneralClientException
public void showAMIPOptions() throws GeneralClientException
GeneralClientException
public void showAMIPSearch() throws GeneralClientException
GeneralClientException
public void showAMIPHelp() throws GeneralClientException
GeneralClientException
public int getListPosition() throws GeneralClientException
GeneralClientException
public int getSongLength() throws GeneralClientException
GeneralClientException
public java.lang.String getVersion() throws GeneralClientException
GeneralClientException
public java.lang.String getName() throws GeneralClientException
GeneralClientException
public java.lang.String getAMIPVersion() throws GeneralClientException
GeneralClientException
public int getStatus() throws GeneralClientException
GeneralClientException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |