TuneNet Arexx

From wiki.amiga.org
(Difference between revisions)
Jump to: navigation, search
(Created page with "<pre> TABLE OF CONTENTS arexx/AddTunes arexx/First arexx/GetBroadcast arexx/GetPlayListInfo arexx/GetRecord arexx/GetRecordFileName arexx/GetRepeat arexx/GetShuffle arexx/Ge...")
 
 
Line 1: Line 1:
<pre>
 
  
TABLE OF CONTENTS
+
= AddTunes =
  
arexx/AddTunes
+
;  NAME
arexx/First
+
: AddTunes - add 1 or more tunes to the playlist without playing.
arexx/GetBroadcast
+
arexx/GetPlayListInfo
+
arexx/GetRecord
+
arexx/GetRecordFileName
+
arexx/GetRepeat
+
arexx/GetShuffle
+
arexx/GetStatus
+
arexx/GetTuneInfo
+
arexx/GetVolume
+
arexx/Last
+
arexx/Mute
+
arexx/Next
+
arexx/NextSubTrack
+
arexx/Pause
+
arexx/Play
+
arexx/Previous
+
arexx/PreviousSubTrack
+
arexx/Quit
+
arexx/RemoveTune
+
arexx/Repeat
+
arexx/Seek
+
arexx/Stop
+
arexx/ToggleBroadcast
+
arexx/ToggleRecord
+
arexx/ToggleShuffle
+
arexx/Volume
+
  
arexx/AddTunes                                                arexx/AddTunes
 
 
  NAME
 
AddTunes - add 1 or more tunes to the playlist without playing.
 
  
 +
;  FORMAT
 +
: ADDTUNES NAMES/M/A
  
  FORMAT
 
ADDTUNES NAMES/M/A
 
  
 +
;  TEMPLATE
 +
: ADDTUNES  <name> [<name> ...]
  
  TEMPLATE
 
ADDTUNES  <name> [<name> ...]
 
  
  FUNCTION
+
FUNCTION
Adds a lits of tunes to the playlist, tunenames are space delimetered so
+
: Adds a lits of tunes to the playlist, tunenames are space delimetered so
any tune names with spaces must be quoted.  
+
: any tune names with spaces must be quoted.  
Playlists in the M3U format will be parsed and each file appended to the  
+
: Playlists in the M3U format will be parsed and each file appended to the  
current playlist.
+
: current playlist.
  
  
  
arexx/First                                                      arexx/First
+
= First =
 
 
  NAME
+
NAME
First - play the first song in the play list
+
: First - play the first song in the play list
  
  
  FORMAT
+
FORMAT
FIRST
+
: FIRST
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Plays the first song in the playlist.
+
: Plays the first song in the playlist.
  
  
  RESULT
+
RESULT
First song will play.
+
: First song will play.
 
 
RC = 0    => Succesfully started song.
+
: RC = 0    => Succesfully started song.
RC = 10    => No play started (perhaps no song available?)
+
: RC = 10    => No play started (perhaps no song available?)
RC = 15    => Hard Error.
+
: RC = 15    => Hard Error.
RC =  5    => Warning failed but retry might succede.  
+
: RC =  5    => Warning failed but retry might succede.  
  
  
  
arexx/GetBroadcast                                        arexx/GetBroadcast
+
= GetBroadcast =
 
 
  NAME
+
NAME
GetBroadcast
+
: GetBroadcast
  
  
  FORMAT
+
FORMAT
GETBROADCAST
+
: GETBROADCAST
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Retrieve the current broadcast status.
+
: Retrieve the current broadcast status.
The function will return the status in the result variable.
+
: The function will return the status in the result variable.
 
 
0 = Normal play
+
: 0 = Normal play
1 = Broadcasting
+
: 1 = Broadcasting
 
 
  
  
arexx/GetPlayListInfo                                  arexx/GetPlayListInfo
+
= GetPlayListInfo =
 
 
  NAME
+
NAME
GetPlayListInfo - retrieve information about the tunes in the playlist
+
: GetPlayListInfo - retrieve information about the tunes in the playlist
  
  
  FORMAT
+
FORMAT
GETPLAAYLISTTINFO [ <stem> ]
+
: GETPLAAYLISTTINFO [ <stem> ]
  
  
  TEMPLATE  
+
TEMPLATE  
GETPLAYLISTTINFO  STEM/K
+
: GETPLAYLISTTINFO  STEM/K
  
  FUNCTION
+
FUNCTION
Retrieves information about the playlist, if the stem variable is passed
+
: Retrieves information about the playlist, if the stem variable is passed
structured information about the tunes in the list is returned in the stem.
+
: structured information about the tunes in the list is returned in the stem.
If no present theen the simply the number of tunes in the list is returned.
+
: If no present theen the simply the number of tunes in the list is returned.
 
 
 
   
 
   
OPTIONS
+
; OPTIONS
NO OPTION
+
: NO OPTION
Return number of tunes in the list.
+
: Return number of tunes in the list.
STEM
+
: STEM
Specify a stem variable to write the TuneInfo into
+
: Specify a stem variable to write the TuneInfo into
The  list of attributes is placed under substem in the format
+
: The  list of attributes is placed under substem in the format
 
 
STEM.ATTRS.n.ATTR
+
: STEM.ATTRS.n.ATTR
STEM.ATTRS.0 gives the number of attributes
+
: STEM.ATTRS.0 gives the number of attributes
then STEM.ATTRS.n.ATTR gives the name of the attributes
+
: then STEM.ATTRS.n.ATTR gives the name of the attributes
then the attribute data is added to the main stem under each  
+
: then the attribute data is added to the main stem under each  
attribute name. See ggetTuneInfo for a list of supported
+
: attribute name. See ggetTuneInfo for a list of supported
attributes.
+
: attributes.
*
+
The number of tunes in the list is placed in STEM.0
+
: The number of tunes in the list is placed in STEM.0
Then the data for each tune is placed under STEM.n where n is
+
: Then the data for each tune is placed under STEM.n where n is
1 through to the number of tunes.
+
: 1 through to the number of tunes.
 
 
eg  
+
: eg  
STEM.3.FILENAME  
+
: STEM.3.FILENAME  
 
 
Some attributes will be blank until the file has been played.
+
: Some attributes will be blank until the file has been played.
  
  SEE ALSO
+
SEE ALSO
arx/GetTuneInfo
+
: GetTuneInfo
  
  
  
arexx/GetRecord                                              arexx/GetRecord
+
= GetRecord =
 
 
  NAME
+
NAME
GetRecord
+
: GetRecord
  
  
  FORMAT
+
FORMAT
GETRECORD
+
: GETRECORD
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Retrieve the current record status.
+
: Retrieve the current record status.
The function will return the status in the result variable.
+
: The function will return the status in the result variable.
 
 
0 = Normal play
+
: 0 = Normal play
1 = Recording
+
: 1 = Recording
 
 
  
  
arexx/GetRecordFileName                              arexx/GetRecordFileName
+
= GetRecordFileName =
 
 
  NAME
+
NAME
GetRecordFileName
+
: GetRecordFileName
  
  
  FORMAT
+
FORMAT
GETRECORDFILENAME
+
: GETRECORDFILENAME
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Retrieve the current record filename.
+
: Retrieve the current record filename.
The filename is returned in the result variable, or RC  is set to 5 if  
+
: The filename is returned in the result variable, or RC  is set to 5 if  
not available. It may not be available when not recording or if a  
+
: not available. It may not be available when not recording or if a  
record settings error has occured.
+
: record settings error has occured.
 
 
  
  
arexx/GetRepeat                                              arexx/GetRepeat
+
= GetRepeat =
 
 
  NAME
+
NAME
GetRepeat
+
: GetRepeat
  
  
  FORMAT
+
FORMAT
GETREPEAT
+
: GETREPEAT
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Retrieve the current repeat status.
+
: Retrieve the current repeat status.
The function will return the status in the result variable.
+
: The function will return the status in the result variable.
 
 
0 = Normal play
+
: 0 = Normal play
1 = Repeat song
+
: 1 = Repeat song
2 = Repeat playlist
+
: 2 = Repeat playlist
  
  
  
arexx/GetShuffle                                            arexx/GetShuffle
+
= GetShuffle =
 
 
  NAME
+
NAME
GetShuffle
+
: GetShuffle
  
  
  FORMAT
+
FORMAT
GETSHUFFLE
+
: GETSHUFFLE
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Retrieve the current shuffle status.
+
: Retrieve the current shuffle status.
The function will return the status in the result variable.
+
: The function will return the status in the result variable.
 
 
0 = Normal play
+
: 0 = Normal play
1 = Shufle enabled
+
: 1 = Shufle enabled
 
 
  
  
arexx/GetStatus                                              arexx/GetStatus
+
= GetStatus =
 
 
  NAME
