fm.liveswitch.Message Class Reference

A message. More...

Public Member Functions

fm.liveswitch.Message clone ()
 Creates a copy of the Message. More...
 
String getApiServiceId ()
 Gets the API Service identifier. More...
 
String getApiVersion ()
 Gets the API Version. More...
 
String getApplicationId ()
 Gets the application identifier. More...
 
String getChannelId ()
 Gets the channel identifier. More...
 
fm.liveswitch.ChannelReport[] getChannelReports ()
 Gets the channel reports. More...
 
String getClientId ()
 Gets the client identifier. More...
 
String getClientProtocol ()
 Gets the client protocol. More...
 
fm.liveswitch.ClientReport[] getClientReports ()
 Gets the client reports. More...
 
String[] getClientRoles ()
 Gets the client roles. More...
 
String getClientTag ()
 Gets the client tag. More...
 
String getConnectionId ()
 Gets the connection identifier. More...
 
String getConnectionTag ()
 Gets the connection tag. More...
 
String getConnectionType ()
 Gets the connection type. More...
 
String getConnectorId ()
 Gets the Connector identifer. More...
 
String getDeviceAlias ()
 Gets the device alias. More...
 
String getDeviceId ()
 Gets the device identifier. More...
 
String getMediaId ()
 Gets the broadcast identifier. More...
 
String getMediaServerId ()
 Gets the Media Server identifier. More...
 
String getPayload ()
 Gets the payload. More...
 
String getPreferredMediaServerId ()
 Gets the preferred Media Server identifier. More...
 
String getRecordingMonitorId ()
 Gets the Recording Monitor identifer. More...
 
String getRecordingMoverId ()
 Gets the Recording Mover identifer. More...
 
String getRecordingMuxerId ()
 Gets the Recording Muxer identifer. More...
 
String getRegion ()
 Gets the region. More...
 
String getRemoteClientId ()
 Gets the remote client identifier. More...
 
String getRemoteConnectionId ()
 Gets the remote connection identifier. More...
 
String getRemoteDeviceId ()
 Gets the remote device identifier. More...
 
String getRemoteMediaId ()
 Gets the remote broadcast identifier. More...
 
String getRemoteUserId ()
 Gets the remote user identifier. More...
 
long getTimestamp ()
 Gets the message timestamp. More...
 
String getToken ()
 Gets the token. More...
 
String getTransactionId ()
 Gets the transaction identifier. More...
 
String getType ()
 Gets the type. More...
 
String getUserAlias ()
 Gets the user alias. More...
 
String getUserId ()
 Gets the user identifier. More...
 
boolean isError (String errorType)
 Gets whether this message is an error of a particular type. More...
 
void setApiServiceId (String value)
 Sets the API Service identifier. More...
 
void setApiVersion (String value)
 Sets the API Version. More...
 
void setApplicationId (String value)
 Sets the application identifier. More...
 
void setChannelId (String value)
 Sets the channel identifier. More...
 
void setChannelReports (fm.liveswitch.ChannelReport[] value)
 Sets the channel reports. More...
 
void setClientId (String value)
 Sets the client identifier. More...
 
void setClientProtocol (String value)
 Sets the client protocol. More...
 
void setClientReports (fm.liveswitch.ClientReport[] value)
 Sets the client reports. More...
 
void setClientRoles (String[] value)
 Sets the client roles. More...
 
void setClientTag (String value)
 Sets the client tag. More...
 
void setConnectionId (String value)
 Sets the connection identifier. More...
 
void setConnectionTag (String value)
 Sets the connection tag. More...
 
void setConnectionType (String value)
 Sets the connection type. More...
 
void setConnectorId (String value)
 Sets the Connector identifer. More...
 
void setDeviceAlias (String value)
 Sets the device alias. More...
 
void setDeviceId (String value)
 Sets the device identifier. More...
 
void setMediaId (String value)
 Sets the broadcast identifier. More...
 
void setMediaServerId (String value)
 Sets the Media Server identifier. More...
 
void setPayload (String value)
 Sets the payload. More...
 
void setPreferredMediaServerId (String value)
 Sets the preferred Media Server identifier. More...
 
void setRecordingMonitorId (String value)
 Sets the Recording Monitor identifer. More...
 
void setRecordingMoverId (String value)
 Sets the Recording Mover identifer. More...
 
void setRecordingMuxerId (String value)
 Sets the Recording Muxer identifer. More...
 
void setRegion (String value)
 Sets the region. More...
 
void setRemoteClientId (String value)
 Sets the remote client identifier. More...
 
void setRemoteConnectionId (String value)
 Sets the remote connection identifier. More...
 
void setRemoteDeviceId (String value)
 Sets the remote device identifier. More...
 
void setRemoteMediaId (String value)
 Sets the remote broadcast identifier. More...
 
void setRemoteUserId (String value)
 Sets the remote user identifier. More...
 
void setTimestamp (long value)
 Sets the message timestamp. More...
 
void setToken (String value)
 Sets the token. More...
 
void setTransactionId (String value)
 Sets the transaction identifier. More...
 
void setType (String value)
 Sets the type. More...
 
void setUserAlias (String value)
 Sets the user alias. More...
 
void setUserId (String value)
 Sets the user identifier. More...
 
String toJson ()
 Serializes this instance to JSON. More...
 
- Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object > getDynamicProperties ()
 Gets all dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Removes a property value from the local cache. More...
 

Static Public Member Functions

static fm.liveswitch.Message createBitrateNotificationMessage (fm.liveswitch.BitrateNotification bitrateNotification)
 Creates a "bitrateNotification" message. More...
 
static fm.liveswitch.Message createBitrateNotificationMessage (fm.liveswitch.BitrateNotification[] bitrateNotifications)
 Creates a "bitrateNotification" message. More...
 
static fm.liveswitch.Message createBitrateRequestMessage (fm.liveswitch.BitrateRequest bitrateRequest)
 Creates a "bitrateRequest" message. More...
 
static fm.liveswitch.Message createBitrateRequestMessage (fm.liveswitch.BitrateRequest[] bitrateRequests)
 Creates a "bitrateRequest" message. More...
 
static fm.liveswitch.Message createCancelInviteMessage (String userId, String protocol)
 Creates a "cancelInvite" message. More...
 
static fm.liveswitch.Message createCandidateMessage (String candidateJson)
 Creates a "candidate" message. More...
 
static fm.liveswitch.Message createCloseMessage ()
 Creates a "close" message. More...
 
static fm.liveswitch.Message createDtmfTonesMessage (fm.liveswitch.dtmf.Tone[] dtmfTones)
 Creates a "dtmfTones" message. More...
 
static fm.liveswitch.Message createErrorMessage (String error)
 Creates a "error" message. More...
 
static fm.liveswitch.Message createErrorMessage (String error, String remoteUserId, String remoteDeviceId, String remoteClientId)
 Creates a "error" message. More...
 
static fm.liveswitch.Message createEventMessage (String eventInfoJson)
 Creates an "event" message. More...
 
static fm.liveswitch.Message createIceServersMessage ()
 Creates an "iceServers" message. More...
 
static fm.liveswitch.Message createInviteMessage (String userId, String protocol)
 Creates a "invite" message. More...
 
static fm.liveswitch.Message createJoinMessage (String channelId, String token)
 Creates a "join" message. More...
 
static fm.liveswitch.Message createKeyFrameRequestMessage (long[] synchronizationSources)
 Creates a "keyFrameRequest" message. More...
 
static fm.liveswitch.Message createKickMessage (String channelId, String clientId)
 Creates a "kick" message. More...
 
static fm.liveswitch.Message createKickMessage (String remoteUserId, String remoteDeviceId, String remoteClientId, String remoteConnectionId)
 Creates a "kick" message. More...
 
static fm.liveswitch.Message createLeaveMessage (String channelId, fm.liveswitch.ChannelReport channelReport)
 Creates a "leave" message. More...
 
static fm.liveswitch.Message createMcuOfferMessage (String tag, String offerJson)
 Creates an MCU "offer" message. More...
 
static fm.liveswitch.Message createMessageMessage (String message)
 Creates a "message" message. More...
 
static fm.liveswitch.Message createMessageMessage (String message, String remoteUserId)
 Creates a "message" message. More...
 
static fm.liveswitch.Message createMessageMessage (String message, String remoteUserId, String remoteDeviceId)
 Creates a "message" message. More...
 
static fm.liveswitch.Message createMessageMessage (String message, String remoteUserId, String remoteDeviceId, String remoteClientId)
 Creates a "message" message. More...
 
static fm.liveswitch.Message createPeerAnswerMessage (String tag, String answerJson, String remoteUserId, String remoteDeviceId, String remoteClientId)
 Creates a peer "answer" message. More...
 
static fm.liveswitch.Message createPeerCandidateMessage (String candidateJson, String remoteUserId, String remoteDeviceId, String remoteClientId)
 Creates a "candidate" message. More...
 
static fm.liveswitch.Message createPeerCloseMessage (String remoteUserId, String remoteDeviceId, String remoteClientId)
 Creates a "close" message. More...
 
static fm.liveswitch.Message createPeerOfferMessage (String tag, String offerJson, String remoteUserId, String remoteDeviceId, String remoteClientId)
 Creates a peer "offer" message. More...
 
static fm.liveswitch.Message createPeerRejectMessage (String remoteUserId, String remoteDeviceId, String remoteClientId, String remoteConnectionId)
 Creates a "reject" message. More...
 
static fm.liveswitch.Message createRegisterMessage (String applicationId, String userId, String userAlias, String deviceId, String deviceAlias, String clientId, String clientTag, String[] clientRoles, String region, String token)
 Creates a "register" message. More...
 
static fm.liveswitch.Message createRtcpDataChannelSignallingActivationMessage (fm.liveswitch.RtcpDataChannelSignallingActivation supportedMessageTypes)
 Creates a "activateInbandSignalling" message. More...
 
static fm.liveswitch.Message createSfuOfferMessage (String tag, String offerJson)
 Creates an SFU upstream "offer" message. More...
 
static fm.liveswitch.Message createSfuOfferMessage (String tag, String offerJson, String remoteMediaId)
 Creates an SFU downstream "offer" message. More...
 
static fm.liveswitch.Message createSfuOfferMessage (String tag, String offerJson, String remoteUserId, String remoteDeviceId, String remoteClientId, String remoteConnectionId)
 Creates an SFU downstream "offer" message. More...
 
static fm.liveswitch.Message createUnregisterMessage ()
 Creates an "unregister" message. More...
 
static fm.liveswitch.Message createUnregisterMessage (fm.liveswitch.ClientReport clientReport, fm.liveswitch.ChannelReport[] channelReports)
 Creates an "unregister" message. More...
 
static fm.liveswitch.Message createUpdateMessage (String configJson)
 Creates an "update" message. More...
 
static fm.liveswitch.Message createUpdateMessage (String configJson, String remoteUserId, String remoteDeviceId, String remoteClientId)
 Creates an "update" message. More...
 
static fm.liveswitch.Message createUpdateMessage (String configJson, String remoteUserId, String remoteDeviceId, String remoteClientId, String remoteConnectionId)
 Creates an "update" message. More...
 
static fm.liveswitch.Message fromJson (String messageJson)
 Deserializes an instance from JSON. More...
 
static fm.liveswitch.Message[] fromJsonArray (String messagesJson)
 Deserializes an array of instances from JSON. More...
 
static String toJson (fm.liveswitch.Message message)
 Serializes an instance to JSON. More...
 
static String toJson (fm.liveswitch.Message message, final boolean forceTimestamp)
 Serializes an instance to JSON and forces timestamp regardless of what generates Json. More...
 
static String toJsonArray (fm.liveswitch.Message[] messages)
 Serializes an array of instances to JSON. More...
 

Protected Member Functions

void propertiesToJson (java.util.HashMap< String, String > jsonObject)
 Serializes properties to JSON. More...
 
void propertiesToJson (java.util.HashMap< String, String > jsonObject, boolean forceTimestamp)
 Serializes properties to JSON. More...
 
void propertyFromJson (String name, String valueJson)
 Deserializes a property from JSON. More...
 
- Protected Member Functions inherited from fm.liveswitch.Dynamic
 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

A message.

Member Function Documentation

◆ clone()

fm.liveswitch.Message fm.liveswitch.Message.clone ( )

Creates a copy of the Message.

◆ createBitrateNotificationMessage() [1/2]

static fm.liveswitch.Message fm.liveswitch.Message.createBitrateNotificationMessage ( fm.liveswitch.BitrateNotification  bitrateNotification)
static

Creates a "bitrateNotification" message.

◆ createBitrateNotificationMessage() [2/2]

static fm.liveswitch.Message fm.liveswitch.Message.createBitrateNotificationMessage ( fm.liveswitch.BitrateNotification[]  bitrateNotifications)
static

Creates a "bitrateNotification" message.

◆ createBitrateRequestMessage() [1/2]

static fm.liveswitch.Message fm.liveswitch.Message.createBitrateRequestMessage ( fm.liveswitch.BitrateRequest  bitrateRequest)
static

Creates a "bitrateRequest" message.

◆ createBitrateRequestMessage() [2/2]

static fm.liveswitch.Message fm.liveswitch.Message.createBitrateRequestMessage ( fm.liveswitch.BitrateRequest[]  bitrateRequests)
static

Creates a "bitrateRequest" message.

◆ createCancelInviteMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createCancelInviteMessage ( String  userId,
String  protocol 
)
static

Creates a "cancelInvite" message.

◆ createCandidateMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createCandidateMessage ( String  candidateJson)
static

Creates a "candidate" message.

Parameters
candidateJsonThe candidate.

◆ createCloseMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createCloseMessage ( )
static

Creates a "close" message.

◆ createDtmfTonesMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createDtmfTonesMessage ( fm.liveswitch.dtmf.Tone[]  dtmfTones)
static

Creates a "dtmfTones" message.

◆ createErrorMessage() [1/2]

static fm.liveswitch.Message fm.liveswitch.Message.createErrorMessage ( String  error)
static

Creates a "error" message.

Parameters
errorThe error type.

◆ createErrorMessage() [2/2]

static fm.liveswitch.Message fm.liveswitch.Message.createErrorMessage ( String  error,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId 
)
static

Creates a "error" message.

Parameters
errorThe error type.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.

◆ createEventMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createEventMessage ( String  eventInfoJson)
static

Creates an "event" message.

◆ createIceServersMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createIceServersMessage ( )
static

Creates an "iceServers" message.

◆ createInviteMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createInviteMessage ( String  userId,
String  protocol 
)
static

Creates a "invite" message.

◆ createJoinMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createJoinMessage ( String  channelId,
String  token 
)
static

Creates a "join" message.

Parameters
channelIdThe channel to join.
tokenThe auth token.

◆ createKeyFrameRequestMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createKeyFrameRequestMessage ( long[]  synchronizationSources)
static

Creates a "keyFrameRequest" message.

◆ createKickMessage() [1/2]

static fm.liveswitch.Message fm.liveswitch.Message.createKickMessage ( String  channelId,
String  clientId 
)
static

Creates a "kick" message.

Parameters
channelIdThe channel identifier.
clientIdThe ID of the client to kick.

◆ createKickMessage() [2/2]

static fm.liveswitch.Message fm.liveswitch.Message.createKickMessage ( String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId,
String  remoteConnectionId 
)
static

Creates a "kick" message.

Parameters
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.
remoteConnectionIdThe remote connection identifier.

◆ createLeaveMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createLeaveMessage ( String  channelId,
fm.liveswitch.ChannelReport  channelReport 
)
static

Creates a "leave" message.

Parameters
channelIdThe channel to leave.
channelReportThe channel report.

◆ createMcuOfferMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createMcuOfferMessage ( String  tag,
String  offerJson 
)
static

Creates an MCU "offer" message.

Parameters
tagThe tag.
offerJsonThe offer.

◆ createMessageMessage() [1/4]

static fm.liveswitch.Message fm.liveswitch.Message.createMessageMessage ( String  message)
static

Creates a "message" message.

Parameters
messageThe message.

◆ createMessageMessage() [2/4]

static fm.liveswitch.Message fm.liveswitch.Message.createMessageMessage ( String  message,
String  remoteUserId 
)
static

Creates a "message" message.

Parameters
messageThe message.
remoteUserIdThe remote user identifier.

◆ createMessageMessage() [3/4]

static fm.liveswitch.Message fm.liveswitch.Message.createMessageMessage ( String  message,
String  remoteUserId,
String  remoteDeviceId 
)
static

Creates a "message" message.

Parameters
messageThe message.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.

◆ createMessageMessage() [4/4]

static fm.liveswitch.Message fm.liveswitch.Message.createMessageMessage ( String  message,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId 
)
static

Creates a "message" message.

Parameters
messageThe message.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.

◆ createPeerAnswerMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createPeerAnswerMessage ( String  tag,
String  answerJson,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId 
)
static

Creates a peer "answer" message.

Parameters
tagThe tag.
answerJsonThe answer.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.

◆ createPeerCandidateMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createPeerCandidateMessage ( String  candidateJson,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId 
)
static

Creates a "candidate" message.

Parameters
candidateJsonThe candidate.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.

◆ createPeerCloseMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createPeerCloseMessage ( String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId 
)
static

Creates a "close" message.

Parameters
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.

◆ createPeerOfferMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createPeerOfferMessage ( String  tag,
String  offerJson,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId 
)
static

Creates a peer "offer" message.

Parameters
tagThe tag.
offerJsonThe offer.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.

◆ createPeerRejectMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createPeerRejectMessage ( String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId,
String  remoteConnectionId 
)
static

Creates a "reject" message.

Parameters
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.
remoteConnectionIdThe remote connection identifier.

◆ createRegisterMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createRegisterMessage ( String  applicationId,
String  userId,
String  userAlias,
String  deviceId,
String  deviceAlias,
String  clientId,
String  clientTag,
String[]  clientRoles,
String  region,
String  token 
)
static

Creates a "register" message.

Parameters
applicationIdThe application identifier.
userIdThe user identifier.
userAliasThe user alias.
deviceIdThe device identifier.
deviceAliasThe device alias.
clientIdThe client identifier.
clientTagThe client tag.
clientRolesThe client roles.
regionThe region.
tokenThe auth token.

◆ createRtcpDataChannelSignallingActivationMessage()

static fm.liveswitch.Message fm.liveswitch.Message.createRtcpDataChannelSignallingActivationMessage ( fm.liveswitch.RtcpDataChannelSignallingActivation  supportedMessageTypes)
static

Creates a "activateInbandSignalling" message.

◆ createSfuOfferMessage() [1/3]

static fm.liveswitch.Message fm.liveswitch.Message.createSfuOfferMessage ( String  tag,
String  offerJson 
)
static

Creates an SFU upstream "offer" message.

Parameters
tagThe tag.
offerJsonThe offer.

◆ createSfuOfferMessage() [2/3]

static fm.liveswitch.Message fm.liveswitch.Message.createSfuOfferMessage ( String  tag,
String  offerJson,
String  remoteMediaId 
)
static

Creates an SFU downstream "offer" message.

Parameters
tagThe tag.
offerJsonThe offer.
remoteMediaIdThe remote media identifier.

◆ createSfuOfferMessage() [3/3]

static fm.liveswitch.Message fm.liveswitch.Message.createSfuOfferMessage ( String  tag,
String  offerJson,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId,
String  remoteConnectionId 
)
static

Creates an SFU downstream "offer" message.

Parameters
tagThe tag.
offerJsonThe offer.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.
remoteConnectionIdThe remote connection identifier.

◆ createUnregisterMessage() [1/2]

static fm.liveswitch.Message fm.liveswitch.Message.createUnregisterMessage ( )
static

Creates an "unregister" message.

◆ createUnregisterMessage() [2/2]

static fm.liveswitch.Message fm.liveswitch.Message.createUnregisterMessage ( fm.liveswitch.ClientReport  clientReport,
fm.liveswitch.ChannelReport[]  channelReports 
)
static

Creates an "unregister" message.

Parameters
clientReportThe client report.
channelReportsThe channel reports.

◆ createUpdateMessage() [1/3]

static fm.liveswitch.Message fm.liveswitch.Message.createUpdateMessage ( String  configJson)
static

Creates an "update" message.

Parameters
configJsonThe config to send to the server.

◆ createUpdateMessage() [2/3]

static fm.liveswitch.Message fm.liveswitch.Message.createUpdateMessage ( String  configJson,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId 
)
static

Creates an "update" message.

Parameters
configJsonThe config to send to the server.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.

◆ createUpdateMessage() [3/3]

static fm.liveswitch.Message fm.liveswitch.Message.createUpdateMessage ( String  configJson,
String  remoteUserId,
String  remoteDeviceId,
String  remoteClientId,
String  remoteConnectionId 
)
static

Creates an "update" message.

Parameters
configJsonThe config to send to the server.
remoteUserIdThe remote user identifier.
remoteDeviceIdThe remote device identifier.
remoteClientIdThe remote client identifier.
remoteConnectionIdThe remote connection identifier.

◆ fromJson()

static fm.liveswitch.Message fm.liveswitch.Message.fromJson ( String  messageJson)
static

Deserializes an instance from JSON.

Parameters
messageJsonThe JSON to deserialize.
Returns
The deserialized message.

◆ fromJsonArray()

static fm.liveswitch.Message [] fm.liveswitch.Message.fromJsonArray ( String  messagesJson)
static

Deserializes an array of instances from JSON.

Parameters
messagesJsonThe JSON to deserialize.
Returns
The deserialized messages.

◆ getApiServiceId()

String fm.liveswitch.Message.getApiServiceId ( )

Gets the API Service identifier.

◆ getApiVersion()

String fm.liveswitch.Message.getApiVersion ( )

Gets the API Version.

◆ getApplicationId()

String fm.liveswitch.Message.getApplicationId ( )

Gets the application identifier.

◆ getChannelId()

String fm.liveswitch.Message.getChannelId ( )

Gets the channel identifier.

◆ getChannelReports()

fm.liveswitch.ChannelReport [] fm.liveswitch.Message.getChannelReports ( )

Gets the channel reports.

◆ getClientId()

String fm.liveswitch.Message.getClientId ( )

Gets the client identifier.

◆ getClientProtocol()

String fm.liveswitch.Message.getClientProtocol ( )

Gets the client protocol.

◆ getClientReports()

fm.liveswitch.ClientReport [] fm.liveswitch.Message.getClientReports ( )

Gets the client reports.

◆ getClientRoles()

String [] fm.liveswitch.Message.getClientRoles ( )

Gets the client roles.

◆ getClientTag()

String fm.liveswitch.Message.getClientTag ( )

Gets the client tag.

◆ getConnectionId()

String fm.liveswitch.Message.getConnectionId ( )

Gets the connection identifier.

◆ getConnectionTag()

String fm.liveswitch.Message.getConnectionTag ( )

Gets the connection tag.

◆ getConnectionType()

String fm.liveswitch.Message.getConnectionType ( )

Gets the connection type.

◆ getConnectorId()

String fm.liveswitch.Message.getConnectorId ( )

Gets the Connector identifer.

◆ getDeviceAlias()

String fm.liveswitch.Message.getDeviceAlias ( )

Gets the device alias.

◆ getDeviceId()

String fm.liveswitch.Message.getDeviceId ( )

Gets the device identifier.

◆ getMediaId()

String fm.liveswitch.Message.getMediaId ( )

Gets the broadcast identifier.

◆ getMediaServerId()

String fm.liveswitch.Message.getMediaServerId ( )

Gets the Media Server identifier.

◆ getPayload()

String fm.liveswitch.Message.getPayload ( )

Gets the payload.

◆ getPreferredMediaServerId()

String fm.liveswitch.Message.getPreferredMediaServerId ( )

Gets the preferred Media Server identifier.

◆ getRecordingMonitorId()

String fm.liveswitch.Message.getRecordingMonitorId ( )

Gets the Recording Monitor identifer.

◆ getRecordingMoverId()

String fm.liveswitch.Message.getRecordingMoverId ( )

Gets the Recording Mover identifer.

◆ getRecordingMuxerId()

String fm.liveswitch.Message.getRecordingMuxerId ( )

Gets the Recording Muxer identifer.

◆ getRegion()

String fm.liveswitch.Message.getRegion ( )

Gets the region.

◆ getRemoteClientId()

String fm.liveswitch.Message.getRemoteClientId ( )

Gets the remote client identifier.

◆ getRemoteConnectionId()

String fm.liveswitch.Message.getRemoteConnectionId ( )

Gets the remote connection identifier.

◆ getRemoteDeviceId()

String fm.liveswitch.Message.getRemoteDeviceId ( )

Gets the remote device identifier.

◆ getRemoteMediaId()

String fm.liveswitch.Message.getRemoteMediaId ( )

Gets the remote broadcast identifier.

◆ getRemoteUserId()

String fm.liveswitch.Message.getRemoteUserId ( )

Gets the remote user identifier.

◆ getTimestamp()

long fm.liveswitch.Message.getTimestamp ( )

Gets the message timestamp.

◆ getToken()

String fm.liveswitch.Message.getToken ( )

Gets the token.

◆ getTransactionId()

String fm.liveswitch.Message.getTransactionId ( )

Gets the transaction identifier.

◆ getType()

String fm.liveswitch.Message.getType ( )

Gets the type.

◆ getUserAlias()

String fm.liveswitch.Message.getUserAlias ( )

Gets the user alias.

◆ getUserId()

String fm.liveswitch.Message.getUserId ( )

Gets the user identifier.

◆ isError()

boolean fm.liveswitch.Message.isError ( String  errorType)

Gets whether this message is an error of a particular type.

Parameters
errorTypeThe error type.
Returns
true
if this message is an error of the particular type; otherwise,
false
.

◆ propertiesToJson() [1/2]

void fm.liveswitch.Message.propertiesToJson ( java.util.HashMap< String, String >  jsonObject)
protected

Serializes properties to JSON.

Parameters
jsonObjectThe JSON object.

◆ propertiesToJson() [2/2]

void fm.liveswitch.Message.propertiesToJson ( java.util.HashMap< String, String >  jsonObject,
boolean  forceTimestamp 
)
protected

Serializes properties to JSON.

Parameters
forceTimestampIndicates whether timestamp must be included regardless of where serialization occurs.
jsonObjectThe JSON object.

◆ propertyFromJson()

void fm.liveswitch.Message.propertyFromJson ( String  name,
String  valueJson 
)
protected

Deserializes a property from JSON.

Parameters
nameThe name.
valueJsonThe value in JSON format.

◆ setApiServiceId()

void fm.liveswitch.Message.setApiServiceId ( String  value)

Sets the API Service identifier.

◆ setApiVersion()

void fm.liveswitch.Message.setApiVersion ( String  value)

Sets the API Version.

◆ setApplicationId()

void fm.liveswitch.Message.setApplicationId ( String  value)

Sets the application identifier.

◆ setChannelId()

void fm.liveswitch.Message.setChannelId ( String  value)

Sets the channel identifier.

◆ setChannelReports()

void fm.liveswitch.Message.setChannelReports ( fm.liveswitch.ChannelReport[]  value)

Sets the channel reports.

◆ setClientId()

void fm.liveswitch.Message.setClientId ( String  value)

Sets the client identifier.

◆ setClientProtocol()

void fm.liveswitch.Message.setClientProtocol ( String  value)

Sets the client protocol.

◆ setClientReports()

void fm.liveswitch.Message.setClientReports ( fm.liveswitch.ClientReport[]  value)

Sets the client reports.

◆ setClientRoles()

void fm.liveswitch.Message.setClientRoles ( String[]  value)

Sets the client roles.

◆ setClientTag()

void fm.liveswitch.Message.setClientTag ( String  value)

Sets the client tag.

◆ setConnectionId()

void fm.liveswitch.Message.setConnectionId ( String  value)

Sets the connection identifier.

◆ setConnectionTag()

void fm.liveswitch.Message.setConnectionTag ( String  value)

Sets the connection tag.

◆ setConnectionType()

void fm.liveswitch.Message.setConnectionType ( String  value)

Sets the connection type.

◆ setConnectorId()

void fm.liveswitch.Message.setConnectorId ( String  value)

Sets the Connector identifer.

◆ setDeviceAlias()

void fm.liveswitch.Message.setDeviceAlias ( String  value)

Sets the device alias.

◆ setDeviceId()

void fm.liveswitch.Message.setDeviceId ( String  value)

Sets the device identifier.

◆ setMediaId()

void fm.liveswitch.Message.setMediaId ( String  value)

Sets the broadcast identifier.

◆ setMediaServerId()

void fm.liveswitch.Message.setMediaServerId ( String  value)

Sets the Media Server identifier.

◆ setPayload()

void fm.liveswitch.Message.setPayload ( String  value)

Sets the payload.

◆ setPreferredMediaServerId()

void fm.liveswitch.Message.setPreferredMediaServerId ( String  value)

Sets the preferred Media Server identifier.

◆ setRecordingMonitorId()

void fm.liveswitch.Message.setRecordingMonitorId ( String  value)

Sets the Recording Monitor identifer.

◆ setRecordingMoverId()

void fm.liveswitch.Message.setRecordingMoverId ( String  value)

Sets the Recording Mover identifer.

◆ setRecordingMuxerId()

void fm.liveswitch.Message.setRecordingMuxerId ( String  value)

Sets the Recording Muxer identifer.

◆ setRegion()

void fm.liveswitch.Message.setRegion ( String  value)

Sets the region.

◆ setRemoteClientId()

void fm.liveswitch.Message.setRemoteClientId ( String  value)

Sets the remote client identifier.

◆ setRemoteConnectionId()

void fm.liveswitch.Message.setRemoteConnectionId ( String  value)

Sets the remote connection identifier.

◆ setRemoteDeviceId()

void fm.liveswitch.Message.setRemoteDeviceId ( String  value)

Sets the remote device identifier.

◆ setRemoteMediaId()

void fm.liveswitch.Message.setRemoteMediaId ( String  value)

Sets the remote broadcast identifier.

◆ setRemoteUserId()

void fm.liveswitch.Message.setRemoteUserId ( String  value)

Sets the remote user identifier.

◆ setTimestamp()

void fm.liveswitch.Message.setTimestamp ( long  value)

Sets the message timestamp.

◆ setToken()

void fm.liveswitch.Message.setToken ( String  value)

Sets the token.

◆ setTransactionId()

void fm.liveswitch.Message.setTransactionId ( String  value)

Sets the transaction identifier.

◆ setType()

void fm.liveswitch.Message.setType ( String  value)

Sets the type.

◆ setUserAlias()

void fm.liveswitch.Message.setUserAlias ( String  value)

Sets the user alias.

◆ setUserId()

void fm.liveswitch.Message.setUserId ( String  value)

Sets the user identifier.

◆ toJson() [1/3]

String fm.liveswitch.Message.toJson ( )

Serializes this instance to JSON.

◆ toJson() [2/3]

static String fm.liveswitch.Message.toJson ( fm.liveswitch.Message  message)
static

Serializes an instance to JSON.

Parameters
messageThe message to serialize.
Returns
The serialized JSON.

◆ toJson() [3/3]

static String fm.liveswitch.Message.toJson ( fm.liveswitch.Message  message,
final boolean  forceTimestamp 
)
static

Serializes an instance to JSON and forces timestamp regardless of what generates Json.

Parameters
messageThe message to serialize.
forceTimestampIndicates whether timestamp must be included regardless of where serialization occurs.
Returns
The serialized JSON.

◆ toJsonArray()

static String fm.liveswitch.Message.toJsonArray ( fm.liveswitch.Message[]  messages)
static

Serializes an array of instances to JSON.

Parameters
messagesThe messages to serialize.
Returns
The serialized JSON.