VolumeControl

com.connectsdk.service.capability.VolumeControl

extends CapabilityMethods

The VolumeControl capability protocol serves to define the methods required for normalizing common volume specific commands (volume up/down, mute, etc).

Properties

final String Any = “VolumeControl.Any”

final String Volume_Get = “VolumeControl.Get”

final String Volume_Set = “VolumeControl.Set”

final String Volume_Up_Down = “VolumeControl.UpDown”

final String Volume_Subscribe = “VolumeControl.Subscribe”

final String Mute_Get = “VolumeControl.Mute.Get”

final String Mute_Set = “VolumeControl.Mute.Set”

final String Mute_Subscribe = “VolumeControl.Mute.Subscribe”

final String[] Capabilities = { Volume_Get, Volume_Set, Volume_Up_Down, Volume_Subscribe, Mute_Get, Mute_Set, Mute_Subscribe }

Methods

VolumeControl getVolumeControl ()

CapabilityPriorityLevel getVolumeControlCapabilityLevel ()

void volumeUp (ResponseListener<Object> listener)

Sends the volume up command to the device.

Related capabilities:
  • VolumeControl.UpDown
Parameters:
  • listener – (optional) ResponseListener< Object > with methods to be called on success or failure

void volumeDown (ResponseListener <Object> listener)

Sends the volume down command to the device.

Related capabilities:
  • VolumeControl.UpDown
Parameters:
  • listener – (optional) ResponseListener< Object > with methods to be called on success or failure

void setVolume (float volume, ResponseListener <Object> listener)

Set the volume of the device.

Related capabilities:
  • VolumeControl.Set
Parameters:
  • volume – Volume as a float between 0.0 and 1.0
  • listener – (optional) ResponseListener< Object > with methods to be called on success or failure

void getVolume (VolumeListener listener)

Get the current volume of the device.

Related capabilities:
  • VolumeControl.Get
Parameters:
  • listener – (optional) VolumeListener with methods to be called on success or failure

void setMute (boolean isMute, ResponseListener <Object> listener)

Set the current volume.

Related capabilities:
  • VolumeControl.Mute.Set
Parameters:
  • isMute
  • listener – (optional) ResponseListener< Object > with methods to be called on success or failure

void getMute (MuteListener listener)

Get the current mute state.

Related capabilities:
  • VolumeControl.Mute.Get
Parameters:
  • listener – (optional) MuteListener with methods to be called on success or failure

ServiceSubscription <VolumeListener> subscribeVolume (VolumeListener listener)

Subscribe to the volume on the TV.

Related capabilities:
  • VolumeControl.Subscribe
Parameters:
  • listener – (optional) VolumeListener with methods to be called on success or failure

ServiceSubscription <MuteListener> subscribeMute (MuteListener listener)

Subscribe to the mute state on the TV.

Related capabilities:
  • VolumeControl.Mute.Subscribe
Parameters:
  • listener – (optional) MuteListener with methods to be called on success or failure