+
NAME
GetStatus
+
: GetStatus
  
  
  FORMAT
+
FORMAT
GETSTATUS
+
: GETSTATUS
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Retrieve the current player status.
+
: Retrieve the current player status.
The function will return the status in the result variable.
+
: The function will return the status in the result variable.
 
 
0 = Stopped
+
: 0 = Stopped
1 = Playing
+
: 1 = Playing
2 = Paused
+
: 2 = Paused
 
 
Important Note: The Tunenet Player process may not always respond to
+
: Important Note: The Tunenet Player process may not always respond to
play / stop / pauses  requests instantly, so calling GETSTATUS immediatly
+
: play / stop / pauses  requests instantly, so calling GETSTATUS immediatly
after PLAY PAUSE STOP etc is not a good way to test success.  
+
: after PLAY PAUSE STOP etc is not a good way to test success.  
  
  
arexx/GetTuneInfo                                          arexx/GetTuneInfo
+
= GetTuneInfo =
 
 
  NAME
+
NAME
GetTuneInfo - retrieve information about the currently playing Tune
+
: GetTuneInfo - retrieve information about the currently playing Tune
  
  
  FORMAT
+
FORMAT
GETTUNEINFO <attr> | <stem>
+
: GETTUNEINFO <attr> | <stem>
  
  
  TEMPLATE  
+
TEMPLATE  
GETTUNEINFO  ATTR/K STEM/K
+
: GETTUNEINFO  ATTR/K STEM/K
  
  FUNCTION
+
FUNCTION
Retrieves information about the current Tune.
+
: Retrieves information about the current Tune.
  
 
   
 
   
OPTIONS
+
:      OPTIONS
ATTR
+
: ATTR
Retrieves a specific attribute and returns it in the result
+
: Retrieves a specific attribute and returns it in the result
variable.  
+
: variable.  
 
 
Attributes supported at time of writing include:
+
: Attributes supported at time of writing include:
 
 
FILENAME    Full path of file being played.
+
: FILENAME    Full path of file being played.
TUNENAME    Name of tune or filename part if unnamed.
+
: TUNENAME    Name of tune or filename part if unnamed.
ARTIST      Artist information
+
: ARTIST      Artist information
ALBUM
+
: ALBUM
POSITION Position in playlist
+
: POSITION Position in playlist
PLAYCOUNT Current playcount.
+
: PLAYCOUNT Current playcount.
GENRE ID3 Genre name
+
: GENRE ID3 Genre name
DURATION Tune duration
+
: DURATION Tune duration
SONGNUM Song track number  
+
: SONGNUM Song track number  
  
A complete list of attributes available mey be queried via the  
+
: A complete list of attributes available mey be queried via the  
STEM see below.
+
: STEM see below.
STEM
+
: STEM
Specify a stem variable to write the TuneInfo into
+
: Specify a stem variable to write the TuneInfo into
The  list of attributes is placed under substem in the format
+
: The  list of attributes is placed under substem in the format
 
 
STEM.ATTRS.n.ATTR
+
: STEM.ATTRS.n.ATTR
STEM.ATTRS.0 gives the number of attributes
+
: STEM.ATTRS.0 gives the number of attributes
then STEM.ATTRS.n.ATTR gives the name of the attributes
+
: then STEM.ATTRS.n.ATTR gives the name of the attributes
then the attribute data is added to the main stem under each  
+
: then the attribute data is added to the main stem under each  
attribute name
+
: attribute name
See Rexx/TuneInfo.rexx for example usage.
+
: See Rexx/TuneInfo.rexx for example usage.
  
  
arexx/GetVolume                                              arexx/GetVolume
+
= GetVolume =
 
 
  NAME
+
NAME
GetVolume - find the current playback volume
+
: GetVolume - find the current playback volume
  
  
  FORMAT
+
FORMAT
GETVOLUME
+
: GETVOLUME
  
  
  TEMPLATE  
+
TEMPLATE  
GETVOLUME  
+
: GETVOLUME  
  
  FUNCTION
+
FUNCTION
Gets the current playback volume
+
: Gets the current playback volume
  
  RESULT
+
RESULT
Resturns the current volume in RESULT as a percentage.
+
: Returns the current volume in RESULT as a percentage.
  
  
  
arexx/Last                                                        arexx/Last
+
= Last =
 
 
  NAME
+
NAME
Last - play the last song in the play list
+
: Last - play the last song in the play list
  
  
  FORMAT
+
FORMAT
LAST
+
: LAST
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Plays the last songg in the playlist.
+
: Plays the last songg in the playlist.
  
  
  RESULT
+
RESULT
First song will play.
+
: First song will play.
 
 
RC = 0    => Succesfully started song.
+
: RC = 0    => Succesfully started song.
RC = 10    => No play started (perhaps no song available?)
+
: RC = 10    => No play started (perhaps no song available?)
RC = 15    => Hard Error.
+
: RC = 15    => Hard Error.
RC =  5    => Warning failed but retry might succede.  
+
: RC =  5    => Warning failed but retry might succede.  
  
  
  
arexx/Mute                                                        arexx/Mute
+
= Mute =
 
 
  NAME
+
NAME
Mute - mute playback volume
+
: Mute - mute playback volume
  
  
  FORMAT
+
FORMAT
MUTE ON | OFF
+
: MUTE ON | OFF
  
  
  TEMPLATE  
+
TEMPLATE  
ON/S OFF/S
+
: ON/S OFF/S
  
  FUNCTION
+
FUNCTION
Mutes or unmutes the volume.
+
: Mutes or unmutes the volume.
MUTE ON sets the effective volume to 0
+
: MUTE ON sets the effective volume to 0
MUTE OFF sets the volume back to what it was before muting *or* if the
+
: MUTE OFF sets the volume back to what it was before muting *or* if the
volume has been chnaged whilst muted to the new volume.
+
: volume has been chnaged whilst muted to the new volume.
  
  
arexx/Next                                                        arexx/Next
+
= Next =
 
 
  NAME
+
NAME
Next - Advance to the next song in the play list.
+
: Next - Advance to the next song in the play list.
  
  
  FORMAT
+
FORMAT
NEXT
+
: NEXT
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Advances plsyback to the next song in the current list.
+
: Advances plsyback to the next song in the current list.
  
  
  RESULT
+
RESULT
Next song will plsy
+
: Next song will plsy
 
 
RC = 0    => Succesfully started song.
+
: RC = 0    => Succesfully started song.
RC = 10    => No play started (perhaps no song available?)
+
: RC = 10    => No play started (perhaps no song available?)
RC = 15    => Hard Error.
+
: RC = 15    => Hard Error.
RC =  5    => Warning failed but retry might succede.  
+
: RC =  5    => Warning failed but retry might succede.  
  
  
  
arexx/NextSubTrack                                        arexx/NextSubTrack
+
= NextSubTrack =
 
 
  NAME
+
NAME
NextSubTrack - Advance to the next subtrack
+
: NextSubTrack - Advance to the next subtrack
  
  
  FORMAT
+
FORMAT
NEXTSUBTRACK
+
: NEXTSUBTRACK
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Advances playback to the next subtrack in the current tune.
+
: Advances playback to the next subtrack in the current tune.
  
  
  
arexx/Pause                                                      arexx/Pause
+
= Pause =
 
 
  NAME
+
NAME
Pause - Pause playback
+
: Pause - Pause playback
  
  
  FORMAT
+
FORMAT
PAUSE
+
: PAUSE
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Pause  playback. Pause will toggle so if called again playback will
+
: Pause  playback. Pause will toggle so if called again playback will
resume from the same point as it stopped at..  
+
: resume from the same point as it stopped at..  
  
  
  RESULT
+
RESULT
Song will stop playing or resume playing if paused.
+
: Song will stop playing or resume playing if paused.
 
 
  
  
  
arexx/Play                                                        arexx/Play
+
= Play =
 
 
  NAME
+
NAME
Play - Play the current song
+
: Play - Play the current song
  
  
  FORMAT
+
FORMAT
PLAY
+
: PLAY
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
 
Start playing the current song.
 
Start playing the current song.
  
  
  RESULT
+
RESULT
Song will play or return an error via RC.
+
: Song will play or return an error via RC.
 
 
RC = 0    => Succesfully started song.
+
: RC = 0    => Succesfully started song.
RC = 10    => No play started (perhaps no song available?)
+
: RC = 10    => No play started (perhaps no song available?)
RC = 15    => Hard Error.
+
: RC = 15    => Hard Error.
RC =  5    => Warning failed but retry might succede.  
+
: RC =  5    => Warning failed but retry might succede.  
  
  
  
