Class: Zone

Zone()

new Zone()

Roon API Transport Service: Zone
Properties:
Name Type Attributes Description
zone_id string
display_name string Display Name for this zone
ouputs Array.<Output> The outputs in this zone
state 'playing' | 'paused' | 'loading' | 'stopped'
seek_position number <optional>
Current seek position for the zone
is_previous_allowed boolean Indicates whether the "previous" control is supported
is_next_allowed boolean Indicates whether the "next" control is supported
is_pause_allowed boolean Indicates whether the "pause" control is supported
is_play_allowed boolean Indicates whether the "play" control is supported
is_seek_allowed boolean Indicates whether the "seek" control is supported
queue_items_remaining number <optional>
Number of items in the play queue for this zone
queue_time_remaining number <optional>
Number of seconds remaining in the play queue for this zone
settings object <optional>
The default values for parties.
Properties
Name Type Description
loop 'loop' | 'loop_one' | 'disabled' loop setting on the zone
shuffle boolean indicates whether shuffle is enabled on the zone
auto_radio boolean indicates whether auto-radio mode is enabled on the zone
now_playing object <optional>
Now-playing information for this zone, if playback is active
Properties
Name Type Attributes Description
seek_position number <optional>
Seek Position in seconds, if applicable
length number <optional>
Length of media in seconds, if applicable
image_key string <optional>
Now-playing image
one_line object Display text for one-line displays
Properties
Name Type Description
line1 string
two_line object Display text for two-line displays
Properties
Name Type Attributes Description
line1 string
line2 string <optional>
three_line object Display text for three-line displays
Properties
Name Type Attributes Description
line1 string
line2 string <optional>
line3 string <optional>
Source: