org.digitalmediaserver.cast

Class CustomMessageEvent

java.lang.Object

org.digitalmediaserver.cast.CustomMessageEvent

@Immutable
public class CustomMessageEvent
extends Object

A custom event sent by a receiver application.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.protobuf.ByteString	binaryPayload The binary payload from the message
protected String	destinationId The destination ID from the message
protected String	namespace The namespace from the message
protected CastChannel.CastMessage.PayloadType	payloadType The CastChannel.CastMessage.PayloadType
protected String	sourceId The source ID from the message
protected String	stringPayload The string payload from the message

Constructor Summary

Constructors

Constructor and Description
CustomMessageEvent(String sourceId, String destinationId, String namespace, com.google.protobuf.ByteString binaryPayload) Creates a new BINARY instance.
CustomMessageEvent(String sourceId, String destinationId, String namespace, String stringPayload) Creates a new STRING instance.

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.ByteString	getBinaryPayload()
String	getDestinationId()
String	getNamespace()
CastChannel.CastMessage.PayloadType	getPayloadType()
String	getSourceId()
String	getStringPayload()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sourceId

@Nullable
protected final String sourceId

The source ID from the message

destinationId

@Nullable
protected final String destinationId

The destination ID from the message

namespace

@Nullable
protected final String namespace

The namespace from the message

stringPayload

@Nullable
protected final String stringPayload

The string payload from the message

binaryPayload

@Nullable
protected final com.google.protobuf.ByteString binaryPayload

The binary payload from the message

payloadType

@Nonnull
protected final CastChannel.CastMessage.PayloadType payloadType

The CastChannel.CastMessage.PayloadType

Constructor Detail

CustomMessageEvent

public CustomMessageEvent(@Nullable
                          String sourceId,
                          @Nullable
                          String destinationId,
                          @Nullable
                          String namespace,
                          @Nullable
                          String stringPayload)

Creates a new STRING instance.

Parameters:

sourceId - the source ID from the message.

destinationId - the destination ID from the message.

namespace - the namespace from the message.

stringPayload - the string payload from the message.

CustomMessageEvent

public CustomMessageEvent(@Nullable
                          String sourceId,
                          @Nullable
                          String destinationId,
                          @Nullable
                          String namespace,
                          @Nullable
                          com.google.protobuf.ByteString binaryPayload)

Creates a new BINARY instance.

Parameters:

sourceId - the source ID from the message.

destinationId - the destination ID from the message.

namespace - the namespace from the message.

binaryPayload - the binary payload from the message.

Method Detail

getSourceId

@Nullable
public String getSourceId()

Returns:

The message source ID.

getDestinationId

@Nullable
public String getDestinationId()

Returns:

The message destination ID.

getNamespace

@Nullable
public String getNamespace()

Returns:

The message namespace.

getStringPayload

@Nullable
public String getStringPayload()

Returns:

The String payload if the source message is of type STRING. If the message is BINARY, always null.

getBinaryPayload

@Nullable
public com.google.protobuf.ByteString getBinaryPayload()

Returns:

The ByteString payload if the source message is of type BINARY. If the message is STRING, always null.

getPayloadType

@Nonnull
public CastChannel.CastMessage.PayloadType getPayloadType()

Returns:

The type of payload in the source message.

toString

public final String toString()

Overrides:

toString in class Object