YAACC - UPNP Client and Server
Loading...
Searching...
No Matches
de.yaacc.yxc.YxcZoneStatus Class Reference

Answer of <zone>/getStatus. More...

Collaboration diagram for de.yaacc.yxc.YxcZoneStatus:
Collaboration graph

Public Member Functions

String getPower ()
 
boolean isPowerOn ()
 
Integer getSleep ()
 
Integer getVolume ()
 
Integer getMaxVolume ()
 
Boolean getMute ()
 
String getInput ()
 
String getInputText ()
 
boolean isLinkInput ()
 True when the zone has the input a group client plays (mc_link).
 
Boolean getDistributionEnabled ()
 Whether what the zone plays can be handed to a group: false on a client (its input is the link), true on a server; null if absent.
 
String getSoundProgram ()
 
YxcEqualizer getEqualizer ()
 
String getLinkControl ()
 
String getLinkAudioDelay ()
 
String getLinkAudioQuality ()
 
Integer getDisableFlags ()
 

Detailed Description

Answer of <zone>/getStatus.

Values are as the device reports them; a key the device does not have reads as null (three devices checked on 2026-11-02 differ: one has no input_text and no sound_program, two have no link_audio_quality).

Member Function Documentation

◆ getDisableFlags()

Integer de.yaacc.yxc.YxcZoneStatus.getDisableFlags ( )
Returns
the bit field of functions the device blocks at the moment (0 is none), null if absent

◆ getEqualizer()

YxcEqualizer de.yaacc.yxc.YxcZoneStatus.getEqualizer ( )
Returns
the equalizer block, null if the status has none

◆ getInput()

String de.yaacc.yxc.YxcZoneStatus.getInput ( )
Returns
the id of the selected input, null if absent

Referenced by de.yaacc.yxc.YxcSettings.build(), de.yaacc.yxc.YxcSourceActions.perform(), and de.yaacc.yxc.YxcPresetActions.recall().

Here is the caller graph for this function:

◆ getInputText()

String de.yaacc.yxc.YxcZoneStatus.getInputText ( )
Returns
the name the device shows for the input, null on a device that does not report it

◆ getLinkAudioQuality()

String de.yaacc.yxc.YxcZoneStatus.getLinkAudioQuality ( )
Returns
null on a device without the audio quality setting

◆ getMaxVolume()

Integer de.yaacc.yxc.YxcZoneStatus.getMaxVolume ( )
Returns
the highest volume the zone accepts now, null if absent

Referenced by de.yaacc.yxc.YxcVolumeAccess.readPercent().

Here is the caller graph for this function:

◆ getPower()

String de.yaacc.yxc.YxcZoneStatus.getPower ( )
Returns
the power word as reported (on or a standby word), null if absent

◆ getSleep()

Integer de.yaacc.yxc.YxcZoneStatus.getSleep ( )
Returns
the sleep timer in minutes (0 is off), null if absent

◆ getVolume()

Integer de.yaacc.yxc.YxcZoneStatus.getVolume ( )
Returns
the volume in the zone's own scale (see the range of the features), null if absent

Referenced by de.yaacc.yxc.YxcVolumeAccess.readPercent().

Here is the caller graph for this function:

◆ isLinkInput()

boolean de.yaacc.yxc.YxcZoneStatus.isLinkInput ( )

True when the zone has the input a group client plays (mc_link).

A server keeps its own input, so this is a hint that the device is a client right now; the authority for group membership is dist/getDistributionInfo.


The documentation for this class was generated from the following file: