fm.liveswitch.ConnectionInfo Class Reference

Connection information. More...

Public Member Functions
	ConnectionInfo ()
	Initializes a new instance of the fm.liveswitch.ConnectionInfo class. More...
	ConnectionInfo (String userId, String deviceId, String clientId, String idValue, String tag, String type, String mediaId, boolean localAudioMuted, boolean localVideoMuted, String audioDirection, String videoDirection, String dataDirection, fm.liveswitch.FormatInfo[] audioFormats, fm.liveswitch.FormatInfo[] videoFormats)
	Initializes a new instance of the fm.liveswitch.ConnectionInfo class. More...
	ConnectionInfo (String userId, String userAlias, String deviceId, String deviceAlias, String clientId, String clientTag, String[] clientRoles, String clientProtocol, String idValue, String tag, String type, String mediaId, boolean localAudioMuted, boolean localVideoMuted, String audioDirection, String videoDirection, String dataDirection, fm.liveswitch.FormatInfo[] audioFormats, fm.liveswitch.FormatInfo[] videoFormats, String layoutZone, fm.liveswitch.NullableInteger layoutPriority)
	Initializes a new instance of the fm.liveswitch.ConnectionInfo class. More...
fm.liveswitch.ClientInfo	createClientInfo ()
	Creates a client info object with details from this connection info object. More...
String	getApplicationId ()
	Gets the application identifier. More...
String	getAudioDirection ()
	Gets the audio stream direction. More...
fm.liveswitch.FormatInfo[]	getAudioFormats ()
	Gets the audio formats, if applicable. More...
fm.liveswitch.MediaStreamInfo	getAudioStream ()
	Gets the first connection audio stream. More...
fm.liveswitch.MediaStreamInfo[]	getAudioStreams ()
	Gets the connection audio streams. More...
String	getChannelId ()
	Gets the channel identifier. More...
String	getClientId ()
	Gets the client identifier. More...
String	getClientProtocol ()
	Gets the client protocol. More...
String[]	getClientRoles ()
	Gets the client roles. More...
String	getClientTag ()
	Gets the client tag. More...
String	getDataDirection ()
	Gets the data stream direction. More...
fm.liveswitch.DataStreamInfo	getDataStream ()
	Gets the connection data stream. More...
String	getDeviceAlias ()
	Gets the device alias. More...
String	getDeviceId ()
	Gets the device identifier. More...
fm.liveswitch.Error	getError ()
	Gets the connection error, if an error exists. More...
String	getExternalId ()
	Gets the connection external identifier. More...
boolean	getHasAudio ()
	Gets a value indicating whether the connection has an audio stream. More...
boolean	getHasData ()
	Gets a value indicating whether the connection has a data stream. More...
boolean	getHasVideo ()
	Gets a value indicating whether the connection has a video stream. More...
boolean	getIsSip ()
	Gets whether the client is connected via SIP. More...
fm.liveswitch.NullableInteger	getLayoutPriority ()
	Gets the layout priority. More...
String	getLayoutZone ()
	Gets the layout zone. More...
boolean	getLocalAudioDisabled ()
	Gets if local audio is disabled. More...
boolean	getLocalAudioMuted ()
	Gets whether the local audio is muted. More...
boolean	getLocalAudioUnmuteDisabled ()
	Gets whether the local audio cannot be unmuted. More...
boolean	getLocalVideoDisabled ()
	Gets if local video is disabled. More...
boolean	getLocalVideoMuted ()
	Gets whether the local video is muted. More...
boolean	getLocalVideoUnmuteDisabled ()
	Gets whether the local video cannot be unmuted. More...
String	getMediaId ()
	Gets the media identifier, for MCU or SFU upstream connections. More...
boolean	getRecording ()
	Gets whether the connection is recording. More...
String	getRecordingMode ()
	Gets the connection recording mode. More...
String	getRecordingTag ()
	Gets the connection recording tag. More...
boolean	getRemoteAudioDisabled ()
	Gets if remote audio is disabled. More...
boolean	getRemoteAudioMuted ()
	Gets if remote audio is muted. More...
String	getRemoteConnectionId ()
	Gets the remote connection identifier, for peer or SFU downstream connections. More...
String	getRemoteMediaId ()
	Gets the remote media identifier, for SFU downstream connections. More...
boolean	getRemoteVideoDisabled ()
	Gets if remote video is disabled. More...
boolean	getRemoteVideoMuted ()
	Gets if remote video is muted. More...
String	getState ()
	Gets the connection state. More...
String	getTag ()
	Gets the connection tag. More...
fm.liveswitch.TransportInfo[]	getTransports ()
	Gets the connection transport information. More...
String	getType ()
	Gets the connection type. More...
String	getUserAlias ()
	Gets the user alias. More...
String	getUserId ()
	Gets the user identifier. More...
boolean	getUseWebSocketsForMedia ()
	Gets if we should use websockets for sending media. More...
String	getVideoDirection ()
	Gets the video stream direction. More...
fm.liveswitch.FormatInfo[]	getVideoFormats ()
	Gets the video formats, if applicable. More...
fm.liveswitch.MediaStreamInfo	getVideoStream ()
	Gets the first connection video stream. More...
fm.liveswitch.MediaStreamInfo[]	getVideoStreams ()
	Gets the connection video streams. More...
boolean	isEquivalent (fm.liveswitch.ConnectionInfo connectionInfo)
	Tests for equivalency. More...
boolean	isEquivalent (String userId, String deviceId, String clientId, String idValue)
	Tests for equivalency. More...
void	setApplicationId (String value)
	Sets the application identifier. More...
void	setAudioStream (fm.liveswitch.MediaStreamInfo value)
	Sets the first connection audio stream. More...
void	setAudioStreams (fm.liveswitch.MediaStreamInfo[] value)
	Sets the connection audio streams. More...
void	setChannelId (String value)
	Sets the channel identifier. More...
void	setClientId (String value)
	Sets the client identifier. More...
void	setClientProtocol (String value)
	Sets the client protocol. More...
void	setClientRoles (String[] value)
	Sets the client roles. More...
void	setClientTag (String value)
	Sets the client tag. More...
void	setDataStream (fm.liveswitch.DataStreamInfo value)
	Sets the connection data stream. More...
void	setDeviceAlias (String value)
	Sets the device alias. More...
void	setDeviceId (String value)
	Sets the device identifier. More...
void	setError (fm.liveswitch.Error value)
	Sets the connection error, if an error exists. More...
void	setExternalId (String value)
	Sets the connection external identifier. More...
void	setLayoutPriority (fm.liveswitch.NullableInteger value)
	Sets the layout priority. More...
void	setLayoutZone (String value)
	Sets the layout zone. More...
void	setMediaId (String value)
	Sets the media identifier, for MCU or SFU upstream connections. More...
void	setRecording (boolean value)
	Sets whether the connection is recording. More...
void	setRecordingMode (String value)
	Sets the connection recording mode. More...
void	setRecordingTag (String value)
	Sets the connection recording tag. More...
void	setRemoteAudioMuted (boolean value)
	Sets if remote audio is muted. More...
void	setRemoteConnectionId (String value)
	Sets the remote connection identifier, for peer or SFU downstream connections. More...
void	setRemoteMediaId (String value)
	Sets the remote media identifier, for SFU downstream connections. More...
void	setRemoteVideoMuted (boolean value)
	Sets if remote video is muted. More...
void	setState (String value)
	Sets the connection state. More...
void	setTag (String value)
	Sets the connection tag. More...
void	setTransports (fm.liveswitch.TransportInfo[] value)
	Sets the connection transport information. More...
void	setType (String value)
	Sets the connection type. More...
void	setUserAlias (String value)
	Sets the user alias. More...
void	setUserId (String value)
	Sets the user identifier. More...
void	setUseWebSocketsForMedia (boolean value)
	Sets if we should use websockets for sending media. More...
void	setVideoStream (fm.liveswitch.MediaStreamInfo value)
	Sets the first connection video stream. More...
void	setVideoStreams (fm.liveswitch.MediaStreamInfo[] value)
	Sets the connection video streams. More...
boolean	shouldSerializeAudioDirection ()
	Gets whether to serialize the legacy audio direction property. More...
boolean	shouldSerializeAudioFormats ()
	Gets whether to serialize the legacy audio formats property. More...
boolean	shouldSerializeDataDirection ()
	Gets whether to serialize the legacy data direction property. More...
boolean	shouldSerializeLocalAudioMuted ()
	Gets whether to serialize the legacy local audio muted property. More...
boolean	shouldSerializeLocalVideoMuted ()
	Gets whether to serialize the legacy local video muted property. More...
boolean	shouldSerializeVideoDirection ()
	Gets whether to serialize the legacy video direction property. More...
boolean	shouldSerializeVideoFormats ()
	Gets whether to serialize the legacy video formats property. More...
String	toJson ()
	Serializes this instance to Json. More...
Public Member Functions inherited from fm.liveswitch.Info
String	getId ()
	Gets the identifier. More...
void	setId (String value)
	Sets the identifier. More...

Static Public Member Functions
static fm.liveswitch.ConnectionInfo	fromJson (String connectionInfoJson)
	Deserializes Json to a ConnectionInfo. More...
static fm.liveswitch.ConnectionInfo[]	fromJsonArray (String connectionInfosJson)
	Deserializes an array of instances from JSON. More...
static String	toJson (fm.liveswitch.ConnectionInfo connectionInfo)
	Serializes an instance to Json. More...
static String	toJsonArray (fm.liveswitch.ConnectionInfo[] connectionInfos)
	Serializes an array of instances to JSON. More...
Static Public Member Functions inherited from fm.liveswitch.Info
static< T extends fm.liveswitch.IEquivalent< T > T[]	processArray (T[] newValues, T[] oldValues)
	Processes an array for an info. More...
static fm.liveswitch.NullableBoolean	processBoolean (boolean newValue, boolean oldValue)
	Processes a boolean for an info. More...
static boolean[]	processBooleanArray (boolean[] newValues, boolean[] oldValues)
	Processes a boolean array for an info. More...
static fm.liveswitch.NullableDouble	processDouble (double newValue, double oldValue)
	Processes a double for an info. More...
static fm.liveswitch.NullableFloat	processFloat (float newValue, float oldValue)
	Processes a float for an info. More...
static float[]	processFloatArray (float[] newValues, float[] oldValues)
	Processes a float array for an info. More...
static double[]	processFloatArray (double[] newValues, double[] oldValues)
	Processes a double array for an info. More...
static fm.liveswitch.NullableInteger	processInteger (int newValue, int oldValue)
	Processes an integer for an info. More...
static int[]	processIntegerArray (int[] newValues, int[] oldValues)
	Processes a integer array for an info. More...
static fm.liveswitch.NullableLong	processLong (long newValue, long oldValue)
	Processes a long for an info. More...
static long[]	processLongArray (long[] newValues, long[] oldValues)
	Processes a long array for an info. More...
static< T extends Object &fm.liveswitch.IEquivalent< T > T	processObject (T newValue, T oldValue)
	Processes an object for an info. More...
static fm.liveswitch.NullableShort	processShort (short newValue, short oldValue)
	Processes a short for an info. More...
static short[]	processShortArray (short[] newValues, short[] oldValues)
	Processes a short array for an info. More...
static String	processString (String newValue, String oldValue)
	Processes a string for an info. More...

Protected Member Functions
void	deserializeProperties (String key, String valueJson)
	Deserializes the properties. More...
void	serializeProperties (java.util.HashMap< String, String > jsonObject)
	Serializes the properties. More...
Protected Member Functions inherited from fm.liveswitch.Info
	Info ()

Detailed Description

Connection information.

Constructor & Destructor Documentation

ConnectionInfo() [1/3]

fm.liveswitch.ConnectionInfo.ConnectionInfo

(

)

Initializes a new instance of the fm.liveswitch.ConnectionInfo class.

ConnectionInfo() [2/3]

fm.liveswitch.ConnectionInfo.ConnectionInfo	(	String	userId,
		String	deviceId,
		String	clientId,
		String	idValue,
		String	tag,
		String	type,
		String	mediaId,
		boolean	localAudioMuted,
		boolean	localVideoMuted,
		String	audioDirection,
		String	videoDirection,
		String	dataDirection,
		fm.liveswitch.FormatInfo[]	audioFormats,
		fm.liveswitch.FormatInfo[]	videoFormats
	)

Initializes a new instance of the fm.liveswitch.ConnectionInfo class.

Parameters

userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
idValue	The connection identifier.
tag	The connection tag.
type	The connection type.
mediaId	The media identifier.
localAudioMuted	The audio muted boolean.
localVideoMuted	The video muted boolean.
audioDirection	The audio direction.
videoDirection	The video direction.
dataDirection	The data direction.
audioFormats	The audio formats.
videoFormats	The video formats.

ConnectionInfo() [3/3]

fm.liveswitch.ConnectionInfo.ConnectionInfo	(	String	userId,
		String	userAlias,
		String	deviceId,
		String	deviceAlias,
		String	clientId,
		String	clientTag,
		String[]	clientRoles,
		String	clientProtocol,
		String	idValue,
		String	tag,
		String	type,
		String	mediaId,
		boolean	localAudioMuted,
		boolean	localVideoMuted,
		String	audioDirection,
		String	videoDirection,
		String	dataDirection,
		fm.liveswitch.FormatInfo[]	audioFormats,
		fm.liveswitch.FormatInfo[]	videoFormats,
		String	layoutZone,
		fm.liveswitch.NullableInteger	layoutPriority
	)

Initializes a new instance of the fm.liveswitch.ConnectionInfo class.

Parameters

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.
clientProtocol	The client protocol.
idValue	The connection identifier.
tag	The connection tag.
type	The connection type.
mediaId	The media identifier.
localAudioMuted	The audio muted boolean.
localVideoMuted	The video muted boolean.
audioDirection	The audio direction.
videoDirection	The video direction.
dataDirection	The data direction.
audioFormats	The audio formats.
videoFormats	The video formats.
layoutZone	The layout zone.
layoutPriority	The layout priority.

Member Function Documentation

createClientInfo()

fm.liveswitch.ClientInfo fm.liveswitch.ConnectionInfo.createClientInfo

(

)

Creates a client info object with details from this connection info object.

deserializeProperties()

void fm.liveswitch.ConnectionInfo.deserializeProperties ( String  key, String  valueJson  )

protected

Deserializes the properties.

Parameters

key	The key.
valueJson	The value in JSON format.

Reimplemented from fm.liveswitch.Info.

fromJson()

static fm.liveswitch.ConnectionInfo fm.liveswitch.ConnectionInfo.fromJson ( String  connectionInfoJson )

static

Deserializes Json to a ConnectionInfo.

Parameters

connectionInfoJson

The serialized Json.

Returns

The deserialized ConnectionInfo.

fromJsonArray()

static fm.liveswitch.ConnectionInfo [] fm.liveswitch.ConnectionInfo.fromJsonArray ( String  connectionInfosJson )

static

Deserializes an array of instances from JSON.

Parameters

connectionInfosJson

The JSON to deserialize.

Returns

The deserialized connection infos.

getApplicationId()

String fm.liveswitch.ConnectionInfo.getApplicationId

(

)

Gets the application identifier.

getAudioDirection()

String fm.liveswitch.ConnectionInfo.getAudioDirection

(

)

Gets the audio stream direction.

getAudioFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.ConnectionInfo.getAudioFormats

(

)

Gets the audio formats, if applicable.

getAudioStream()

fm.liveswitch.MediaStreamInfo fm.liveswitch.ConnectionInfo.getAudioStream

(

)

Gets the first connection audio stream.

getAudioStreams()

fm.liveswitch.MediaStreamInfo [] fm.liveswitch.ConnectionInfo.getAudioStreams

(

)

Gets the connection audio streams.

getChannelId()

String fm.liveswitch.ConnectionInfo.getChannelId

(

)

Gets the channel identifier.

getClientId()

String fm.liveswitch.ConnectionInfo.getClientId

(

)

Gets the client identifier.

getClientProtocol()

String fm.liveswitch.ConnectionInfo.getClientProtocol

(

)

Gets the client protocol.

getClientRoles()

String [] fm.liveswitch.ConnectionInfo.getClientRoles

(

)

Gets the client roles.

getClientTag()

String fm.liveswitch.ConnectionInfo.getClientTag

(

)

Gets the client tag.

getDataDirection()

String fm.liveswitch.ConnectionInfo.getDataDirection

(

)

Gets the data stream direction.

Obsolete.

getDataStream()

fm.liveswitch.DataStreamInfo fm.liveswitch.ConnectionInfo.getDataStream

(

)

Gets the connection data stream.

getDeviceAlias()

String fm.liveswitch.ConnectionInfo.getDeviceAlias

(

)

Gets the device alias.

getDeviceId()

String fm.liveswitch.ConnectionInfo.getDeviceId

(

)

Gets the device identifier.

getError()

fm.liveswitch.Error fm.liveswitch.ConnectionInfo.getError

(

)

Gets the connection error, if an error exists.

getExternalId()

String fm.liveswitch.ConnectionInfo.getExternalId

(

)

Gets the connection external identifier.

getHasAudio()

boolean fm.liveswitch.ConnectionInfo.getHasAudio

(

)

Gets a value indicating whether the connection has an audio stream.

getHasData()

boolean fm.liveswitch.ConnectionInfo.getHasData

(

)

Gets a value indicating whether the connection has a data stream.

getHasVideo()

boolean fm.liveswitch.ConnectionInfo.getHasVideo

(

)

Gets a value indicating whether the connection has a video stream.

getIsSip()

boolean fm.liveswitch.ConnectionInfo.getIsSip

(

)

Gets whether the client is connected via SIP.

getLayoutPriority()

fm.liveswitch.NullableInteger fm.liveswitch.ConnectionInfo.getLayoutPriority

(

)

Gets the layout priority.

getLayoutZone()

String fm.liveswitch.ConnectionInfo.getLayoutZone

(

)

Gets the layout zone.

getLocalAudioDisabled()

boolean fm.liveswitch.ConnectionInfo.getLocalAudioDisabled

(

)

Gets if local audio is disabled.

getLocalAudioMuted()

boolean fm.liveswitch.ConnectionInfo.getLocalAudioMuted

(

)

Gets whether the local audio is muted.

Returns true if the local audio is muted and false otherwise.

getLocalAudioUnmuteDisabled()

boolean fm.liveswitch.ConnectionInfo.getLocalAudioUnmuteDisabled

(

)

Gets whether the local audio cannot be unmuted.

Returns true if the local audio cannot be unmuted and false otherwise.

getLocalVideoDisabled()

boolean fm.liveswitch.ConnectionInfo.getLocalVideoDisabled

(

)

Gets if local video is disabled.

getLocalVideoMuted()

boolean fm.liveswitch.ConnectionInfo.getLocalVideoMuted

(

)

Gets whether the local video is muted.

Returns true if the local video is muted and false otherwise.

getLocalVideoUnmuteDisabled()

boolean fm.liveswitch.ConnectionInfo.getLocalVideoUnmuteDisabled

(

)

Gets whether the local video cannot be unmuted.

Returns true if the local video cannot be unmuted and false otherwise.

getMediaId()

String fm.liveswitch.ConnectionInfo.getMediaId

(

)

Gets the media identifier, for MCU or SFU upstream connections.

getRecording()

boolean fm.liveswitch.ConnectionInfo.getRecording

(

)

Gets whether the connection is recording.

getRecordingMode()

String fm.liveswitch.ConnectionInfo.getRecordingMode

(

)

Gets the connection recording mode.

getRecordingTag()

String fm.liveswitch.ConnectionInfo.getRecordingTag

(

)

Gets the connection recording tag.

getRemoteAudioDisabled()

boolean fm.liveswitch.ConnectionInfo.getRemoteAudioDisabled

(

)

Gets if remote audio is disabled.

getRemoteAudioMuted()

boolean fm.liveswitch.ConnectionInfo.getRemoteAudioMuted

(

)

Gets if remote audio is muted.

getRemoteConnectionId()

String fm.liveswitch.ConnectionInfo.getRemoteConnectionId

(

)

Gets the remote connection identifier, for peer or SFU downstream connections.

getRemoteMediaId()

String fm.liveswitch.ConnectionInfo.getRemoteMediaId

(

)

Gets the remote media identifier, for SFU downstream connections.

getRemoteVideoDisabled()

boolean fm.liveswitch.ConnectionInfo.getRemoteVideoDisabled

(

)

Gets if remote video is disabled.

getRemoteVideoMuted()

boolean fm.liveswitch.ConnectionInfo.getRemoteVideoMuted

(

)

Gets if remote video is muted.

getState()

String fm.liveswitch.ConnectionInfo.getState

(

)

Gets the connection state.

getTag()

String fm.liveswitch.ConnectionInfo.getTag

(

)

Gets the connection tag.

getTransports()

fm.liveswitch.TransportInfo [] fm.liveswitch.ConnectionInfo.getTransports

(

)

Gets the connection transport information.

This will be

null  

if BUNDLE is inactive.

getType()

String fm.liveswitch.ConnectionInfo.getType

(

)

Gets the connection type.

getUserAlias()

String fm.liveswitch.ConnectionInfo.getUserAlias

(

)

Gets the user alias.

getUserId()

String fm.liveswitch.ConnectionInfo.getUserId

(

)

Gets the user identifier.

getUseWebSocketsForMedia()

boolean fm.liveswitch.ConnectionInfo.getUseWebSocketsForMedia

(

)

Gets if we should use websockets for sending media.

getVideoDirection()

String fm.liveswitch.ConnectionInfo.getVideoDirection

(

)

Gets the video stream direction.

getVideoFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.ConnectionInfo.getVideoFormats

(

)

Gets the video formats, if applicable.

getVideoStream()

fm.liveswitch.MediaStreamInfo fm.liveswitch.ConnectionInfo.getVideoStream

(

)

Gets the first connection video stream.

getVideoStreams()

fm.liveswitch.MediaStreamInfo [] fm.liveswitch.ConnectionInfo.getVideoStreams

(

)

Gets the connection video streams.

isEquivalent() [1/2]

boolean fm.liveswitch.ConnectionInfo.isEquivalent

(

fm.liveswitch.ConnectionInfo

connectionInfo

)

Tests for equivalency.

Parameters

connectionInfo

The connection information.

Returns

true  

if equivalent; otherwise,

false  

.

isEquivalent() [2/2]

boolean fm.liveswitch.ConnectionInfo.isEquivalent	(	String	userId,
		String	deviceId,
		String	clientId,
		String	idValue
	)

Tests for equivalency.

Parameters

userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
idValue	The connection identifier.

Returns

true  

if equivalent; otherwise,

false  

.

serializeProperties()

void fm.liveswitch.ConnectionInfo.serializeProperties ( java.util.HashMap< String, String >  jsonObject )

protected

Serializes the properties.

Parameters

jsonObject

The JSON object.

Reimplemented from fm.liveswitch.Info.

setApplicationId()

void fm.liveswitch.ConnectionInfo.setApplicationId

(

String

value

)

Sets the application identifier.

setAudioStream()

void fm.liveswitch.ConnectionInfo.setAudioStream

(

fm.liveswitch.MediaStreamInfo

value

)

Sets the first connection audio stream.

setAudioStreams()

void fm.liveswitch.ConnectionInfo.setAudioStreams

(

fm.liveswitch.MediaStreamInfo[]

value

)

Sets the connection audio streams.

setChannelId()

void fm.liveswitch.ConnectionInfo.setChannelId

(

String

value

)

Sets the channel identifier.

setClientId()

void fm.liveswitch.ConnectionInfo.setClientId

(

String

value

)

Sets the client identifier.

setClientProtocol()

void fm.liveswitch.ConnectionInfo.setClientProtocol

(

String

value

)

Sets the client protocol.

setClientRoles()

void fm.liveswitch.ConnectionInfo.setClientRoles

(

String[]

value

)

Sets the client roles.

setClientTag()

void fm.liveswitch.ConnectionInfo.setClientTag

(

String

value

)

Sets the client tag.

setDataStream()

void fm.liveswitch.ConnectionInfo.setDataStream

(

fm.liveswitch.DataStreamInfo

value

)

Sets the connection data stream.

setDeviceAlias()

void fm.liveswitch.ConnectionInfo.setDeviceAlias

(

String

value

)

Sets the device alias.

setDeviceId()

void fm.liveswitch.ConnectionInfo.setDeviceId

(

String

value

)

Sets the device identifier.

setError()

void fm.liveswitch.ConnectionInfo.setError

(

fm.liveswitch.Error

value

)

Sets the connection error, if an error exists.

setExternalId()

void fm.liveswitch.ConnectionInfo.setExternalId

(

String

value

)

Sets the connection external identifier.

setLayoutPriority()

void fm.liveswitch.ConnectionInfo.setLayoutPriority

(

fm.liveswitch.NullableInteger

value

)

Sets the layout priority.

setLayoutZone()

void fm.liveswitch.ConnectionInfo.setLayoutZone

(

String

value

)

Sets the layout zone.

setMediaId()

void fm.liveswitch.ConnectionInfo.setMediaId

(

String

value

)

Sets the media identifier, for MCU or SFU upstream connections.

setRecording()

void fm.liveswitch.ConnectionInfo.setRecording

(

boolean

value

)

Sets whether the connection is recording.

setRecordingMode()

void fm.liveswitch.ConnectionInfo.setRecordingMode

(

String

value

)

Sets the connection recording mode.

setRecordingTag()

void fm.liveswitch.ConnectionInfo.setRecordingTag

(

String

value

)

Sets the connection recording tag.

setRemoteAudioMuted()

void fm.liveswitch.ConnectionInfo.setRemoteAudioMuted

(

boolean

value

)

Sets if remote audio is muted.

setRemoteConnectionId()

void fm.liveswitch.ConnectionInfo.setRemoteConnectionId

(

String

value

)

Sets the remote connection identifier, for peer or SFU downstream connections.

setRemoteMediaId()

void fm.liveswitch.ConnectionInfo.setRemoteMediaId

(

String

value

)

Sets the remote media identifier, for SFU downstream connections.

setRemoteVideoMuted()

void fm.liveswitch.ConnectionInfo.setRemoteVideoMuted

(

boolean

value

)

Sets if remote video is muted.

setState()

void fm.liveswitch.ConnectionInfo.setState

(

String

value

)

Sets the connection state.

setTag()

void fm.liveswitch.ConnectionInfo.setTag

(

String

value

)

Sets the connection tag.

setTransports()

void fm.liveswitch.ConnectionInfo.setTransports

(

fm.liveswitch.TransportInfo[]

value

)

Sets the connection transport information.

This will be

null  

if BUNDLE is inactive.

setType()

void fm.liveswitch.ConnectionInfo.setType

(

String

value

)

Sets the connection type.

setUserAlias()

void fm.liveswitch.ConnectionInfo.setUserAlias

(

String

value

)

Sets the user alias.

setUserId()

void fm.liveswitch.ConnectionInfo.setUserId

(

String

value

)

Sets the user identifier.

setUseWebSocketsForMedia()

void fm.liveswitch.ConnectionInfo.setUseWebSocketsForMedia

(

boolean

value

)

Sets if we should use websockets for sending media.

setVideoStream()

void fm.liveswitch.ConnectionInfo.setVideoStream

(

fm.liveswitch.MediaStreamInfo

value

)

Sets the first connection video stream.

setVideoStreams()

void fm.liveswitch.ConnectionInfo.setVideoStreams

(

fm.liveswitch.MediaStreamInfo[]

value

)

Sets the connection video streams.

shouldSerializeAudioDirection()

boolean fm.liveswitch.ConnectionInfo.shouldSerializeAudioDirection

(

)

Gets whether to serialize the legacy audio direction property.

shouldSerializeAudioFormats()

boolean fm.liveswitch.ConnectionInfo.shouldSerializeAudioFormats

(

)

Gets whether to serialize the legacy audio formats property.

shouldSerializeDataDirection()

boolean fm.liveswitch.ConnectionInfo.shouldSerializeDataDirection

(

)

Gets whether to serialize the legacy data direction property.

shouldSerializeLocalAudioMuted()

boolean fm.liveswitch.ConnectionInfo.shouldSerializeLocalAudioMuted

(

)

Gets whether to serialize the legacy local audio muted property.

shouldSerializeLocalVideoMuted()

boolean fm.liveswitch.ConnectionInfo.shouldSerializeLocalVideoMuted

(

)

Gets whether to serialize the legacy local video muted property.

shouldSerializeVideoDirection()

boolean fm.liveswitch.ConnectionInfo.shouldSerializeVideoDirection

(

)

Gets whether to serialize the legacy video direction property.

shouldSerializeVideoFormats()

boolean fm.liveswitch.ConnectionInfo.shouldSerializeVideoFormats

(

)

Gets whether to serialize the legacy video formats property.

toJson() [1/2]

String fm.liveswitch.ConnectionInfo.toJson

(

)

Serializes this instance to Json.

toJson() [2/2]

static String fm.liveswitch.ConnectionInfo.toJson ( fm.liveswitch.ConnectionInfo  connectionInfo )

static

Serializes an instance to Json.

Parameters

connectionInfo

The instance to serialize.

Returns

Serialized Json.

toJsonArray()

static String fm.liveswitch.ConnectionInfo.toJsonArray ( fm.liveswitch.ConnectionInfo[]  connectionInfos )

static

Serializes an array of instances to JSON.

Parameters

connectionInfos

The connection infos to serialize.

Returns

The serialized JSON.