Connection information. More...

Instance Methods
(NSString *)	- applicationId
	Gets the application identifier. More...

(NSString *)	- audioDirection
	Gets the audio stream direction. More...

(NSMutableArray *)	- audioFormats
	Gets the audio formats, if applicable. More...

(FMLiveSwitchMediaStreamInfo *)	- audioStream
	Gets the first connection audio stream. More...

(NSMutableArray *)	- audioStreams
	Gets the connection audio streams. More...

(NSString *)	- channelId
	Gets the channel identifier. More...

(NSString *)	- clientId
	Gets the client identifier. More...

(NSString *)	- clientProtocol
	Gets the client protocol. More...

(NSMutableArray *)	- clientRoles
	Gets the client roles. More...

(NSString *)	- clientTag
	Gets the client tag. More...

(FMLiveSwitchClientInfo *)	- createClientInfo
	Creates a client info object with details from this connection info object. More...

(NSString *)	- dataDirection
	Gets the data stream direction. More...

(FMLiveSwitchDataStreamInfo *)	- dataStream
	Gets the connection data stream. More...

(void)	- deserializePropertiesWithKey:valueJson:
	Deserializes the properties. More...

(NSString *)	- deviceAlias
	Gets the device alias. More...

(NSString *)	- deviceId
	Gets the device identifier. More...

(FMLiveSwitchError *)	- error
	Gets the connection error, if an error exists. More...

(NSString *)	- externalId
	Gets the connection external identifier. More...

(bool)	- hasAudio
	Gets a value indicating whether the connection has an audio stream. More...

(bool)	- hasData
	Gets a value indicating whether the connection has a data stream. More...

(bool)	- hasVideo
	Gets a value indicating whether the connection has a video stream. More...

(instancetype)	- init
	Initializes a new instance of the FMLiveSwitchConnectionInfo class. More...

(instancetype)	- initWithUserId:deviceId:clientId:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:
	Initializes a new instance of the FMLiveSwitchConnectionInfo class. More...

(instancetype)	- initWithUserId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:layoutZone:layoutPriority:
	Initializes a new instance of the FMLiveSwitchConnectionInfo class. More...

(bool)	- isEquivalentWithConnectionInfo:
	Tests for equivalency. More...

(bool)	- isEquivalentWithUserId:deviceId:clientId:id:
	Tests for equivalency. More...

(bool)	- isSip
	Gets whether the client is connected via SIP. More...

(FMLiveSwitchNullableInt *)	- layoutPriority
	Gets the layout priority. More...

(NSString *)	- layoutZone
	Gets the layout zone. More...

(bool)	- localAudioDisabled
	Gets if local audio is disabled. More...

(bool)	- localAudioMuted
	Gets whether the local audio is muted. More...

(bool)	- localAudioUnmuteDisabled
	Gets whether the local audio cannot be unmuted. More...

(bool)	- localVideoDisabled
	Gets if local video is disabled. More...

(bool)	- localVideoMuted
	Gets whether the local video is muted. More...

(bool)	- localVideoUnmuteDisabled
	Gets whether the local video cannot be unmuted. More...

(NSString *)	- mediaId
	Gets the media identifier, for MCU or SFU upstream connections. More...

(bool)	- recording
	Gets whether the connection is recording. More...

(NSString *)	- recordingMode
	Gets the connection recording mode. More...

(NSString *)	- recordingTag
	Gets the connection recording tag. More...

(bool)	- remoteAudioDisabled
	Gets if remote audio is disabled. More...

(bool)	- remoteAudioMuted
	Gets if remote audio is muted. More...

(NSString *)	- remoteConnectionId
	Gets the remote connection identifier, for peer or SFU downstream connections. More...

(NSString *)	- remoteMediaId
	Gets the remote media identifier, for SFU downstream connections. More...

(bool)	- remoteVideoDisabled
	Gets if remote video is disabled. More...

(bool)	- remoteVideoMuted
	Gets if remote video is muted. More...

(void)	- serializePropertiesWithJsonObject:
	Serializes the properties. More...

(void)	- setApplicationId:
	Sets the application identifier. More...

(void)	- setAudioStream:
	Sets the first connection audio stream. More...

