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