fm.liveswitch.Channel Class Reference

A channel. More...

Public Member Functions

void addOnClaimUpdate (fm.liveswitch.IAction2< fm.liveswitch.ChannelClaim, fm.liveswitch.ChannelClaim > value)
 Adds a handler that is raised when the client's channel claim has been updated. More...
 
void addOnClientMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Adds a handler that is raised when a channel/client-scope message is received from the server. More...
 
void addOnDeviceMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Adds a handler that is raised when a channel/device-scope message is received from the server. More...
 
void addOnKick (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the client is kicked from the channel. More...
 
void addOnMcuVideoLayout (fm.liveswitch.IAction1< fm.liveswitch.VideoLayout > value)
 Adds a handler that is raised when a new MCU video layout is received from the server. More...
 
void addOnMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Adds a handler that is raised when a channel-scope message is received from the server. More...
 
void addOnPeerConnectionOffer (fm.liveswitch.IAction1< fm.liveswitch.PeerConnectionOffer > value)
 Adds a handler that is raised when a remote client wants to open a peer connection. More...
 
void addOnRemoteClientJoin (fm.liveswitch.IAction1< fm.liveswitch.ClientInfo > value)
 Adds a handler that is raised when a remote client joins this channel. More...
 
void addOnRemoteClientLeave (fm.liveswitch.IAction1< fm.liveswitch.ClientInfo > value)
 Adds a handler that is raised when a remote client leaves this channel. More...
 
void addOnRemoteClientUpdate (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, fm.liveswitch.ClientInfo > value)
 Adds a handler that is raised when a remote client updates their config. More...
 
void addOnRemoteUpstreamConnectionClose (fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo > value)
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client. More...
 
void addOnRemoteUpstreamConnectionOpen (fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo > value)
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client. More...
 
void addOnRemoteUpstreamConnectionUpdate (fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo > value)
 Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client. More...
 
void addOnUserMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Adds a handler that is raised when a channel/user-scope message is received from the server. More...
 
fm.liveswitch.Future< Object > closeAll ()
 Closes all active connections. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream)
 Creates an audio-only MCU connection. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/data MCU connection. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream, String mediaId)
 Creates an audio/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream, String mediaId)
 Creates an audio-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream)
 Creates an audio/video MCU connection. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/video/data MCU connection. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream, String mediaId)
 Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, String mediaId)
 Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.DataStream dataStream)
 Creates a data-only MCU connection. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.DataStream dataStream, String mediaId)
 Creates a data-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.VideoStream videoStream)
 Creates a video-only MCU connection. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates a video/data MCU connection. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream, String mediaId)
 Creates a video/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.McuConnection createMcuConnection (fm.liveswitch.VideoStream videoStream, String mediaId)
 Creates a video-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer, fm.liveswitch.AudioStream audioStream)
 Creates an audio-only peer connection in the answering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer, fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/data peer connection in the answering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream)
 Creates an audio/video peer connection in the answering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/video/data peer connection in the answering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer, fm.liveswitch.DataStream dataStream)
 Creates a data-only peer connection in the answering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer, fm.liveswitch.VideoStream videoStream)
 Creates a video-only peer connection in the answering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates a video/data peer connection in the answering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.AudioStream audioStream)
 Creates an audio-only peer connection in the offering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/data peer connection in the offering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream)
 Creates an audio/video peer connection in the offering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/video/data peer connection in the offering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.DataStream dataStream)
 Creates a data-only peer connection in the offering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.VideoStream videoStream)
 Creates a video-only peer connection in the offering role. More...
 
fm.liveswitch.PeerConnection createPeerConnection (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates a video/data peer connection in the offering role. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.AudioStream audioStream)
 Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/data SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream)
 Creates an audio/video SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/video/data SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.DataStream dataStream)
 Creates a data-only SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.VideoStream videoStream)
 Creates a video-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates a video/data SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (String remoteMediaId, fm.liveswitch.AudioStream audioStream)
 Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection with the remote media identifier. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (String remoteMediaId, fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/data SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (String remoteMediaId, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream)
 Creates an audio/video SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (String remoteMediaId, fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/video/data SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (String remoteMediaId, fm.liveswitch.DataStream dataStream)
 Creates a data-only SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (String remoteMediaId, fm.liveswitch.VideoStream videoStream)
 Creates a video-only SFU downstream connection. More...
 
fm.liveswitch.SfuDownstreamConnection createSfuDownstreamConnection (String remoteMediaId, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates a video/data SFU downstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream)
 Creates an audio-only SFU upstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/data SFU upstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.DataStream dataStream, String mediaId)
 Creates an audio/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream, String mediaId)
 Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream)
 Creates an audio/video SFU upstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates an audio/video/data SFU upstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream, String mediaId)
 Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.AudioStream audioStream, fm.liveswitch.VideoStream videoStream, String mediaId)
 Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.DataStream dataStream)
 Creates a data-only SFU upstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.DataStream dataStream, String mediaId)
 Creates a data-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.VideoStream videoStream)
 Creates a video-only SFU upstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream)
 Creates a video/data SFU upstream connection. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.VideoStream videoStream, fm.liveswitch.DataStream dataStream, String mediaId)
 Creates a video/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
fm.liveswitch.SfuUpstreamConnection createSfuUpstreamConnection (fm.liveswitch.VideoStream videoStream, String mediaId)
 Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections. More...
 
String getApplicationId ()
 Gets the application identifier. More...
 
fm.liveswitch.ChannelClaim getClaim ()
 Gets the claim. More...
 
String getClientId ()
 Gets the client identifier. More...
 
String[] getClientRoles ()
 Gets the client roles. More...
 
String getClientTag ()
 Gets the client tag. More...
 
fm.liveswitch.ManagedConnectionCollection getConnections ()
 Gets the active connections. More...
 
String getDeviceAlias ()
 Gets the device alias. More...
 
String getDeviceId ()
 Gets the device identifier. More...
 
String getId ()
 Gets the channel identifier. More...
 
long getMessageBytesReceived ()
 Gets the number of message bytes received. More...
 
long getMessageBytesSent ()
 Gets the number of message bytes sent. More...
 
long getMessagesReceived ()
 Gets the number of messages received. More...
 
long getMessagesSent ()
 Gets the number of messages sent. More...
 
fm.liveswitch.ClientInfo getRemoteClientInfo (String clientId)
 Gets information about a remote client. More...
 
fm.liveswitch.ClientInfo[] getRemoteClientInfos ()
 Gets information about the remote client in this channel. More...
 
fm.liveswitch.ConnectionInfo getRemoteConnectionInfo (String connectionId)
 Gets information about a remote connection. More...
 
fm.liveswitch.ConnectionInfo[] getRemoteUpstreamConnectionInfos ()
 Gets information about the remote upstream (SFU or MCU) connections opened by remote clients in this channel. More...
 
String getUserAlias ()
 Gets the user alias. More...
 
String getUserId ()
 Gets the user identifier. More...
 
fm.liveswitch.Future< fm.liveswitch.Invitationinvite (String userId, String protocol)
 Invites a user into this channel. More...
 
fm.liveswitch.Future< Object > kick ()
 Kicks this channel. More...
 
fm.liveswitch.Future< Object > kickClient (fm.liveswitch.ClientInfo remoteClientInfo)
 Kicks a client in this channel. More...
 
fm.liveswitch.Future< Object > kickClient (String userId, String deviceId, String clientId)
 Kicks a client in this channel. More...
 
fm.liveswitch.Future< Object > kickConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo)
 Kicks a connection in this channel. More...
 
fm.liveswitch.Future< Object > kickConnection (String userId, String deviceId, String clientId, String connectionId)
 Kicks a connection in this channel. More...
 
fm.liveswitch.Future< Object > kickDevice (String userId, String deviceId)
 Kicks a device in this channel. More...
 
fm.liveswitch.Future< Object > kickUser (String userId)
 Kicks a user in this channel. More...
 
fm.liveswitch.Future< Object > rejectPeerConnection (fm.liveswitch.PeerConnectionOffer peerConnectionOffer)
 Rejects a peer connection offer. More...
 
void removeOnClaimUpdate (fm.liveswitch.IAction2< fm.liveswitch.ChannelClaim, fm.liveswitch.ChannelClaim > value)
 Removes a handler that is raised when the client's channel claim has been updated. More...
 
void removeOnClientMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Removes a handler that is raised when a channel/client-scope message is received from the server. More...
 
void removeOnDeviceMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Removes a handler that is raised when a channel/device-scope message is received from the server. More...
 
void removeOnKick (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the client is kicked from the channel. More...
 
void removeOnMcuVideoLayout (fm.liveswitch.IAction1< fm.liveswitch.VideoLayout > value)
 Removes a handler that is raised when a new MCU video layout is received from the server. More...
 
void removeOnMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Removes a handler that is raised when a channel-scope message is received from the server. More...
 
void removeOnPeerConnectionOffer (fm.liveswitch.IAction1< fm.liveswitch.PeerConnectionOffer > value)
 Removes a handler that is raised when a remote client wants to open a peer connection. More...
 
void removeOnRemoteClientJoin (fm.liveswitch.IAction1< fm.liveswitch.ClientInfo > value)
 Removes a handler that is raised when a remote client joins this channel. More...
 
void removeOnRemoteClientLeave (fm.liveswitch.IAction1< fm.liveswitch.ClientInfo > value)
 Removes a handler that is raised when a remote client leaves this channel. More...
 
void removeOnRemoteClientUpdate (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, fm.liveswitch.ClientInfo > value)
 Removes a handler that is raised when a remote client updates their config. More...
 
void removeOnRemoteUpstreamConnectionClose (fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo > value)
 Removes a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client. More...
 
void removeOnRemoteUpstreamConnectionOpen (fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo > value)
 Removes a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client. More...
 
void removeOnRemoteUpstreamConnectionUpdate (fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo > value)
 Removes a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client. More...
 
void removeOnUserMessage (fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String > value)
 Removes a handler that is raised when a channel/user-scope message is received from the server. More...
 
fm.liveswitch.Future< Object > sendClientMessage (String userId, String deviceId, String clientId, String message)
 Sends a message to a client in the channel. More...
 
fm.liveswitch.Future< Object > sendDeviceMessage (String userId, String deviceId, String message)
 Sends a message to a device in the channel. More...
 
fm.liveswitch.Future< Object > sendMessage (String message)
 Sends a message to the channel. More...
 
fm.liveswitch.Future< Object > sendUserMessage (String userId, String message)
 Sends a message to a user in the channel. More...
 
fm.liveswitch.Future< Object > update (fm.liveswitch.ChannelConfig newConfig)
 Updates this channel. More...
 
fm.liveswitch.Future< Object > updateClient (fm.liveswitch.ClientInfo remoteClientInfo, fm.liveswitch.ChannelClientConfig newConfig)
 Updates a client in this channel. More...
 
fm.liveswitch.Future< Object > updateClient (String userId, String deviceId, String clientId, fm.liveswitch.ChannelClientConfig newConfig)
 Updates a client in this channel. More...
 
fm.liveswitch.Future< Object > updateConnection (fm.liveswitch.ConnectionInfo remoteConnectionInfo, fm.liveswitch.ChannelConnectionConfig newConfig)
 Updates a connection in this channel. More...
 
fm.liveswitch.Future< Object > updateConnection (String userId, String deviceId, String clientId, String connectionId, fm.liveswitch.ChannelConnectionConfig newConfig)
 Updates a connection in this channel. More...
 
fm.liveswitch.Future< Object > updateDevice (String userId, String deviceId, fm.liveswitch.ChannelDeviceConfig newConfig)
 Updates a device in this channel. More...
 
fm.liveswitch.Future< Object > updateUser (String userId, fm.liveswitch.ChannelUserConfig newConfig)
 Updates a user in this channel. 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...
 

Protected Member Functions

fm.liveswitch.Future< fm.liveswitch.Messagesend (fm.liveswitch.Message message)
 Sends a message. 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 channel.

Member Function Documentation

◆ addOnClaimUpdate()

void fm.liveswitch.Channel.addOnClaimUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ChannelClaim, fm.liveswitch.ChannelClaim value)

Adds a handler that is raised when the client's channel claim has been updated.

Parameters:

  • oldConnectionInfo - the old channel claim
  • newConnectionInfo - the new channel claim

◆ addOnClientMessage()

void fm.liveswitch.Channel.addOnClientMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Adds a handler that is raised when a channel/client-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnDeviceMessage()

void fm.liveswitch.Channel.addOnDeviceMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Adds a handler that is raised when a channel/device-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnKick()

void fm.liveswitch.Channel.addOnKick ( fm.liveswitch.IAction0  value)

Adds a handler that is raised when the client is kicked from the channel.

◆ addOnMcuVideoLayout()

void fm.liveswitch.Channel.addOnMcuVideoLayout ( fm.liveswitch.IAction1< fm.liveswitch.VideoLayout value)

Adds a handler that is raised when a new MCU video layout is received from the server.

Parameters:

  • videoLayout - the new MCU video layout

◆ addOnMessage()

void fm.liveswitch.Channel.addOnMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Adds a handler that is raised when a channel-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ addOnPeerConnectionOffer()

void fm.liveswitch.Channel.addOnPeerConnectionOffer ( fm.liveswitch.IAction1< fm.liveswitch.PeerConnectionOffer value)

Adds a handler that is raised when a remote client wants to open a peer connection.

Parameters:

  • peerConnectionOffer - the peer connection offer

◆ addOnRemoteClientJoin()

void fm.liveswitch.Channel.addOnRemoteClientJoin ( fm.liveswitch.IAction1< fm.liveswitch.ClientInfo value)

Adds a handler that is raised when a remote client joins this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientLeave()

void fm.liveswitch.Channel.addOnRemoteClientLeave ( fm.liveswitch.IAction1< fm.liveswitch.ClientInfo value)

Adds a handler that is raised when a remote client leaves this channel.

Parameters:

  • clientInfo - the remote client information

◆ addOnRemoteClientUpdate()

void fm.liveswitch.Channel.addOnRemoteClientUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, fm.liveswitch.ClientInfo value)

Adds a handler that is raised when a remote client updates their config.

Parameters:

  • oldClientInfo - the old remote client information
  • newClientInfo - the new remote client information

◆ addOnRemoteUpstreamConnectionClose()

void fm.liveswitch.Channel.addOnRemoteUpstreamConnectionClose ( fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo value)

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionOpen()

void fm.liveswitch.Channel.addOnRemoteUpstreamConnectionOpen ( fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo value)

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ addOnRemoteUpstreamConnectionUpdate()

void fm.liveswitch.Channel.addOnRemoteUpstreamConnectionUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo value)

Adds a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client.

Parameters:

  • oldConnectionInfo - the old remote connection information
  • newConnectionInfo - the new remote connection information

◆ addOnUserMessage()

void fm.liveswitch.Channel.addOnUserMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Adds a handler that is raised when a channel/user-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ closeAll()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.closeAll ( )

Closes all active connections.

◆ createMcuConnection() [1/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream)

Creates an audio-only MCU connection.

Parameters
audioStreamThe audio stream.

◆ createMcuConnection() [2/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/data MCU connection.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createMcuConnection() [3/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates an audio/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnection() [4/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream 
)

Creates an audio/video MCU connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createMcuConnection() [5/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/video/data MCU connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createMcuConnection() [6/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnection() [7/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
String  mediaId 
)

Creates an audio/video MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnection() [8/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.AudioStream  audioStream,
String  mediaId 
)

Creates an audio-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
audioStreamThe audio stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnection() [9/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.DataStream  dataStream)

Creates a data-only MCU connection.

Parameters
dataStreamThe data stream.

◆ createMcuConnection() [10/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates a data-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnection() [11/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.VideoStream  videoStream)

Creates a video-only MCU connection.

Parameters
videoStreamThe video stream.

◆ createMcuConnection() [12/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates a video/data MCU connection.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.

◆ createMcuConnection() [13/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates a video/data MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createMcuConnection() [14/14]

fm.liveswitch.McuConnection fm.liveswitch.Channel.createMcuConnection ( fm.liveswitch.VideoStream  videoStream,
String  mediaId 
)

Creates a video-only MCU connection with a specific media identifier that can be targeted by SFU downstream connections.

The media identifer is only relevant if this connection will send media.

Parameters
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createPeerConnection() [1/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.AudioStream  audioStream 
)

Creates an audio-only peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.

◆ createPeerConnection() [2/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/data peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createPeerConnection() [3/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream 
)

Creates an audio/video peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createPeerConnection() [4/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/video/data peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createPeerConnection() [5/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.DataStream  dataStream 
)

Creates a data-only peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
dataStreamThe data stream.

◆ createPeerConnection() [6/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.VideoStream  videoStream 
)

Creates a video-only peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
videoStreamThe video stream.

◆ createPeerConnection() [7/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates a video/data peer connection in the offering role.

Parameters
remoteClientInfoThe remote client information.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createPeerConnection() [8/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer,
fm.liveswitch.AudioStream  audioStream 
)

Creates an audio-only peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.

◆ createPeerConnection() [9/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/data peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createPeerConnection() [10/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream 
)

Creates an audio/video peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createPeerConnection() [11/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/video/data peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createPeerConnection() [12/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer,
fm.liveswitch.DataStream  dataStream 
)

Creates a data-only peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
dataStreamThe data stream.

◆ createPeerConnection() [13/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer,
fm.liveswitch.VideoStream  videoStream 
)

Creates a video-only peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
videoStreamThe video stream.

◆ createPeerConnection() [14/14]

fm.liveswitch.PeerConnection fm.liveswitch.Channel.createPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates a video/data peer connection in the answering role.

Parameters
peerConnectionOfferThe peer connection offer.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [1/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.AudioStream  audioStream 
)

Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.

◆ createSfuDownstreamConnection() [2/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/data SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [3/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream 
)

Creates an audio/video SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createSfuDownstreamConnection() [4/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/video/data SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [5/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.DataStream  dataStream 
)

Creates a data-only SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [6/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.VideoStream  videoStream 
)

Creates a video-only SFU downstream connection to the SFU or MCU upstream connection identified by the remote connection info.

Parameters
remoteConnectionInfoThe remote connection information.
videoStreamThe video stream.

◆ createSfuDownstreamConnection() [7/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates a video/data SFU downstream connection.

Parameters
remoteConnectionInfoThe remote connection information.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [8/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( String  remoteMediaId,
fm.liveswitch.AudioStream  audioStream 
)

Creates an audio-only SFU downstream connection to the SFU or MCU upstream connection with the remote media identifier.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.

◆ createSfuDownstreamConnection() [9/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( String  remoteMediaId,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/data SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [10/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( String  remoteMediaId,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream 
)

Creates an audio/video SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createSfuDownstreamConnection() [11/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( String  remoteMediaId,
fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/video/data SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [12/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( String  remoteMediaId,
fm.liveswitch.DataStream  dataStream 
)

Creates a data-only SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
dataStreamThe data stream.

◆ createSfuDownstreamConnection() [13/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( String  remoteMediaId,
fm.liveswitch.VideoStream  videoStream 
)

Creates a video-only SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
videoStreamThe video stream.

◆ createSfuDownstreamConnection() [14/14]

fm.liveswitch.SfuDownstreamConnection fm.liveswitch.Channel.createSfuDownstreamConnection ( String  remoteMediaId,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates a video/data SFU downstream connection.

Parameters
remoteMediaIdThe remote media identifier.
videoStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnection() [1/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream)

Creates an audio-only SFU upstream connection.

Parameters
audioStreamThe audio stream.

◆ createSfuUpstreamConnection() [2/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/data SFU upstream connection.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnection() [3/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates an audio/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnection() [4/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream 
)

Creates an audio/video SFU upstream connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.

◆ createSfuUpstreamConnection() [5/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates an audio/video/data SFU upstream connection.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnection() [6/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
dataStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnection() [7/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream,
fm.liveswitch.VideoStream  videoStream,
String  mediaId 
)

Creates an audio/video SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnection() [8/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.AudioStream  audioStream,
String  mediaId 
)

Creates an audio-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
audioStreamThe audio stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnection() [9/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.DataStream  dataStream)

Creates a data-only SFU upstream connection.

Parameters
dataStreamThe data stream.

◆ createSfuUpstreamConnection() [10/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates a data-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnection() [11/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.VideoStream  videoStream)

Creates a video-only SFU upstream connection.

Parameters
videoStreamThe video stream.

◆ createSfuUpstreamConnection() [12/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream 
)

Creates a video/data SFU upstream connection.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.

◆ createSfuUpstreamConnection() [13/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.VideoStream  videoStream,
fm.liveswitch.DataStream  dataStream,
String  mediaId 
)

Creates a video/data SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
videoStreamThe video stream.
dataStreamThe data stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ createSfuUpstreamConnection() [14/14]

fm.liveswitch.SfuUpstreamConnection fm.liveswitch.Channel.createSfuUpstreamConnection ( fm.liveswitch.VideoStream  videoStream,
String  mediaId 
)

Creates a video-only SFU upstream connection with a specific media identifier that can be targeted by SFU downstream connections.

Parameters
videoStreamThe video stream.
mediaIdThe media identifier, unique to this channel, for persistent SFU downstream connections.

◆ getApplicationId()

String fm.liveswitch.Channel.getApplicationId ( )

Gets the application identifier.

◆ getClaim()

fm.liveswitch.ChannelClaim fm.liveswitch.Channel.getClaim ( )

Gets the claim.

◆ getClientId()

String fm.liveswitch.Channel.getClientId ( )

Gets the client identifier.

◆ getClientRoles()

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

Gets the client roles.

◆ getClientTag()

String fm.liveswitch.Channel.getClientTag ( )

Gets the client tag.

◆ getConnections()

fm.liveswitch.ManagedConnectionCollection fm.liveswitch.Channel.getConnections ( )

Gets the active connections.

◆ getDeviceAlias()

String fm.liveswitch.Channel.getDeviceAlias ( )

Gets the device alias.

◆ getDeviceId()

String fm.liveswitch.Channel.getDeviceId ( )

Gets the device identifier.

◆ getId()

String fm.liveswitch.Channel.getId ( )

Gets the channel identifier.

◆ getMessageBytesReceived()

long fm.liveswitch.Channel.getMessageBytesReceived ( )

Gets the number of message bytes received.

◆ getMessageBytesSent()

long fm.liveswitch.Channel.getMessageBytesSent ( )

Gets the number of message bytes sent.

◆ getMessagesReceived()

long fm.liveswitch.Channel.getMessagesReceived ( )

Gets the number of messages received.

◆ getMessagesSent()

long fm.liveswitch.Channel.getMessagesSent ( )

Gets the number of messages sent.

◆ getRemoteClientInfo()

fm.liveswitch.ClientInfo fm.liveswitch.Channel.getRemoteClientInfo ( String  clientId)

Gets information about a remote client.

Parameters
clientIdThe client identifier.

◆ getRemoteClientInfos()

fm.liveswitch.ClientInfo [] fm.liveswitch.Channel.getRemoteClientInfos ( )

Gets information about the remote client in this channel.

◆ getRemoteConnectionInfo()

fm.liveswitch.ConnectionInfo fm.liveswitch.Channel.getRemoteConnectionInfo ( String  connectionId)

Gets information about a remote connection.

Parameters
connectionIdThe connection identifier.

◆ getRemoteUpstreamConnectionInfos()

fm.liveswitch.ConnectionInfo [] fm.liveswitch.Channel.getRemoteUpstreamConnectionInfos ( )

Gets information about the remote upstream (SFU or MCU) connections opened by remote clients in this channel.

◆ getUserAlias()

String fm.liveswitch.Channel.getUserAlias ( )

Gets the user alias.

◆ getUserId()

String fm.liveswitch.Channel.getUserId ( )

Gets the user identifier.

◆ invite()

fm.liveswitch.Future<fm.liveswitch.Invitation> fm.liveswitch.Channel.invite ( String  userId,
String  protocol 
)

Invites a user into this channel.

Parameters
userIdThe user id to invite.
protocolThe protocol to use for the invite.

◆ kick()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.kick ( )

Kicks this channel.

Returns
A future that resolves when the channel has been kicked.

◆ kickClient() [1/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.kickClient ( fm.liveswitch.ClientInfo  remoteClientInfo)

Kicks a client in this channel.

Parameters
remoteClientInfoThe remote client information.
Returns
A future that resolves when the client has been kicked.

◆ kickClient() [2/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.kickClient ( String  userId,
String  deviceId,
String  clientId 
)

Kicks a client in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
Returns
A future that resolves when the client has been kicked.

◆ kickConnection() [1/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.kickConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo)

Kicks a connection in this channel.

Parameters
remoteConnectionInfoThe remote connection information.
Returns
A future that resolves when the connection has been kicked.

◆ kickConnection() [2/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.kickConnection ( String  userId,
String  deviceId,
String  clientId,
String  connectionId 
)

Kicks a connection in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
connectionIdThe connection identifier.
Returns
A future that resolves when the connection has been kicked.

◆ kickDevice()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.kickDevice ( String  userId,
String  deviceId 
)

Kicks a device in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
Returns
A future that resolves when the device has been kicked.

◆ kickUser()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.kickUser ( String  userId)

Kicks a user in this channel.

Parameters
userIdThe user identifier.
Returns
A future that resolves when the user has been kicked.

◆ rejectPeerConnection()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.rejectPeerConnection ( fm.liveswitch.PeerConnectionOffer  peerConnectionOffer)

Rejects a peer connection offer.

Parameters
peerConnectionOfferThe peer connection offer.

◆ removeOnClaimUpdate()

void fm.liveswitch.Channel.removeOnClaimUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ChannelClaim, fm.liveswitch.ChannelClaim value)

Removes a handler that is raised when the client's channel claim has been updated.

Parameters:

  • oldConnectionInfo - the old channel claim
  • newConnectionInfo - the new channel claim

◆ removeOnClientMessage()

void fm.liveswitch.Channel.removeOnClientMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Removes a handler that is raised when a channel/client-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ removeOnDeviceMessage()

void fm.liveswitch.Channel.removeOnDeviceMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Removes a handler that is raised when a channel/device-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ removeOnKick()

void fm.liveswitch.Channel.removeOnKick ( fm.liveswitch.IAction0  value)

Removes a handler that is raised when the client is kicked from the channel.

◆ removeOnMcuVideoLayout()

void fm.liveswitch.Channel.removeOnMcuVideoLayout ( fm.liveswitch.IAction1< fm.liveswitch.VideoLayout value)

Removes a handler that is raised when a new MCU video layout is received from the server.

Parameters:

  • videoLayout - the new MCU video layout

◆ removeOnMessage()

void fm.liveswitch.Channel.removeOnMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Removes a handler that is raised when a channel-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ removeOnPeerConnectionOffer()

void fm.liveswitch.Channel.removeOnPeerConnectionOffer ( fm.liveswitch.IAction1< fm.liveswitch.PeerConnectionOffer value)

Removes a handler that is raised when a remote client wants to open a peer connection.

Parameters:

  • peerConnectionOffer - the peer connection offer

◆ removeOnRemoteClientJoin()

void fm.liveswitch.Channel.removeOnRemoteClientJoin ( fm.liveswitch.IAction1< fm.liveswitch.ClientInfo value)

Removes a handler that is raised when a remote client joins this channel.

Parameters:

  • clientInfo - the remote client information

◆ removeOnRemoteClientLeave()

void fm.liveswitch.Channel.removeOnRemoteClientLeave ( fm.liveswitch.IAction1< fm.liveswitch.ClientInfo value)

Removes a handler that is raised when a remote client leaves this channel.

Parameters:

  • clientInfo - the remote client information

◆ removeOnRemoteClientUpdate()

void fm.liveswitch.Channel.removeOnRemoteClientUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, fm.liveswitch.ClientInfo value)

Removes a handler that is raised when a remote client updates their config.

Parameters:

  • oldClientInfo - the old remote client information
  • newClientInfo - the new remote client information

◆ removeOnRemoteUpstreamConnectionClose()

void fm.liveswitch.Channel.removeOnRemoteUpstreamConnectionClose ( fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo value)

Removes a handler that is raised when a remote upstream (SFU or MCU) connection is closed by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ removeOnRemoteUpstreamConnectionOpen()

void fm.liveswitch.Channel.removeOnRemoteUpstreamConnectionOpen ( fm.liveswitch.IAction1< fm.liveswitch.ConnectionInfo value)

Removes a handler that is raised when a remote upstream (SFU or MCU) connection is opened by a remote client.

Parameters:

  • connectionInfo - the remote connection information

◆ removeOnRemoteUpstreamConnectionUpdate()

void fm.liveswitch.Channel.removeOnRemoteUpstreamConnectionUpdate ( fm.liveswitch.IAction2< fm.liveswitch.ConnectionInfo, fm.liveswitch.ConnectionInfo value)

Removes a handler that is raised when a remote upstream (SFU or MCU) connection is updated by a remote client.

Parameters:

  • oldConnectionInfo - the old remote connection information
  • newConnectionInfo - the new remote connection information

◆ removeOnUserMessage()

void fm.liveswitch.Channel.removeOnUserMessage ( fm.liveswitch.IAction2< fm.liveswitch.ClientInfo, String >  value)

Removes a handler that is raised when a channel/user-scope message is received from the server.

Parameters:

  • clientInfo - the sending client information
  • message - the message

◆ send()

fm.liveswitch.Future<fm.liveswitch.Message> fm.liveswitch.Channel.send ( fm.liveswitch.Message  message)
protected

Sends a message.

Parameters
messageThe message.

◆ sendClientMessage()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.sendClientMessage ( String  userId,
String  deviceId,
String  clientId,
String  message 
)

Sends a message to a client in the channel.

Parameters
messageThe message to be sent.
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.

◆ sendDeviceMessage()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.sendDeviceMessage ( String  userId,
String  deviceId,
String  message 
)

Sends a message to a device in the channel.

Parameters
messageThe message to be sent.
userIdThe user identifier.
deviceIdThe device identifier.

◆ sendMessage()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.sendMessage ( String  message)

Sends a message to the channel.

Parameters
messageThe message to be sent.

◆ sendUserMessage()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.sendUserMessage ( String  userId,
String  message 
)

Sends a message to a user in the channel.

Parameters
userIdThe user identifier.
messageThe message.

◆ update()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.update ( fm.liveswitch.ChannelConfig  newConfig)

Updates this channel.

Parameters
newConfigThe channel configuration.
Returns
A future that resolves when the channel has been updated.

◆ updateClient() [1/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.updateClient ( fm.liveswitch.ClientInfo  remoteClientInfo,
fm.liveswitch.ChannelClientConfig  newConfig 
)

Updates a client in this channel.

Parameters
remoteClientInfoThe remote client information.
newConfigThe client configuration.
Returns
A future that resolves when the client has been updated.

◆ updateClient() [2/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.updateClient ( String  userId,
String  deviceId,
String  clientId,
fm.liveswitch.ChannelClientConfig  newConfig 
)

Updates a client in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
newConfigThe client configuration.
Returns
A future that resolves when the client has been updated.

◆ updateConnection() [1/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.updateConnection ( fm.liveswitch.ConnectionInfo  remoteConnectionInfo,
fm.liveswitch.ChannelConnectionConfig  newConfig 
)

Updates a connection in this channel.

Parameters
remoteConnectionInfoThe remote connection information.
newConfigThe connection configuration.
Returns
A future that resolves when the connection has been updated.

◆ updateConnection() [2/2]

fm.liveswitch.Future<Object> fm.liveswitch.Channel.updateConnection ( String  userId,
String  deviceId,
String  clientId,
String  connectionId,
fm.liveswitch.ChannelConnectionConfig  newConfig 
)

Updates a connection in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
clientIdThe client identifier.
connectionIdThe connection identifier.
newConfigThe connection configuration.
Returns
A future that resolves when the connection has been updated.

◆ updateDevice()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.updateDevice ( String  userId,
String  deviceId,
fm.liveswitch.ChannelDeviceConfig  newConfig 
)

Updates a device in this channel.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
newConfigThe device configuration.
Returns
A future that resolves when the device has been updated.

◆ updateUser()

fm.liveswitch.Future<Object> fm.liveswitch.Channel.updateUser ( String  userId,
fm.liveswitch.ChannelUserConfig  newConfig 
)

Updates a user in this channel.

Parameters
userIdThe user identifier.
newConfigThe user configuration.
Returns
A future that resolves when the user has been updated.