(void)	- setAudioStreams:
	Sets the connection audio streams. More...

(void)	- setChannelId:
	Sets the channel identifier. More...

(void)	- setClientId:
	Sets the client identifier. More...

(void)	- setClientProtocol:
	Sets the client protocol. More...

(void)	- setClientRoles:
	Sets the client roles. More...

(void)	- setClientTag:
	Sets the client tag. More...

(void)	- setDataStream:
	Sets the connection data stream. More...

(void)	- setDeviceAlias:
	Sets the device alias. More...

(void)	- setDeviceId:
	Sets the device identifier. More...

(void)	- setError:
	Sets the connection error, if an error exists. More...

(void)	- setExternalId:
	Sets the connection external identifier. More...

(void)	- setLayoutPriority:
	Sets the layout priority. More...

(void)	- setLayoutZone:
	Sets the layout zone. More...

(void)	- setMediaId:
	Sets the media identifier, for MCU or SFU upstream connections. More...

(void)	- setRecording:
	Sets whether the connection is recording. More...

(void)	- setRecordingMode:
	Sets the connection recording mode. More...

(void)	- setRecordingTag:
	Sets the connection recording tag. More...

(void)	- setRemoteAudioMuted:
	Sets if remote audio is muted. More...

(void)	- setRemoteConnectionId:
	Sets the remote connection identifier, for peer or SFU downstream connections. More...

(void)	- setRemoteMediaId:
	Sets the remote media identifier, for SFU downstream connections. More...

(void)	- setRemoteVideoMuted:
	Sets if remote video is muted. More...

(void)	- setState:
	Sets the connection state. More...

(void)	- setTag:
	Sets the connection tag. More...

(void)	- setTransports:
	Sets the connection transport information. More...

(void)	- setType:
	Sets the connection type. More...

(void)	- setUserAlias:
	Sets the user alias. More...

(void)	- setUserId:
	Sets the user identifier. More...

(void)	- setUseWebSocketsForMedia:
	Sets if we should use websockets for sending media. More...

(void)	- setVideoStream:
	Sets the first connection video stream. More...

(void)	- setVideoStreams:
	Sets the connection video streams. More...

(bool)	- shouldSerializeAudioDirection
	Gets whether to serialize the legacy audio direction property. More...

(bool)	- shouldSerializeAudioFormats
	Gets whether to serialize the legacy audio formats property. More...

(bool)	- shouldSerializeDataDirection
	Gets whether to serialize the legacy data direction property. More...

(bool)	- shouldSerializeLocalAudioMuted
	Gets whether to serialize the legacy local audio muted property. More...

(bool)	- shouldSerializeLocalVideoMuted
	Gets whether to serialize the legacy local video muted property. More...

(bool)	- shouldSerializeVideoDirection
	Gets whether to serialize the legacy video direction property. More...

(bool)	- shouldSerializeVideoFormats
	Gets whether to serialize the legacy video formats property. More...

(NSString *)	- state
	Gets the connection state. More...

(NSString *)	- tag
	Gets the connection tag. More...

(NSString *)	- toJson
	Serializes this instance to Json. More...

(NSMutableArray *)	- transports
	Gets the connection transport information. More...

(NSString *)	- type
	Gets the connection type. More...

(NSString *)	- userAlias
	Gets the user alias. More...

(NSString *)	- userId
	Gets the user identifier. More...

(bool)	- useWebSocketsForMedia
	Gets if we should use websockets for sending media. More...

(NSString *)	- videoDirection
	Gets the video stream direction. More...

(NSMutableArray *)	- videoFormats
	Gets the video formats, if applicable. More...

(FMLiveSwitchMediaStreamInfo *)	- videoStream
	Gets the first connection video stream. More...

(NSMutableArray *)	- videoStreams
	Gets the connection video streams. More...

Instance Methods inherited from FMLiveSwitchInfo
(NSString *)	- id
	Gets the identifier. More...

(void)	- setId:
	Sets the identifier. More...

Class Methods
(FMLiveSwitchConnectionInfo *)	+ connectionInfo
	Initializes a new instance of the FMLiveSwitchConnectionInfo class. More...

(FMLiveSwitchConnectionInfo *)	+ connectionInfoWithUserId:deviceId:clientId:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:
	Initializes a new instance of the FMLiveSwitchConnectionInfo class. More...