arexx/Previous                                                arexx/Previous
+
= Previous =
 
 
  NAME
+
NAME
Previous - move to the previous song in the play list.
+
: Previous - move to the previous song in the play list.
  
  
  FORMAT
+
FORMAT
PREVIOUS
+
: PREVIOUS
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Gooes back to the previous song in the current list.
+
: Gooes back to the previous song in the current list.
  
  
  RESULT
+
RESULT
Previous song wil play or return an error in RC
+
: Previous song wil play or return an error in RC
 
 
RC = 0    => Succesfully started song.
+
: RC = 0    => Succesfully started song.
RC = 10    => No play started (perhaps no song available?)
+
: RC = 10    => No play started (perhaps no song available?)
RC = 15    => Hard Error.
+
: RC = 15    => Hard Error.
RC =  5    => Warning failed but retry might succede.  
+
: RC =  5    => Warning failed but retry might succede.  
  
  
  
arexx/PreviousSubTrack                                arexx/PreviousSubTrack
+
= PreviousSubTrack =
 
 
  NAME
+
NAME
PreviousSubTrack - move to the previous subtrck in the current tune
+
: PreviousSubTrack - move to the previous subtrck in the current tune
  
  
  FORMAT
+
FORMAT
PREVIOUSSUBTRACK
+
: PREVIOUSSUBTRACK
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Gooes back to the previous subtrack in the current tune
+
: Goes back to the previous subtrack in the current tune
  
  
  
  
arexx/Quit                                                        arexx/Quit
+
= Quit =
 
 
  NAME
+
NAME
Quit - Quit TuneNet
+
: Quit - Quit TuneNet
  
  
  FORMAT
+
FORMAT
Quit
+
: Quit
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Causes program to quit as if the close button had been pressed.
+
: Causes program to quit as if the close button had been pressed.
  
  
  
arexx/RemoveTune                                            arexx/RemoveTune
+
= RemoveTune =
 
 
  NAME
+
NAME
RemoveTune - remove a tune from the playlist.
+
: RemoveTune - remove a tune from the playlist.
  
  
  FORMAT
+
FORMAT
REMOVETUNE [ <index> ]
+
: REMOVETUNE [ <index> ]
  
  
  TEMPLATE  
+
TEMPLATE  
REMOVETUNE INDEX/N
+
: REMOVETUNE INDEX/N
  
  FUNCTION
+
FUNCTION
Removes a tune from the playlist. If no index is provided the currently
+
: Removes a tune from the playlist. If no index is provided the currently
selected  tune is removed. If an index is provided the tune at that  
+
: selected  tune is removed. If an index is provided the tune at that  
position in the playlist is removed.
+
: position in the playlist is removed.
After the tune is removed the playlist is renumbered.
+
: After the tune is removed the playlist is renumbered.
 
 
NB: If the tune removed from the playlist is playing then it will continue
+
: NB: If the tune removed from the playlist is playing then it will continue
to play untill finished or the STOP command is sent.
+
: to play untill finished or the STOP command is sent.
  
  
  
  
arexx/Repeat                                                    arexx/Repeat
+
= Repeat =
 
 
  NAME
+
NAME
Repeat - set the repeat mode.
+
: Repeat - set the repeat mode.
  
  
  FORMAT
+
FORMAT
REPEAT ON | OFF | PLAYLIST
+
: REPEAT ON | OFF | PLAYLIST
  
  
  TEMPLATE  
+
TEMPLATE  
ON/S,OFF/S,PLAYLIST/S
+
: ON/S,OFF/S,PLAYLIST/S
  
  FUNCTION
+
FUNCTION
Sets how repeat is handled or switches  it off.  
+
: Sets how repeat is handled or switches  it off.  
  
  
  
arexx/Seek                                                        arexx/Seek
+
= Seek =
 
 
  NAME
+
NAME
Seek - move the play position to the new time.
+
: Seek - move the play position to the new time.
  
  
  FORMAT
+
FORMAT
SEEK    [ <time> ]  
+
: SEEK    [ <time> ]  
  
  
  TEMPLATE  
+
TEMPLATE  
SEEK TIME/K/N
+
: SEEK TIME/K/N
  
  FUNCTION
+
FUNCTION
Advance or rewind playback to the new time.  
+
: Advance or rewind playback to the new time.  
If no time is passed it will return the current time offset in RESULT
+
:If no time is passed it will return the current time offset in RESULT
  
  
  
  
arexx/Stop                                                        arexx/Stop
+
= Stop =
 
 
  NAME
+
NAME
Stop - Stop playback
+
: Stop - Stop playback
  
  
  FORMAT
+
FORMAT
STOP
+
: STOP
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Stop  playback. If restarted the song will play from the beginning.
+
: Stop  playback. If restarted the song will play from the beginning.
  
  
  RESULT
+
RESULT
Song will stop playing.
+
: Song will stop playing.
 
 
  
  
  
arexx/ToggleBroadcast                                  arexx/ToggleBroadcast
+
= ToggleBroadcast =
 
 
  NAME
+
NAME
ToggleBroadcast - Toggle the broadcast mode
+
: ToggleBroadcast - Toggle the broadcast mode
  
  
  FORMAT
+
FORMAT
TOGGLEBROADCAST
+
: TOGGLEBROADCAST
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Toggles the broadcast state.
+
: Toggles the broadcast state.
  
  
  RESULT
+
RESULT
Request TuneNet to start broadcasting, success depends on correct settings.
+
: Request TuneNet to start broadcasting, success depends on correct settings.
 
 
  
  
  
arexx/ToggleRecord                                        arexx/ToggleRecord
+
= ToggleRecord =
 
 
  NAME
+
NAME
ToggleRecord - Toggle the record mode.
+
: ToggleRecord - Toggle the record mode.
  
  
  FORMAT
+
FORMAT
TOGGLERECORD
+
: TOGGLERECORD
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Toggles the record mode on or off.
+
: Toggles the record mode on or off.
  
  
Line 668: Line 637:
  
  
arexx/ToggleShuffle                                      arexx/ToggleShuffle
+
= ToggleShuffle =
 
 
  NAME
+
NAME
ToggleShuffle - Toggle the ahuffle playback mode
+
: ToggleShuffle - Toggle the ahuffle playback mode
  
  
  FORMAT
+
FORMAT
TOGGLESHUFFLE
+
: TOGGLESHUFFLE
  
  
  TEMPLATE  
+
TEMPLATE  
  
  
  FUNCTION
+
FUNCTION
Toggles the "shuffle" playback mode on or off.
+
: Toggles the "shuffle" playback mode on or off.
  
  
  RESULT
+
RESULT
When shuffle is on playlist will advance in random order.
+
: When shuffle is on playlist will advance in random order.
 
 
  
  
  
arexx/Volume                                                    arexx/Volume
+
= Volume =
 
 
  NAME
+
NAME
Volume - set the playback volume.
+
: Volume - set the playback volume.
 
+
 
+
  FORMAT
+
VOLUME <volume>
+
 
+
 
+
  TEMPLATE
+
VOLUME VOLUME/N
+
  
  FUNCTION
 
Sets the current playback volume
 
  
 +
;  FORMAT
 +
: VOLUME <volume>
  
  
 +
;  TEMPLATE
 +
: VOLUME VOLUME/N
  
</pre>
+
;  FUNCTION
 +
: Sets the current playback volume

Latest revision as of 20:24, 11 August 2016

Contents

[edit] AddTunes

NAME
AddTunes - add 1 or more tunes to the playlist without playing.


FORMAT
ADDTUNES NAMES/M/A


TEMPLATE
ADDTUNES <name> [<name> ...]


FUNCTION
Adds a lits of tunes to the playlist, tunenames are space delimetered so
any tune names with spaces must be quoted.
Playlists in the M3U format will be parsed and each file appended to the
current playlist.


[edit] First

NAME
First - play the first song in the play list


FORMAT
FIRST


TEMPLATE


FUNCTION
Plays the first song in the playlist.


RESULT
First song will play.
RC = 0 => Succesfully started song.
RC = 10 => No play started (perhaps no song available?)
RC = 15 => Hard Error.
RC = 5 => Warning failed but retry might succede.


[edit] GetBroadcast

NAME
GetBroadcast


FORMAT
GETBROADCAST


TEMPLATE


FUNCTION
Retrieve the current broadcast status.
The function will return the status in the result variable.
0 = Normal play
1 = Broadcasting


[edit] GetPlayListInfo

NAME
GetPlayListInfo - retrieve information about the tunes in the playlist


FORMAT
GETPLAAYLISTTINFO [ <stem> ]


