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...

fm.liveswitch.NullableInteger	getConnectionLayoutPriority ()
	Gets the connection LayoutPriority. More...

String	getConnectionLayoutZone ()
	Gets the connection LayoutZone. 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	getIceServers ()
	Gets the payload. More...

boolean	getIsHiddenObserver ()
	Gets if the offerer is a hidden observer. More...

String	getMediaId ()
	Gets the broadcast identifier. More...

String	getMediaServerId ()
	Gets the Media Server identifier. More...

boolean	getNoHostCandidates ()
	Gets the value indicating whether the client should avoid using local host ICE candidates. More...

String	getPayload ()
	Gets the payload. More...

String	getPreferredMediaServerId ()
	Gets the preferred Media Server identifier. More...

String	getPreferredWebSocketMediaServerId ()
	Gets the preferred WebSocket 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...

boolean	getRequestIceServers ()
	Gets the value indicating whether ICE Servers have been requested. 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...

String	getWebSocketMediaServerId ()
	Gets the Media Server 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	setConnectionLayoutPriority (fm.liveswitch.NullableInteger value)
	Sets the connection LayoutPriority. More...

void	setConnectionLayoutZone (String value)
	Sets the connection LayoutZone. 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	setIceServers (String value)
	Sets the payload. More...

void	setIsHiddenObserver (boolean value)
	Sets if the offerer is a hidden observer. More...

void	setMediaId (String value)
	Sets the broadcast identifier. More...

void	setMediaServerId (String value)
	Sets the Media Server identifier. More...

void	setNoHostCandidates (boolean value)
	Sets the value indicating whether the client should avoid using local host ICE candidates. More...

void	setPayload (String value)
	Sets the payload. More...

void	setPreferredMediaServerId (String value)
	Sets the preferred Media Server identifier. More...

void	setPreferredWebSocketMediaServerId (String value)
	Sets the preferred WebSocket 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	setRequestIceServers (boolean value)
	Sets the value indicating whether ICE Servers have been requested. 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...

void	setWebSocketMediaServerId (String value)
	Sets the Media Server 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	createLayoutMessage (String configJson, String remoteUserId, String remoteDeviceId, String remoteClientId, String remoteConnectionId)
	Creates a "layout" message. More...

static fm.liveswitch.Message	createLeaveMessage (String channelId, fm.liveswitch.ChannelReport channelReport)
	Creates a "leave" message. More...

static fm.liveswitch.Message	createMcuOfferMessage (String layoutZone, fm.liveswitch.NullableInteger layoutPriority, String tag, String offerJson)
	Creates an MCU "offer" 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 layoutZone, fm.liveswitch.NullableInteger layoutPriority, String tag, String offerJson)
	Creates an SFU upstream "offer" 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	createSimulcastNotificationMessage (fm.liveswitch.SimulcastNotification simulcastNotification)
	Creates a "simulcastNotification" message. More...

static fm.liveswitch.Message	createSimulcastNotificationMessage (fm.liveswitch.SimulcastNotification[] simulcastNotifications)
	Creates a "simulcastNotification" 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

candidateJson The 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

error The 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

error	The error type.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The 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

channelId	The channel to join.
token	The 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

channelId	The channel identifier.
clientId	The 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

remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The remote client identifier.
remoteConnectionId	The remote connection identifier.

◆ createLayoutMessage()

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

static

Creates a "layout" message.

Parameters

configJson	The layout config to send to the server.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The remote client identifier.
remoteConnectionId	The remote connection identifier.

◆ createLeaveMessage()

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

static

Creates a "leave" message.

Parameters

channelId	The channel to leave.
channelReport	The channel report.

◆ createMcuOfferMessage() [1/2]

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

static

Creates an MCU "offer" message.

Parameters

tag	The tag
layoutZone	The connection LayoutZone
layoutPriority	The connection LayoutPriority
offerJson	The offer.

◆ createMcuOfferMessage() [2/2]

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

static

Creates an MCU "offer" message.

Parameters

tag	The tag.
offerJson	The offer.

◆ createMessageMessage() [1/4]

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

static

Creates a "message" message.

Parameters

message The message.

◆ createMessageMessage() [2/4]

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

static

Creates a "message" message.

Parameters

message	The message.
remoteUserId	The 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

message	The message.
remoteUserId	The remote user identifier.
remoteDeviceId	The 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

message	The message.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The 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

tag	The tag.
answerJson	The answer.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The 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

candidateJson	The candidate.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The remote client identifier.

◆ createPeerCloseMessage()

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

static

Creates a "close" message.

Parameters

remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The 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

tag	The tag.
offerJson	The offer.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The 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

remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The remote client identifier.
remoteConnectionId	The 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

applicationId	The application identifier.
userId	The user identifier.
userAlias	The user alias.
deviceId	The device identifier.
deviceAlias	The device alias.
clientId	The client identifier.
clientTag	The client tag.
clientRoles	The client roles.
region	The region.
token	The auth token.

◆ createRtcpDataChannelSignallingActivationMessage()

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

static

Creates a "activateInbandSignalling" message.

◆ createSfuOfferMessage() [1/4]

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

static

Creates an SFU upstream "offer" message.

Parameters

tag	The tag
layoutZone	The connection LayoutZone
layoutPriority	The connection LayoutPriority
offerJson	The offer.

◆ createSfuOfferMessage() [2/4]

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

static

Creates an SFU upstream "offer" message.

Parameters

tag	The tag.
offerJson	The offer.

◆ createSfuOfferMessage() [3/4]

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

static

Creates an SFU downstream "offer" message.

Parameters

tag	The tag.
offerJson	The offer.
remoteMediaId	The remote media identifier.

◆ createSfuOfferMessage() [4/4]

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

tag	The tag.
offerJson	The offer.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The remote client identifier.
remoteConnectionId	The remote connection identifier.

◆ createSimulcastNotificationMessage() [1/2]

static fm.liveswitch.Message fm.liveswitch.Message.createSimulcastNotificationMessage ( fm.liveswitch.SimulcastNotification simulcastNotification )

static

Creates a "simulcastNotification" message.

◆ createSimulcastNotificationMessage() [2/2]

static fm.liveswitch.Message fm.liveswitch.Message.createSimulcastNotificationMessage ( fm.liveswitch.SimulcastNotification[] simulcastNotifications )

static

Creates a "simulcastNotification" message.

◆ 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

clientReport	The client report.
channelReports	The channel reports.

◆ createUpdateMessage() [1/3]

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

static

Creates an "update" message.

Parameters

configJson The 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

configJson	The config to send to the server.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The 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

configJson	The config to send to the server.
remoteUserId	The remote user identifier.
remoteDeviceId	The remote device identifier.
remoteClientId	The remote client identifier.
remoteConnectionId	The remote connection identifier.

◆ fromJson()

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

static

Deserializes an instance from JSON.

Parameters

messageJson The 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

messagesJson The 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.

◆ getConnectionLayoutPriority()

fm.liveswitch.NullableInteger fm.liveswitch.Message.getConnectionLayoutPriority ( )

Gets the connection LayoutPriority.

◆ getConnectionLayoutZone()

String fm.liveswitch.Message.getConnectionLayoutZone ( )

Gets the connection LayoutZone.

◆ 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.

◆ getIceServers()

String fm.liveswitch.Message.getIceServers ( )

Gets the payload.

◆ getIsHiddenObserver()

boolean fm.liveswitch.Message.getIsHiddenObserver ( )

Gets if the offerer is a hidden observer.

◆ getMediaId()

String fm.liveswitch.Message.getMediaId ( )

Gets the broadcast identifier.

◆ getMediaServerId()

String fm.liveswitch.Message.getMediaServerId ( )

Gets the Media Server identifier.

◆ getNoHostCandidates()

boolean fm.liveswitch.Message.getNoHostCandidates ( )

Gets the value indicating whether the client should avoid using local host ICE candidates.

Client can override this request.

◆ getPayload()

String fm.liveswitch.Message.getPayload ( )

Gets the payload.

◆ getPreferredMediaServerId()

String fm.liveswitch.Message.getPreferredMediaServerId ( )

Gets the preferred Media Server identifier.

◆ getPreferredWebSocketMediaServerId()

String fm.liveswitch.Message.getPreferredWebSocketMediaServerId ( )

Gets the preferred WebSocket 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.

◆ getRequestIceServers()

boolean fm.liveswitch.Message.getRequestIceServers ( )

Gets the value indicating whether ICE Servers have been requested.

◆ 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.

◆ getWebSocketMediaServerId()

String fm.liveswitch.Message.getWebSocketMediaServerId ( )

Gets the Media Server identifier.

◆ isError()

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

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

Parameters

errorType The 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

jsonObject The JSON object.

◆ propertiesToJson() [2/2]

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

protected

Serializes properties to JSON.

Parameters

forceTimestamp	Indicates whether timestamp must be included regardless of where serialization occurs.
jsonObject	The JSON object.

◆ propertyFromJson()

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

protected

Deserializes a property from JSON.

Parameters

name	The name.
valueJson	The 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.

◆ setConnectionLayoutPriority()

void fm.liveswitch.Message.setConnectionLayoutPriority ( fm.liveswitch.NullableInteger value )

Sets the connection LayoutPriority.

◆ setConnectionLayoutZone()

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

Sets the connection LayoutZone.

◆ 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.

◆ setIceServers()

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

Sets the payload.

◆ setIsHiddenObserver()

void fm.liveswitch.Message.setIsHiddenObserver ( boolean value )

Sets if the offerer is a hidden observer.

◆ 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.

◆ setNoHostCandidates()

void fm.liveswitch.Message.setNoHostCandidates ( boolean value )

Sets the value indicating whether the client should avoid using local host ICE candidates.

Client can override this request.

◆ 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.

◆ setPreferredWebSocketMediaServerId()

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

Sets the preferred WebSocket 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.

◆ setRequestIceServers()

void fm.liveswitch.Message.setRequestIceServers ( boolean value )

Sets the value indicating whether ICE Servers have been requested.

◆ 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.

◆ setWebSocketMediaServerId()

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

Sets the Media Server 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

message The 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

message	The message to serialize.
forceTimestamp	Indicates 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

messages The messages to serialize.

Returns: The serialized JSON.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ clone()

◆ createBitrateNotificationMessage() [1/2]

◆ createBitrateNotificationMessage() [2/2]

◆ createBitrateRequestMessage() [1/2]

◆ createBitrateRequestMessage() [2/2]

◆ createCancelInviteMessage()

◆ createCandidateMessage()

◆ createCloseMessage()

◆ createDtmfTonesMessage()

◆ createErrorMessage() [1/2]

◆ createErrorMessage() [2/2]

◆ createEventMessage()

◆ createIceServersMessage()

◆ createInviteMessage()

◆ createJoinMessage()

◆ createKeyFrameRequestMessage()

◆ createKickMessage() [1/2]

◆ createKickMessage() [2/2]

◆ createLayoutMessage()

◆ createLeaveMessage()

◆ createMcuOfferMessage() [1/2]

◆ createMcuOfferMessage() [2/2]

◆ createMessageMessage() [1/4]

◆ createMessageMessage() [2/4]

◆ createMessageMessage() [3/4]

◆ createMessageMessage() [4/4]

◆ createPeerAnswerMessage()

◆ createPeerCandidateMessage()

◆ createPeerCloseMessage()

◆ createPeerOfferMessage()

◆ createPeerRejectMessage()

◆ createRegisterMessage()

◆ createRtcpDataChannelSignallingActivationMessage()

◆ createSfuOfferMessage() [1/4]

◆ createSfuOfferMessage() [2/4]

◆ createSfuOfferMessage() [3/4]

◆ createSfuOfferMessage() [4/4]

◆ createSimulcastNotificationMessage() [1/2]

◆ createSimulcastNotificationMessage() [2/2]

◆ createUnregisterMessage() [1/2]

◆ createUnregisterMessage() [2/2]

◆ createUpdateMessage() [1/3]

◆ createUpdateMessage() [2/3]

◆ createUpdateMessage() [3/3]

◆ fromJson()

◆ fromJsonArray()

◆ getApiServiceId()

◆ getApiVersion()

◆ getApplicationId()

◆ getChannelId()

◆ getChannelReports()

◆ getClientId()

◆ getClientProtocol()

◆ getClientReports()

◆ getClientRoles()

◆ getClientTag()

◆ getConnectionId()

◆ getConnectionLayoutPriority()

◆ getConnectionLayoutZone()

◆ getConnectionTag()

◆ getConnectionType()

◆ getConnectorId()

◆ getDeviceAlias()

◆ getDeviceId()

◆ getIceServers()

◆ getIsHiddenObserver()

◆ getMediaId()

◆ getMediaServerId()

◆ getNoHostCandidates()

◆ getPayload()

◆ getPreferredMediaServerId()

◆ getPreferredWebSocketMediaServerId()

◆ getRecordingMonitorId()

◆ getRecordingMoverId()

◆ getRecordingMuxerId()