$play » History » Version 6
Per Amundsen, 07/09/2018 12:26 AM
1 | 1 | Per Amundsen | _Added in 3.2_ |
---|---|---|---|
2 | |||
3 | 5 | Per Amundsen | *$play([nick|channel,]N)* |
4 | 1 | Per Amundsen | |
5 | 2 | Per Amundsen | Returns information about the [[/play]] queue. |
6 | 1 | Per Amundsen | |
7 | 3 | Per Amundsen | _See also [[/play]], [[$pnick]]._ |
8 | |||
9 | 1 | Per Amundsen | *Parameters* |
10 | |||
11 | 5 | Per Amundsen | nick|channel - The nick or channel where the file is playing. |
12 | 6 | Per Amundsen | N - If N = 0, number of playing files, otherwise the Nth playing file. |
13 | 1 | Per Amundsen | |
14 | *Properties* |
||
15 | |||
16 | type - Returns the type of the request, "topic" if you are using /play -t, otherwise "file". |
||
17 | .fname - Returns the complete filename used for the play request. |
||
18 | .topic - Returns the name of the topic if you used /play -t. |
||
19 | .pos - Returns the number of the line that play request is at, (the next line to be played). |
||
20 | .lines - Returns the total number of lines in the file being played. |
||
21 | .delay - Returns the delay used for the play request (default to 1000). |
||
22 | .status - Returns the status of the play request, "playing" or "queued". |
||
23 | |||
24 | *Example* |
||
25 | |||
26 | <pre> |
||
27 | ; Print the filename of the current playing file. |
||
28 | //echo -ag $play(1).fname |
||
29 | 4 | Per Amundsen | |
30 | ; Print the filename of first queued file matching channel '#chan'. |
||
31 | //echo -ag $play(#chan, 1).fname |
||
32 | 1 | Per Amundsen | </pre> |