Difference between revisions of "Template:C4V165 Variable SUmmary"

From LinnDocs
Jump to: navigation, search
m
m
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{| border="0" cellspacing = "0" cellpadding = "0" style="color:black" style="text-align: left;"
 
{| border="0" cellspacing = "0" cellpadding = "0" style="color:black" style="text-align: left;"
−
<!--Top Row-->
 
 
|-
 
|-
 
|colspan = "3"| <B><B>Variable Summary</b></b>
 
|colspan = "3"| <B><B>Variable Summary</b></b>
 
|-
 
|-
 
| width=40 |
 
| width=40 |
−
| width =150 | <B>Linn Network</b>
+
| width =150 style="color:blue" | <B><u>Linn Network</u></b>
−
| width =100| ||
+
| width =100 style="color:black"| ||
 
|-  
 
|-  
 
||
 
||
Line 27: Line 26:
 
|-
 
|-
 
|| || || 32767 || Fully initialised and operational.
 
|| || || 32767 || Fully initialised and operational.
 +
|-
 +
|| || || ||<br>
 +
|}
 +
<!-- DS PLAYER --->
 +
{| border="0" cellspacing = "0" cellpadding = "0" style="color:black" style="text-align: left;"
 +
|-
 +
| width=40 |
 +
| width =150 style="color:blue" | <B><u>Linn DS Series</u></b>
 +
| width =100 style="color:black"|
 +
||
 +
||
 +
|-
 +
||
 +
|colspan = "3" |The driver has the following read-only variables in addition to the standard variables defined by Control4:
 +
|
 +
|-
 +
|| ||<b><u>Variable</u></b>
 +
|colspan="2"|<b><u>Purpose</u></b>
 +
|- 
 +
|| ||<b>INPUT_NUMBER    </b>
 +
|colspan = "2"| Indicates which input is currently supplying audio to the room output:
 +
||
 +
|-
 +
|| || || -2 || Songcast from a remote streamer.
 +
|-
 +
|| || || -1 || The local streamer.(Playlist/Radio)
 +
|-
 +
|| || || 0 || Nothing
 +
|-
 +
|| || || 1..32 || External input 1..32; see Properties to determine which input number corresponds to which input device.
 +
|-
 +
|| ||
 +
|colspan="2"| Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.
 +
|- 
 +
|| || || ||<br>
 +
|-
 +
|| ||<b>SOURCE_NAME    </b>
 +
|colspan = "2"| The name of the currently playing source. Names are as defined on the DS using Konfig.
 +
||
 +
|-
 +
|| || <b>PAUSED</b>
 +
| colspan="2"| true if playback is paused, else false.
 +
|-
 +
|| || <b>PLAYING</b>
 +
|colspan="2"| true if playback active, else false.
 +
|-
 +
|| || <b>STOPPED</b >
 +
|colspan="2"| true if playback stopped, else false.
 +
|-
 +
|| || <b>PLAY_STATUS</b>
 +
|colspan="2"| One of the following values:
 +
|}
 +
<!-- DS Play status -->
 +
{| border="0" cellspacing = "0" cellpadding = "0" style="color:black" style="text-align: left;"
 +
|-
 +
| width=40 |
 +
| width =150 |
 +
|width="230"| <b>PLAYBACK_STATE_IDLE</b>
 +
|| Playback has stopped.
 +
|-
 +
|| || || <b>PLAYBACK_STATE_PAUSED</b> || Playback is paused.
 +
|-
 +
|| || || <b>PLAYBACK_STATE_PLAYING</b> || Playback is active.
 +
|-
 +
|}
 +
<!-- Kustom DSM --->
 +
<br><br>
 +
{| border="0" cellspacing = "0" cellpadding = "0" style="color:black" style="text-align: left;"
 +
|-
 +
| width=40 |
 +
| width =200 style="color:blue" | <B><u>Kustom DSM</u></b>
 +
| width =100 style="color:black"|
 +
||
 +
||
 +
|-
 +
||
 +
|colspan = "3" |The driver has the following read-only variables in addition to the standard variables defined by Control4:
 +
|
 +
|-
 +
|| ||<b><u>Variable</u></b>
 +
|colspan="2"|<b><u>Purpose</u></b>
 +
|- 
 +
|| ||<b>ZONE_<i><b>N</b></i>_INPUT_NUMBER    </b>
 +
|colspan = "2"| Indicates which input is currently supplying audio to zone N:
 +
||
 +
|-
 +
|| || || -2 || Songcast from a remote streamer.
 +
|-
 +
|| || || -1 || The local streamer.(Playlist/Radio)
 +
|-
 +
|| || || 0 || Nothing
 +
|-
 +
|| || || 1..4 || External input 1..4; see Properties to determine which input number corresponds to which input device.
 +
|-
 +
|| ||
 +
|colspan="2"| Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.
 +
|- 
 +
|| || || ||<br>
 +
|-
 +
|| ||<b>ZONE_<i><b>N</b></i>_SOURCE_NAME    </b>
 +
|colspan = "2"| The name of the currently playing source in  zone <i><b>N</b></i>. Names are as defined on the Kustom using Konfig.
 +
||
 +
|-
 +
|| || <b>STREAMER_<i><b>N</b></i>_PAUSED</b>
 +
| colspan="2"| true if playback on streamer <i><b>N</b></i> is paused, else false.
 +
|-
 +
|| || <b>STREAMER_<i><b>N</b></i>_PLAYING</b>
 +
|colspan="2"| true if playback on streamer <i><b>N</b></i> active, else false.
 +
|-
 +
|| || <b>STREAMER_<i><b>N</b></i>_STOPPED</b>
 +
|colspan="2"| true if playback on streamer <i><b>N</b></i> stopped, else false.
 +
|-
 +
|| || <b>STREAMER_<i><b>N</b></i>_PLAY_STATUS</b>
 +
|colspan="2"| A string value giving playback state on streamer <i><b>N</b></i>:
 +
|}
 +
<!-- DS Play status -->
 +
{| border="0" cellspacing = "0" cellpadding = "0" style="color:black" style="text-align: left;"
 +
|-
 +
| width=40 |
 +
| width =200 |
 +
|width="230"| <b>PLAYBACK_STATE_IDLE</b>
 +
|| Playback has stopped.
 +
|-
 +
|| || || <b>PLAYBACK_STATE_PAUSED</b> || Playback is paused.
 +
|-
 +
|| || || <b>PLAYBACK_STATE_PLAYING</b> || Playback is active.
 
|-
 
|-
  
−
|)
+
|}