(FMLiveSwitchConnectionInfo *)	+ connectionInfoWithUserId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:layoutZone:layoutPriority:
	Initializes a new instance of the FMLiveSwitchConnectionInfo class. More...

(NSMutableArray *)	+ fromJsonArrayWithConnectionInfosJson:
	Deserializes an array of instances from JSON. More...

(FMLiveSwitchConnectionInfo *)	+ fromJsonWithConnectionInfoJson:
	Deserializes Json to a ConnectionInfo. More...

(NSString *)	+ toJsonArrayWithConnectionInfos:
	Serializes an array of instances to JSON. More...

(NSString *)	+ toJsonWithConnectionInfo:
	Serializes an instance to Json. More...

Class Methods inherited from FMLiveSwitchInfo
(FMLiveSwitchInfo *)	+ info

(NSMutableArray *)	+ processArrayWithNewValues:oldValues:
	Processes an array for an info. More...

(NSMutableArray *)	+ processBooleanArrayWithNewValues:oldValues:
	Processes a boolean array for an info. More...

(FMLiveSwitchNullableBool *)	+ processBooleanWithNewValue:oldValue:
	Processes a boolean for an info. More...

(FMLiveSwitchNullableDouble *)	+ processDoubleWithNewValue:oldValue:
	Processes a double for an info. More...

(NSMutableArray *)	+ processFloatArrayWithNewValues:oldValues:
	Processes a float array for an info. More...

(FMLiveSwitchNullableFloat *)	+ processFloatWithNewValue:oldValue:
	Processes a float for an info. More...

(NSMutableArray *)	+ processIntegerArrayWithNewValues:oldValues:
	Processes a integer array for an info. More...

(FMLiveSwitchNullableInt *)	+ processIntegerWithNewValue:oldValue:
	Processes an integer for an info. More...

(NSMutableArray *)	+ processLongArrayWithNewValues:oldValues:
	Processes a long array for an info. More...

(FMLiveSwitchNullableLong *)	+ processLongWithNewValue:oldValue:
	Processes a long for an info. More...

(NSObject< FMLiveSwitchIEquivalent > *)	+ processObjectWithNewValue:oldValue:
	Processes an object for an info. More...

(NSMutableArray *)	+ processShortArrayWithNewValues:oldValues:
	Processes a short array for an info. More...

(FMLiveSwitchNullableShort *)	+ processShortWithNewValue:oldValue:
	Processes a short for an info. More...

(NSString *)	+ processStringWithNewValue:oldValue:
	Processes a string for an info. More...

Detailed Description

Connection information.

Method Documentation

◆ applicationId

- (NSString*) applicationId

Gets the application identifier.

◆ audioDirection

- (NSString*) audioDirection

Gets the audio stream direction.

◆ audioFormats

- (NSMutableArray*) audioFormats

Gets the audio formats, if applicable.

◆ audioStream

- (FMLiveSwitchMediaStreamInfo*) audioStream

Gets the first connection audio stream.

◆ audioStreams

- (NSMutableArray*) audioStreams

Gets the connection audio streams.

◆ channelId

- (NSString*) channelId

Gets the channel identifier.

◆ clientId

- (NSString*) clientId

Gets the client identifier.

◆ clientProtocol

- (NSString*) clientProtocol

Gets the client protocol.

◆ clientRoles

- (NSMutableArray*) clientRoles

Gets the client roles.

◆ clientTag

- (NSString*) clientTag

Gets the client tag.

◆ connectionInfo

+ (FMLiveSwitchConnectionInfo*) connectionInfo

Initializes a new instance of the FMLiveSwitchConnectionInfo class.

◆ connectionInfoWithUserId:deviceId:clientId:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:

+ (FMLiveSwitchConnectionInfo*) connectionInfoWithUserId:	(NSString *)	userId
deviceId:	(NSString *)	deviceId
clientId:	(NSString *)	clientId
id:	(NSString *)	idValue
tag:	(NSString *)	tag
type:	(NSString *)	type
mediaId:	(NSString *)	mediaId
localAudioMuted:	(bool)	localAudioMuted
localVideoMuted:	(bool)	localVideoMuted
audioDirection:	(NSString *)	audioDirection
videoDirection:	(NSString *)	videoDirection
dataDirection:	(NSString *)	dataDirection
audioFormats:	(NSMutableArray *)	audioFormats
videoFormats:	(NSMutableArray *)	videoFormats

Initializes a new instance of the FMLiveSwitchConnectionInfo 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.

◆ connectionInfoWithUserId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:layoutZone:layoutPriority:

+ (FMLiveSwitchConnectionInfo*) connectionInfoWithUserId:	(NSString *)	userId
userAlias:	(NSString *)	userAlias
deviceId:	(NSString *)	deviceId
deviceAlias:	(NSString *)	deviceAlias
clientId:	(NSString *)	clientId
clientTag:	(NSString *)	clientTag
clientRoles:	(NSMutableArray *)	clientRoles
clientProtocol:	(NSString *)	clientProtocol
id:	(NSString *)	idValue
tag:	(NSString *)	tag
type:	(NSString *)	type
mediaId:	(NSString *)	mediaId
localAudioMuted:	(bool)	localAudioMuted
localVideoMuted:	(bool)	localVideoMuted
audioDirection:	(NSString *)	audioDirection
videoDirection:	(NSString *)	videoDirection
dataDirection:	(NSString *)	dataDirection
audioFormats:	(NSMutableArray *)	audioFormats
videoFormats:	(NSMutableArray *)	videoFormats
layoutZone:	(NSString *)	layoutZone
layoutPriority:	(FMLiveSwitchNullableInt *)	layoutPriority

Initializes a new instance of the FMLiveSwitchConnectionInfo 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.

◆ createClientInfo

- (FMLiveSwitchClientInfo*) createClientInfo

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

◆ dataDirection

- (NSString*) dataDirection

Gets the data stream direction.

Obsolete.

◆ dataStream

- (FMLiveSwitchDataStreamInfo*) dataStream

Gets the connection data stream.

◆ deserializePropertiesWithKey:valueJson:

- (void) deserializePropertiesWithKey:	(NSString *)	key
valueJson:	(NSString *)	valueJson

Deserializes the properties.

Parameters

key	The key.
valueJson	The value in JSON format.

Implements FMLiveSwitchInfo.

◆ deviceAlias

- (NSString*) deviceAlias

Gets the device alias.

◆ deviceId

- (NSString*) deviceId

Gets the device identifier.

◆ error

- (FMLiveSwitchError*) error

Gets the connection error, if an error exists.

◆ externalId

- (NSString*) externalId

Gets the connection external identifier.

◆ fromJsonArrayWithConnectionInfosJson:

+ (NSMutableArray*) fromJsonArrayWithConnectionInfosJson: (NSString *) connectionInfosJson

Deserializes an array of instances from JSON.

Parameters

connectionInfosJson The JSON to deserialize.

Returns: The deserialized connection infos.

◆ fromJsonWithConnectionInfoJson:

+ (FMLiveSwitchConnectionInfo*) fromJsonWithConnectionInfoJson: (NSString *) connectionInfoJson

Deserializes Json to a ConnectionInfo.

Parameters

connectionInfoJson The serialized Json.

Returns: The deserialized ConnectionInfo.

◆ hasAudio

- (bool) hasAudio

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

◆ hasData

- (bool) hasData

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

◆ hasVideo

- (bool) hasVideo

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

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchConnectionInfo class.

Implements FMLiveSwitchInfo.

◆ initWithUserId:deviceId:clientId:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:

- (instancetype) initWithUserId:	(NSString *)	userId
deviceId:	(NSString *)	deviceId
clientId:	(NSString *)	clientId
id:	(NSString *)	idValue
tag:	(NSString *)	tag
type:	(NSString *)	type
mediaId:	(NSString *)	mediaId
localAudioMuted:	(bool)	localAudioMuted
localVideoMuted:	(bool)	localVideoMuted
audioDirection:	(NSString *)	audioDirection
videoDirection:	(NSString *)	videoDirection
dataDirection:	(NSString *)	dataDirection
audioFormats:	(NSMutableArray *)	audioFormats
videoFormats:	(NSMutableArray *)	videoFormats

Initializes a new instance of the FMLiveSwitchConnectionInfo 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.

◆ initWithUserId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:layoutZone:layoutPriority:

- (instancetype) initWithUserId:	(NSString *)	userId
userAlias:	(NSString *)	userAlias
deviceId:	(NSString *)	deviceId
deviceAlias:	(NSString *)	deviceAlias
clientId:	(NSString *)	clientId
clientTag:	(NSString *)	clientTag
clientRoles:	(NSMutableArray *)	clientRoles
clientProtocol:	(NSString *)	clientProtocol
id:	(NSString *)	idValue
tag:	(NSString *)	tag
type:	(NSString *)	type
mediaId:	(NSString *)	mediaId
localAudioMuted:	(bool)	localAudioMuted
localVideoMuted:	(bool)	localVideoMuted
audioDirection:	(NSString *)	audioDirection
videoDirection:	(NSString *)	videoDirection
dataDirection:	(NSString *)	dataDirection
audioFormats:	(NSMutableArray *)	audioFormats
videoFormats:	(NSMutableArray *)	videoFormats
layoutZone:	(NSString *)	layoutZone
layoutPriority:	(FMLiveSwitchNullableInt *)	layoutPriority

Initializes a new instance of the FMLiveSwitchConnectionInfo 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.

◆ isEquivalentWithConnectionInfo:

- (bool) isEquivalentWithConnectionInfo: (FMLiveSwitchConnectionInfo *) connectionInfo

Tests for equivalency.

Parameters

connectionInfo The connection information.

Returns: true if equivalent; otherwise, false.

◆ isEquivalentWithUserId:deviceId:clientId:id:

- (bool) isEquivalentWithUserId:	(NSString *)	userId
deviceId:	(NSString *)	deviceId
clientId:	(NSString *)	clientId
id:	(NSString *)	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.

◆ isSip

- (bool) isSip

Gets whether the client is connected via SIP.

◆ layoutPriority

- (FMLiveSwitchNullableInt*) layoutPriority

Gets the layout priority.

◆ layoutZone

- (NSString*) layoutZone

Gets the layout zone.

◆ localAudioDisabled

- (bool) localAudioDisabled

Gets if local audio is disabled.

◆ localAudioMuted

- (bool) localAudioMuted

Gets whether the local audio is muted.

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

◆ localAudioUnmuteDisabled

- (bool) localAudioUnmuteDisabled

Gets whether the local audio cannot be unmuted.

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

◆ localVideoDisabled

- (bool) localVideoDisabled

Gets if local video is disabled.

◆ localVideoMuted

- (bool) localVideoMuted

Gets whether the local video is muted.

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

◆ localVideoUnmuteDisabled

- (bool) localVideoUnmuteDisabled

Gets whether the local video cannot be unmuted.

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

◆ mediaId

- (NSString*) mediaId

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

◆ recording

- (bool) recording

Gets whether the connection is recording.

◆ recordingMode

- (NSString*) recordingMode

Gets the connection recording mode.

◆ recordingTag

- (NSString*) recordingTag

Gets the connection recording tag.

◆ remoteAudioDisabled

- (bool) remoteAudioDisabled

Gets if remote audio is disabled.

◆ remoteAudioMuted

- (bool) remoteAudioMuted

Gets if remote audio is muted.

◆ remoteConnectionId

- (NSString*) remoteConnectionId

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

◆ remoteMediaId

- (NSString*) remoteMediaId

Gets the remote media identifier, for SFU downstream connections.

◆ remoteVideoDisabled

- (bool) remoteVideoDisabled

Gets if remote video is disabled.

◆ remoteVideoMuted

- (bool) remoteVideoMuted

Gets if remote video is muted.

◆ serializePropertiesWithJsonObject:

- (void) serializePropertiesWithJsonObject: (NSMutableDictionary< NSString *, NSString * > *) jsonObject

Serializes the properties.

Parameters

jsonObject The JSON object.

Implements FMLiveSwitchInfo.

◆ setApplicationId:

- (void) setApplicationId: (NSString *) value

Sets the application identifier.

◆ setAudioStream:

- (void) setAudioStream: (FMLiveSwitchMediaStreamInfo *) value

Sets the first connection audio stream.

◆ setAudioStreams:

- (void) setAudioStreams: (NSMutableArray *) value

Sets the connection audio streams.

◆ setChannelId:

- (void) setChannelId: (NSString *) value

Sets the channel identifier.

◆ setClientId:

- (void) setClientId: (NSString *) value

Sets the client identifier.

◆ setClientProtocol:

- (void) setClientProtocol: (NSString *) value

Sets the client protocol.

◆ setClientRoles:

- (void) setClientRoles: (NSMutableArray *) value

Sets the client roles.

◆ setClientTag:

- (void) setClientTag: (NSString *) value

Sets the client tag.

◆ setDataStream:

- (void) setDataStream: (FMLiveSwitchDataStreamInfo *) value

Sets the connection data stream.

◆ setDeviceAlias:

- (void) setDeviceAlias: (NSString *) value

Sets the device alias.

◆ setDeviceId:

- (void) setDeviceId: (NSString *) value

Sets the device identifier.

◆ setError:

- (void) setError: (FMLiveSwitchError *) value

Sets the connection error, if an error exists.

◆ setExternalId:

- (void) setExternalId: (NSString *) value

Sets the connection external identifier.

◆ setLayoutPriority:

- (void) setLayoutPriority: (FMLiveSwitchNullableInt *) value

Sets the layout priority.

◆ setLayoutZone:

- (void) setLayoutZone: (NSString *) value

Sets the layout zone.

◆ setMediaId:

- (void) setMediaId: (NSString *) value

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

◆ setRecording:

- (void) setRecording: (bool) value

Sets whether the connection is recording.

◆ setRecordingMode:

- (void) setRecordingMode: (NSString *) value

Sets the connection recording mode.

◆ setRecordingTag:

- (void) setRecordingTag: (NSString *) value

Sets the connection recording tag.

◆ setRemoteAudioMuted:

- (void) setRemoteAudioMuted: (bool) value

Sets if remote audio is muted.

◆ setRemoteConnectionId:

- (void) setRemoteConnectionId: (NSString *) value

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

◆ setRemoteMediaId:

- (void) setRemoteMediaId: (NSString *) value

Sets the remote media identifier, for SFU downstream connections.

◆ setRemoteVideoMuted:

- (void) setRemoteVideoMuted: (bool) value

Sets if remote video is muted.

◆ setState:

- (void) setState: (NSString *) value

Sets the connection state.

◆ setTag:

- (void) setTag: (NSString *) value

Sets the connection tag.

◆ setTransports:

- (void) setTransports: (NSMutableArray *) value

Sets the connection transport information.

This will be null if BUNDLE is inactive.

◆ setType:

- (void) setType: (NSString *) value

Sets the connection type.

◆ setUserAlias:

- (void) setUserAlias: (NSString *) value

Sets the user alias.

◆ setUserId:

- (void) setUserId: (NSString *) value

Sets the user identifier.

◆ setUseWebSocketsForMedia:

- (void) setUseWebSocketsForMedia: (bool) value

Sets if we should use websockets for sending media.

◆ setVideoStream:

- (void) setVideoStream: (FMLiveSwitchMediaStreamInfo *) value

Sets the first connection video stream.

◆ setVideoStreams:

- (void) setVideoStreams: (NSMutableArray *) value

Sets the connection video streams.

◆ shouldSerializeAudioDirection

- (bool) shouldSerializeAudioDirection

Gets whether to serialize the legacy audio direction property.

◆ shouldSerializeAudioFormats

- (bool) shouldSerializeAudioFormats

Gets whether to serialize the legacy audio formats property.

◆ shouldSerializeDataDirection

- (bool) shouldSerializeDataDirection

Gets whether to serialize the legacy data direction property.

◆ shouldSerializeLocalAudioMuted

- (bool) shouldSerializeLocalAudioMuted

Gets whether to serialize the legacy local audio muted property.

◆ shouldSerializeLocalVideoMuted

- (bool) shouldSerializeLocalVideoMuted

Gets whether to serialize the legacy local video muted property.

◆ shouldSerializeVideoDirection

- (bool) shouldSerializeVideoDirection

Gets whether to serialize the legacy video direction property.

◆ shouldSerializeVideoFormats

- (bool) shouldSerializeVideoFormats

Gets whether to serialize the legacy video formats property.

◆ state

- (NSString*) state

Gets the connection state.

◆ tag

- (NSString*) tag

Gets the connection tag.

◆ toJson

- (NSString*) toJson

Serializes this instance to Json.

◆ toJsonArrayWithConnectionInfos:

+ (NSString*) toJsonArrayWithConnectionInfos: (NSMutableArray *) connectionInfos

Serializes an array of instances to JSON.

Parameters

connectionInfos The connection infos to serialize.

Returns: The serialized JSON.

◆ toJsonWithConnectionInfo:

+ (NSString*) toJsonWithConnectionInfo: (FMLiveSwitchConnectionInfo *) connectionInfo

Serializes an instance to Json.

Parameters

connectionInfo The instance to serialize.

Returns: Serialized Json.

◆ transports

- (NSMutableArray*) transports

Gets the connection transport information.

This will be null if BUNDLE is inactive.

◆ type

- (NSString*) type

Gets the connection type.

◆ userAlias

- (NSString*) userAlias

Gets the user alias.

◆ userId

- (NSString*) userId

Gets the user identifier.

◆ useWebSocketsForMedia

- (bool) useWebSocketsForMedia

Gets if we should use websockets for sending media.

◆ videoDirection

- (NSString*) videoDirection

Gets the video stream direction.

◆ videoFormats

- (NSMutableArray*) videoFormats

Gets the video formats, if applicable.

◆ videoStream

- (FMLiveSwitchMediaStreamInfo*) videoStream

Gets the first connection video stream.

◆ videoStreams

- (NSMutableArray*) videoStreams

Gets the connection video streams.

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ applicationId

◆ audioDirection

◆ audioFormats

◆ audioStream

◆ audioStreams

◆ channelId

◆ clientId

◆ clientProtocol

◆ clientRoles

◆ clientTag

◆ connectionInfo

◆ connectionInfoWithUserId:deviceId:clientId:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:

◆ connectionInfoWithUserId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:layoutZone:layoutPriority:

◆ createClientInfo

◆ dataDirection

◆ dataStream

◆ deserializePropertiesWithKey:valueJson:

◆ deviceAlias

◆ deviceId

◆ error

◆ externalId

◆ fromJsonArrayWithConnectionInfosJson:

◆ fromJsonWithConnectionInfoJson:

◆ hasAudio

◆ hasData

◆ hasVideo

◆ init

◆ initWithUserId:deviceId:clientId:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:

◆ initWithUserId:userAlias:deviceId:deviceAlias:clientId:clientTag:clientRoles:clientProtocol:id:tag:type:mediaId:localAudioMuted:localVideoMuted:audioDirection:videoDirection:dataDirection:audioFormats:videoFormats:layoutZone:layoutPriority:

◆ isEquivalentWithConnectionInfo:

◆ isEquivalentWithUserId:deviceId:clientId:id:

◆ isSip

◆ layoutPriority

◆ layoutZone

◆ localAudioDisabled

◆ localAudioMuted

◆ localAudioUnmuteDisabled

◆ localVideoDisabled

◆ localVideoMuted

◆ localVideoUnmuteDisabled

◆ mediaId

◆ recording

◆ recordingMode

◆ recordingTag

◆ remoteAudioDisabled

◆ remoteAudioMuted

◆ remoteConnectionId

◆ remoteMediaId

◆ remoteVideoDisabled

◆ remoteVideoMuted

◆ serializePropertiesWithJsonObject:

◆ setApplicationId:

◆ setAudioStream:

◆ setAudioStreams:

◆ setChannelId:

◆ setClientId:

◆ setClientProtocol:

◆ setClientRoles:

◆ setClientTag:

◆ setDataStream:

◆ setDeviceAlias:

◆ setDeviceId:

◆ setError:

◆ setExternalId:

◆ setLayoutPriority:

◆ setLayoutZone:

◆ setMediaId:

◆ setRecording:

◆ setRecordingMode:

◆ setRecordingTag:

◆ setRemoteAudioMuted:

◆ setRemoteConnectionId:

◆ setRemoteMediaId:

◆ setRemoteVideoMuted:

◆ setState:

◆ setTag: