org.digitalmediaserver.cast

Class Volume

java.lang.Object

org.digitalmediaserver.cast.Volume

@Immutable
public class Volume
extends Object

The volume of a device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Volume.VolumeBuilder A builder class for building Volume instances.
static class	Volume.VolumeControlType Describes types of volume control.

Field Summary

Fields

Modifier and Type	Field and Description
protected Volume.VolumeControlType	controlType The type of volume control that is available
protected Double	level The current volume level as a value between 0.0 and 1.0.
protected Boolean	muted Whether the receiver is muted, independent of the volume level
protected Double	stepInterval The allowed steps for changing volume

Constructor Summary

Constructors

Constructor and Description
Volume(Volume.VolumeControlType controlType, Double level, Boolean muted, Double stepInterval) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Volume.VolumeControlType	getControlType()
Double	getLevel()
Boolean	getMuted()
Double	getStepInterval()
int	hashCode()
Volume.VolumeBuilder	modify() Creates a new Volume.VolumeBuilder that is initialized with the values from this Volume instance, which can be modified and then used to create a new (immutable) Volume instance.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

controlType

@Nullable
protected final Volume.VolumeControlType controlType

The type of volume control that is available

level

@Nullable
protected final Double level

The current volume level as a value between 0.0 and 1.0. 1.0 is the maximum volume possible on the receiver or stream.

muted

@Nullable
protected final Boolean muted

Whether the receiver is muted, independent of the volume level

stepInterval

@Nullable
protected final Double stepInterval

The allowed steps for changing volume

Constructor Detail

Volume

public Volume(@Nullable
              Volume.VolumeControlType controlType,
              @Nullable
              Double level,
              @Nullable
              Boolean muted,
              @Nullable
              Double stepInterval)

Creates a new instance using the specified parameters.

Parameters:

controlType - the type of volume control that is available.

level - the current volume level as a value between 0.0 and 1.0.

muted - whether the receiver is muted, independent of the volume level.

stepInterval - the allowed steps for changing volume.

Method Detail

getControlType

@Nullable
public Volume.VolumeControlType getControlType()

Returns:

The type of volume control that is available.

getLevel

@Nullable
public Double getLevel()

Returns:

The current volume level as a value between 0.0 and 1.0.

getMuted

@Nullable
public Boolean getMuted()

Returns:

Whether the receiver is muted, independent of the volume level.

getStepInterval

@Nullable
public Double getStepInterval()

Returns:

The allowed steps for changing volume.

modify

@Nonnull
public Volume.VolumeBuilder modify()

Creates a new Volume.VolumeBuilder that is initialized with the values from this Volume instance, which can be modified and then used to create a new (immutable) Volume instance.

Returns:

The initialized Volume.VolumeBuilder.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object