Latest revision as of 14:14, 5 August 2021

Variable Summary
Linn Network
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
CONNECT_STATE Indicates the state of the connection from the driver to the Kazoo server gateway:
0 Not connected.
1 Connecting.
2 Connected.
32767 Fully initialised and operational.

Linn DS Series
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
INPUT_NUMBER Indicates which input is currently supplying audio to the room output:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..32 External input 1..32; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

SOURCE_NAME The name of the currently playing source. Names are as defined on the DS using Konfig.
PAUSED true if playback is paused, else false.
PLAYING true if playback active, else false.
STOPPED true if playback stopped, else false.
PLAY_STATUS One of the following values:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.



Kustom DSM
The driver has the following read-only variables in addition to the standard variables defined by Control4:
Variable Purpose
ZONE_N_INPUT_NUMBER Indicates which input is currently supplying audio to zone N:
-2 Songcast from a remote streamer.
-1 The local streamer.(Playlist/Radio)
0 Nothing
1..4 External input 1..4; see Properties to determine which input number corresponds to which input device.
Note that it is not guaranteed that the input number is 0 when the room is off, so programming should not rely on this nor on receiving a change in this value when the room switches on.

ZONE_N_SOURCE_NAME The name of the currently playing source in zone N. Names are as defined on the Kustom using Konfig.
STREAMER_N_PAUSED true if playback on streamer N is paused, else false.
STREAMER_N_PLAYING true if playback on streamer N active, else false.
STREAMER_N_STOPPED true if playback on streamer N stopped, else false.
STREAMER_N_PLAY_STATUS A string value giving playback state on streamer N:
PLAYBACK_STATE_IDLE Playback has stopped.
PLAYBACK_STATE_PAUSED Playback is paused.
PLAYBACK_STATE_PLAYING Playback is active.
Retrieved from "https://docs.linn.co.uk/wiki/index.php?title=Template:C4V165_Variable_SUmmary&oldid=24115"