TEMPLATE
GETPLAYLISTTINFO STEM/K
FUNCTION
Retrieves information about the playlist, if the stem variable is passed
structured information about the tunes in the list is returned in the stem.
If no present theen the simply the number of tunes in the list is returned.


OPTIONS
NO OPTION
Return number of tunes in the list.
STEM
Specify a stem variable to write the TuneInfo into
The list of attributes is placed under substem in the format
STEM.ATTRS.n.ATTR
STEM.ATTRS.0 gives the number of attributes
then STEM.ATTRS.n.ATTR gives the name of the attributes
then the attribute data is added to the main stem under each
attribute name. See ggetTuneInfo for a list of supported
attributes.
The number of tunes in the list is placed in STEM.0
Then the data for each tune is placed under STEM.n where n is
1 through to the number of tunes.
eg
STEM.3.FILENAME
Some attributes will be blank until the file has been played.
SEE ALSO
GetTuneInfo


[edit] GetRecord

NAME
GetRecord


FORMAT
GETRECORD


TEMPLATE


FUNCTION
Retrieve the current record status.
The function will return the status in the result variable.
0 = Normal play
1 = Recording


[edit] GetRecordFileName

NAME
GetRecordFileName


FORMAT
GETRECORDFILENAME


TEMPLATE


FUNCTION
Retrieve the current record filename.
The filename is returned in the result variable, or RC is set to 5 if
not available. It may not be available when not recording or if a
record settings error has occured.


[edit] GetRepeat

NAME
GetRepeat


FORMAT
GETREPEAT


TEMPLATE


FUNCTION
Retrieve the current repeat status.
The function will return the status in the result variable.
0 = Normal play
1 = Repeat song
2 = Repeat playlist


[edit] GetShuffle

NAME
GetShuffle


FORMAT
GETSHUFFLE


TEMPLATE


FUNCTION
Retrieve the current shuffle status.
The function will return the status in the result variable.
0 = Normal play
1 = Shufle enabled


[edit] GetStatus

NAME
GetStatus


FORMAT
GETSTATUS


TEMPLATE


FUNCTION
Retrieve the current player status.
The function will return the status in the result variable.
0 = Stopped
1 = Playing
2 = Paused
Important Note: The Tunenet Player process may not always respond to
play / stop / pauses requests instantly, so calling GETSTATUS immediatly
after PLAY PAUSE STOP etc is not a good way to test success.


[edit] GetTuneInfo

NAME
GetTuneInfo - retrieve information about the currently playing Tune


FORMAT
GETTUNEINFO <attr> | <stem>


TEMPLATE
GETTUNEINFO ATTR/K STEM/K
FUNCTION
Retrieves information about the current Tune.


OPTIONS
ATTR
Retrieves a specific attribute and returns it in the result
variable.
Attributes supported at time of writing include:
FILENAME Full path of file being played.
TUNENAME Name of tune or filename part if unnamed.
ARTIST Artist information
ALBUM
POSITION Position in playlist
PLAYCOUNT Current playcount.
GENRE ID3 Genre name
DURATION Tune duration
SONGNUM Song track number
A complete list of attributes available mey be queried via the
STEM see below.
STEM
Specify a stem variable to write the TuneInfo into
The list of attributes is placed under substem in the format
STEM.ATTRS.n.ATTR
STEM.ATTRS.0 gives the number of attributes
then STEM.ATTRS.n.ATTR gives the name of the attributes
then the attribute data is added to the main stem under each
attribute name
See Rexx/TuneInfo.rexx for example usage.


[edit] GetVolume

NAME
GetVolume - find the current playback volume


FORMAT
GETVOLUME


TEMPLATE
GETVOLUME
FUNCTION
Gets the current playback volume
RESULT
Returns the current volume in RESULT as a percentage.


[edit] Last

NAME
Last - play the last song in the play list


FORMAT
LAST


TEMPLATE


FUNCTION
Plays the last songg in the playlist.


RESULT
First song will play.
RC = 0 => Succesfully started song.
RC = 10 => No play started (perhaps no song available?)
RC = 15 => Hard Error.
RC = 5 => Warning failed but retry might succede.


[edit] Mute

NAME
Mute - mute playback volume


FORMAT
MUTE ON | OFF


TEMPLATE
ON/S OFF/S
FUNCTION
Mutes or unmutes the volume.
MUTE ON sets the effective volume to 0
MUTE OFF sets the volume back to what it was before muting *or* if the
volume has been chnaged whilst muted to the new volume.


