engineer.nightowl.sonos.api.resource

Class HomeTheaterResource

java.lang.Object

engineer.nightowl.sonos.api.resource.HomeTheaterResource

public class HomeTheaterResource
extends Object

Send commands to compatible devices

See Also:

Sonos docs

Constructor Summary

Constructors

Constructor and Description
HomeTheaterResource(SonosApiClient apiClient) Constructor for HomeTheaterResource.

Method Summary

Modifier and Type	Method and Description
SonosSuccess	loadHomeTheater(String clientToken, String playerId) Set the specified player to use its optical or HDMI input.
SonosSuccess	setTvPowerState(String clientToken, String playerId, SonosTvPowerState tvPowerState) Instruct the specified player to set the attached device to the specified power state using HDMI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HomeTheaterResource

public HomeTheaterResource(SonosApiClient apiClient)

Constructor for HomeTheaterResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

loadHomeTheater

public SonosSuccess loadHomeTheater(String clientToken,
                                    String playerId)
                             throws SonosApiClientException,
                                    SonosApiError

Set the specified player to use its optical or HDMI input.

Parameters:

clientToken - for the user

playerId - to set to home theater mode

Returns:

that the action was successful (will always be true, otherwise an exception is thrown)

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs

setTvPowerState

public SonosSuccess setTvPowerState(String clientToken,
                                    String playerId,
                                    SonosTvPowerState tvPowerState)
                             throws SonosApiClientException,
                                    SonosApiError

Instruct the specified player to set the attached device to the specified power state using HDMI.

Parameters:

clientToken - for the user

playerId - to transmit the power state through

tvPowerState - chosen SonosTvPowerState

Returns:

if the client was successful or not (see Sonos docs for how this works)

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs