org.digitalmediaserver.cast

Class StandardRequest.VolumeRequest

java.lang.Object

org.digitalmediaserver.cast.StandardRequest.VolumeRequest

All Implemented Interfaces:

Message, Request

Enclosing class:

StandardRequest

public static class StandardRequest.VolumeRequest
extends Object
implements Request

A request to set the stream volume of a media referenced by a specific media session ID.

Note This should be a StandardRequest.MediaRequest, but since that would also make it a StandardMessage which maps type using Jackson subtypes, it isn't. The reason is that another implementation, StandardRequest.SetVolume, is already mapped to "SET_VOLUME" which is the same type as this request uses. The differences between the two is the namespace, but that isn't captured by the Jackson subtype logic, which is why this implementation is only a Request that "manually implements" the remaining fields required for a StandardRequest.MediaRequest.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	customData Custom data for the receiver application
protected int	mediaSessionId The media session ID
protected long	requestId the request ID
protected String	sessionId The session ID
protected String	type The request type
protected MediaVolume	volume The new volume of the stream.

Constructor Summary

Constructors

Constructor and Description
VolumeRequest(String sessionId, int mediaSessionId, MediaVolume volume, Map<String,Object> customData) Creates a new request using the specified parameters.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getCustomData()
int	getMediaSessionId()
long	getRequestId()
String	getSessionId()
MediaVolume	getVolume()
void	setRequestId(long requestId) Sets the request ID.

Methods inherited from class java.lang.Object

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

Field Detail

mediaSessionId

protected final int mediaSessionId

The media session ID

sessionId

protected final String sessionId

The session ID

requestId

protected long requestId

the request ID

type

protected final String type

The request type

See Also:

Constant Field Values

volume

@Nonnull
protected final MediaVolume volume

The new volume of the stream. At least one of level or muted must be set.

customData

@Nullable
protected final Map<String,Object> customData

Custom data for the receiver application

Constructor Detail

VolumeRequest

public VolumeRequest(String sessionId,
                     int mediaSessionId,
                     @Nonnull
                     MediaVolume volume,
                     @Nullable
                     Map<String,Object> customData)

Creates a new request using the specified parameters.

Parameters:

sessionId - the session ID to use.

mediaSessionId - the media session ID for which the seek request applies.

volume - the new volume of the stream. At least one of level or muted must be set.

customData - the custom data for the receiver application.

Throws:

IllegalArgumentException - If sessionId or volume is null.

Method Detail

getVolume

@Nonnull
public MediaVolume getVolume()

Returns:

The new volume of the stream. At least one of level or muted must be set.

getCustomData

@Nullable
public Map<String,Object> getCustomData()

Returns:

The custom data for the receiver application.

setRequestId

public void setRequestId(long requestId)

Description copied from interface: Request

Sets the request ID. Should be handled by the sending Channel.

Specified by:

setRequestId in interface Request

Parameters:

requestId - the request ID to set.

getRequestId

public long getRequestId()

Specified by:

getRequestId in interface Request

Returns:

The request ID.

getMediaSessionId

public int getMediaSessionId()

Returns:

The media session ID.

getSessionId

public String getSessionId()

Returns:

the session ID.