[edit] Next

NAME
Next - Advance to the next song in the play list.


FORMAT
NEXT


TEMPLATE


FUNCTION
Advances plsyback to the next song in the current list.


RESULT
Next song will plsy
RC = 0 => Succesfully started song.
RC = 10 => No play started (perhaps no song available?)
RC = 15 => Hard Error.
RC = 5 => Warning failed but retry might succede.


[edit] NextSubTrack

NAME
NextSubTrack - Advance to the next subtrack


FORMAT
NEXTSUBTRACK


TEMPLATE


FUNCTION
Advances playback to the next subtrack in the current tune.


[edit] Pause

NAME
Pause - Pause playback


FORMAT
PAUSE


TEMPLATE


FUNCTION
Pause playback. Pause will toggle so if called again playback will
resume from the same point as it stopped at..


RESULT
Song will stop playing or resume playing if paused.



[edit] Play

NAME
Play - Play the current song


FORMAT
PLAY


TEMPLATE


FUNCTION

Start playing the current song.


RESULT
Song will play or return an error via RC.
RC = 0 => Succesfully started song.
RC = 10 => No play started (perhaps no song available?)
RC = 15 => Hard Error.
RC = 5 => Warning failed but retry might succede.


[edit] Previous

NAME
Previous - move to the previous song in the play list.


FORMAT
PREVIOUS


TEMPLATE


FUNCTION
Gooes back to the previous song in the current list.


RESULT
Previous song wil play or return an error in RC
RC = 0 => Succesfully started song.
RC = 10 => No play started (perhaps no song available?)
RC = 15 => Hard Error.
RC = 5 => Warning failed but retry might succede.


[edit] PreviousSubTrack

NAME
PreviousSubTrack - move to the previous subtrck in the current tune


FORMAT
PREVIOUSSUBTRACK


TEMPLATE


FUNCTION
Goes back to the previous subtrack in the current tune



[edit] Quit

NAME
Quit - Quit TuneNet


FORMAT
Quit


TEMPLATE


FUNCTION
Causes program to quit as if the close button had been pressed.


[edit] RemoveTune

NAME
RemoveTune - remove a tune from the playlist.


FORMAT
REMOVETUNE [ <index> ]


TEMPLATE
REMOVETUNE INDEX/N
FUNCTION
Removes a tune from the playlist. If no index is provided the currently
selected tune is removed. If an index is provided the tune at that
position in the playlist is removed.
After the tune is removed the playlist is renumbered.
NB: If the tune removed from the playlist is playing then it will continue
to play untill finished or the STOP command is sent.



[edit] Repeat

NAME
Repeat - set the repeat mode.


FORMAT
REPEAT ON | OFF | PLAYLIST


TEMPLATE
ON/S,OFF/S,PLAYLIST/S
FUNCTION
Sets how repeat is handled or switches it off.


[edit] Seek

NAME
Seek - move the play position to the new time.


FORMAT
SEEK [ <time> ]


TEMPLATE
SEEK TIME/K/N
FUNCTION
Advance or rewind playback to the new time.
If no time is passed it will return the current time offset in RESULT



[edit] Stop

NAME
Stop - Stop playback


FORMAT
STOP


TEMPLATE


FUNCTION
Stop playback. If restarted the song will play from the beginning.


RESULT
Song will stop playing.



[edit] ToggleBroadcast

NAME
ToggleBroadcast - Toggle the broadcast mode


FORMAT
TOGGLEBROADCAST


TEMPLATE


FUNCTION
Toggles the broadcast state.


RESULT
Request TuneNet to start broadcasting, success depends on correct settings.



[edit] ToggleRecord

NAME
ToggleRecord - Toggle the record mode.


FORMAT
TOGGLERECORD


TEMPLATE


FUNCTION
Toggles the record mode on or off.



[edit] ToggleShuffle

NAME
ToggleShuffle - Toggle the ahuffle playback mode


FORMAT
TOGGLESHUFFLE


TEMPLATE


FUNCTION
Toggles the "shuffle" playback mode on or off.


RESULT
When shuffle is on playlist will advance in random order.



[edit] Volume

NAME
Volume - set the playback volume.


FORMAT
VOLUME <volume>


TEMPLATE
VOLUME VOLUME/N
FUNCTION
Sets the current playback volume
Personal tools
Namespaces

Variants
Actions
Navigation
Tools