org.digitalmediaserver.cast

Class Volume.VolumeBuilder

java.lang.Object

org.digitalmediaserver.cast.Volume.VolumeBuilder

Enclosing class:

Volume

public static class Volume.VolumeBuilder
extends Object

A builder class for building Volume instances.

Author:

Nadahar

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
VolumeBuilder(Volume.VolumeControlType controlType, Double stepInterval) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
Volume	build() Builds a new Volume instance based on the current values of this builder.
Volume.VolumeControlType	controlType()
Double	level()
Volume.VolumeBuilder	level(Double level) Sets the current volume level as a value between 0.0 and 1.0.
Boolean	muted()
Volume.VolumeBuilder	muted(Boolean muted) Sets whether the receiver is muted, independent of the volume level.
Double	stepInterval()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

controlType

@Nullable
protected Volume.VolumeControlType controlType

The type of volume control that is available

level

@Nullable
protected 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 Boolean muted

Whether the receiver is muted, independent of the volume level

stepInterval

@Nullable
protected Double stepInterval

The allowed steps for changing volume

Constructor Detail

VolumeBuilder

public VolumeBuilder(@Nullable
                     Volume.VolumeControlType controlType,
                     @Nullable
                     Double stepInterval)

Creates a new instance using the specified parameters.

Parameters:

controlType - the type of volume control that is available.

stepInterval - the allowed steps for changing volume.

Method Detail

controlType

@Nullable
public Volume.VolumeControlType controlType()

Returns:

The type of volume control that is available.

level

@Nullable
public Double level()

Returns:

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

level

@Nonnull
public Volume.VolumeBuilder level(@Nullable
                                            Double level)

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

Parameters:

level - the volume level to set.

Returns:

This Volume.VolumeBuilder.

muted

@Nullable
public Boolean muted()

Returns:

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

muted

@Nonnull
public Volume.VolumeBuilder muted(@Nullable
                                            Boolean muted)

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

Parameters:

muted - the mute state to set.

Returns:

This Volume.VolumeBuilder.

stepInterval

@Nullable
public Double stepInterval()

Returns:

The allowed steps for changing volume.

build

public Volume build()

Builds a new Volume instance based on the current values of this builder.

Returns:

The new Volume instance.

toString

public String toString()

Overrides:

toString in class Object