Project

General

Profile

$play » History » Revision 7

Revision 6 (Per Amundsen, 07/09/2018 12:26 AM) → Revision 7/8 (Per Amundsen, 07/11/2019 06:26 PM)

_Added in 3.2_ 

 *$play([nick|channel,]N)* 

 Returns information about the [[/play]] queue. 

 _See also [[/play]], [[$filename]], [[$pnick]], [[on PLAYEND]]._ [[$pnick]]._ 

 *Parameters* 

 nick|channel - The nick or channel where the file is playing. 
 N - If N = 0, number of playing files, otherwise the Nth playing file. 

 *Properties* 

  type - Returns the type of the request, "topic" if you are using /play -t, otherwise "file". 
 .fname - Returns the complete filename used for the play request. 
 .topic - Returns the name of the topic if you used /play -t. 
 .pos - Returns the number of the line that play request is at, (the next line to be played). 
 .lines - Returns the total number of lines in the file being played. 
 .delay - Returns the delay used for the play request (default to 1000). 
 .status - Returns the status of the play request, "playing" or "queued". 

 *Example* 

 <pre> 
 ; Print the filename of the current playing file. 
 //echo -ag $play(1).fname 

 ; Print the filename of first queued file matching channel '#chan'. 
 //echo -ag $play(#chan, 1).fname 
 </pre>