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