Class Channel

A channel.

Inheritance
System.Object
Serializable
Dynamic
Channel
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class Channel : Dynamic

Properties

ApplicationId

Gets the application identifier.

Declaration
public string ApplicationId { get; }
Property Value
Type Description
System.String

Claim

Gets or sets the claim.

Declaration
public ChannelClaim Claim { get; }
Property Value
Type Description
ChannelClaim

ClientId

Gets the client identifier.

Declaration
public string ClientId { get; }
Property Value
Type Description
System.String

ClientRoles

Gets the client roles.

Declaration
public string[] ClientRoles { get; }
Property Value
Type Description
System.String[]

ClientTag

Gets the client tag.

Declaration
public string ClientTag { get; }
Property Value
Type Description
System.String

Connections

Gets the active connections.

Declaration
public ManagedConnectionCollection Connections { get; }
Property Value
Type Description
ManagedConnectionCollection

DeviceAlias

Gets the device alias.

Declaration
public string DeviceAlias { get; }
Property Value
Type Description
System.String

DeviceId

Gets the device identifier.

Declaration
public string DeviceId { get; }
Property Value
Type Description
System.String

Id

Gets the channel identifier.

Declaration
public string Id { get; }
Property Value
Type Description
System.String

MessageBytesReceived

Gets the number of message bytes received.

Declaration
public long MessageBytesReceived { get; }
Property Value
Type Description
System.Int64

MessageBytesSent

Gets the number of message bytes sent.

Declaration
public long MessageBytesSent { get; }
Property Value
Type Description
System.Int64

MessagesReceived

Gets the number of messages received.

Declaration
public long MessagesReceived { get; }
Property Value
Type Description
System.Int64

MessagesSent

Gets the number of messages sent.

Declaration
public long MessagesSent { get; }
Property Value
Type Description
System.Int64

RemoteClientInfos

Gets information about the remote client in this channel.

Declaration
public ClientInfo[] RemoteClientInfos { get; }
Property Value
Type Description
ClientInfo[]

RemoteUpstreamConnectionInfos

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

Declaration
public ConnectionInfo[] RemoteUpstreamConnectionInfos { get; }
Property Value
Type Description
ConnectionInfo[]

UserAlias

Gets the user alias.

Declaration
public string UserAlias { get; }
Property Value
Type Description
System.String

UserId

Gets the user identifier.

Declaration
public string UserId { get; }
Property Value
Type Description
System.String

Methods

CloseAll()

Closes all active connections.

Declaration
public Future<object> CloseAll()
Returns
Type Description
Future<System.Object>

CreateMcuConnection(AudioStream)

Creates an audio-only MCU connection.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
Returns
Type Description
McuConnection

CreateMcuConnection(AudioStream, DataStream)

Creates an audio/data MCU connection.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream, DataStream dataStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
Returns
Type Description
McuConnection

CreateMcuConnection(AudioStream, DataStream, String)

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.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream, DataStream dataStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
McuConnection

CreateMcuConnection(AudioStream, VideoStream)

Creates an audio/video MCU connection.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream, VideoStream videoStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
Returns
Type Description
McuConnection

CreateMcuConnection(AudioStream, VideoStream, DataStream)

Creates an audio/video/data MCU connection.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
McuConnection

CreateMcuConnection(AudioStream, VideoStream, DataStream, String)

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.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream, VideoStream videoStream, DataStream dataStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
McuConnection

CreateMcuConnection(AudioStream, VideoStream, String)

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.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream, VideoStream videoStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
McuConnection

CreateMcuConnection(AudioStream, String)

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.

Declaration
public McuConnection CreateMcuConnection(AudioStream audioStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
McuConnection

CreateMcuConnection(DataStream)

Creates a data-only MCU connection.

Declaration
public McuConnection CreateMcuConnection(DataStream dataStream)
Parameters
Type Name Description
DataStream dataStream

The data stream.
Returns
Type Description
McuConnection

CreateMcuConnection(DataStream, String)

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.

Declaration
public McuConnection CreateMcuConnection(DataStream dataStream, string mediaId)
Parameters
Type Name Description
DataStream dataStream

The data stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
McuConnection

CreateMcuConnection(VideoStream)

Creates a video-only MCU connection.

Declaration
public McuConnection CreateMcuConnection(VideoStream videoStream)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
Returns
Type Description
McuConnection

CreateMcuConnection(VideoStream, DataStream)

Creates a video/data MCU connection.

Declaration
public McuConnection CreateMcuConnection(VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
McuConnection

CreateMcuConnection(VideoStream, DataStream, String)

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.

Declaration
public McuConnection CreateMcuConnection(VideoStream videoStream, DataStream dataStream, string mediaId)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
McuConnection

CreateMcuConnection(VideoStream, String)

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.

Declaration
public McuConnection CreateMcuConnection(VideoStream videoStream, string mediaId)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
McuConnection

CreatePeerConnection(ClientInfo, AudioStream)

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

Declaration
public PeerConnection CreatePeerConnection(ClientInfo remoteClientInfo, AudioStream audioStream)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
AudioStream audioStream

The audio stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(ClientInfo, AudioStream, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(ClientInfo remoteClientInfo, AudioStream audioStream, DataStream dataStream)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(ClientInfo, AudioStream, VideoStream)

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

Declaration
public PeerConnection CreatePeerConnection(ClientInfo remoteClientInfo, AudioStream audioStream, VideoStream videoStream)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(ClientInfo, AudioStream, VideoStream, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(ClientInfo remoteClientInfo, AudioStream audioStream, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(ClientInfo, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(ClientInfo remoteClientInfo, DataStream dataStream)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(ClientInfo, VideoStream)

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

Declaration
public PeerConnection CreatePeerConnection(ClientInfo remoteClientInfo, VideoStream videoStream)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
VideoStream videoStream

The video stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(ClientInfo, VideoStream, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(ClientInfo remoteClientInfo, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(PeerConnectionOffer, AudioStream)

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

Declaration
public PeerConnection CreatePeerConnection(PeerConnectionOffer peerConnectionOffer, AudioStream audioStream)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
AudioStream audioStream

The audio stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(PeerConnectionOffer, AudioStream, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(PeerConnectionOffer peerConnectionOffer, AudioStream audioStream, DataStream dataStream)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(PeerConnectionOffer, AudioStream, VideoStream)

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

Declaration
public PeerConnection CreatePeerConnection(PeerConnectionOffer peerConnectionOffer, AudioStream audioStream, VideoStream videoStream)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(PeerConnectionOffer, AudioStream, VideoStream, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(PeerConnectionOffer peerConnectionOffer, AudioStream audioStream, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(PeerConnectionOffer, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(PeerConnectionOffer peerConnectionOffer, DataStream dataStream)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(PeerConnectionOffer, VideoStream)

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

Declaration
public PeerConnection CreatePeerConnection(PeerConnectionOffer peerConnectionOffer, VideoStream videoStream)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
VideoStream videoStream

The video stream.
Returns
Type Description
PeerConnection

CreatePeerConnection(PeerConnectionOffer, VideoStream, DataStream)

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

Declaration
public PeerConnection CreatePeerConnection(PeerConnectionOffer peerConnectionOffer, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
PeerConnection

CreateSfuDownstreamConnection(ConnectionInfo, AudioStream)

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

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(ConnectionInfo remoteConnectionInfo, AudioStream audioStream)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
AudioStream audioStream

The audio stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(ConnectionInfo, AudioStream, DataStream)

Creates an audio/data SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(ConnectionInfo remoteConnectionInfo, AudioStream audioStream, DataStream dataStream)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(ConnectionInfo, AudioStream, VideoStream)

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

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(ConnectionInfo remoteConnectionInfo, AudioStream audioStream, VideoStream videoStream)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(ConnectionInfo, AudioStream, VideoStream, DataStream)

Creates an audio/video/data SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(ConnectionInfo remoteConnectionInfo, AudioStream audioStream, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(ConnectionInfo, DataStream)

Creates a data-only SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(ConnectionInfo remoteConnectionInfo, DataStream dataStream)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(ConnectionInfo, VideoStream)

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

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(ConnectionInfo remoteConnectionInfo, VideoStream videoStream)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
VideoStream videoStream

The video stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(ConnectionInfo, VideoStream, DataStream)

Creates a video/data SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(ConnectionInfo remoteConnectionInfo, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(String, AudioStream)

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

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(string remoteMediaId, AudioStream audioStream)
Parameters
Type Name Description
System.String remoteMediaId

The remote media identifier.
AudioStream audioStream

The audio stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(String, AudioStream, DataStream)

Creates an audio/data SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(string remoteMediaId, AudioStream audioStream, DataStream dataStream)
Parameters
Type Name Description
System.String remoteMediaId

The remote media identifier.
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(String, AudioStream, VideoStream)

Creates an audio/video SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(string remoteMediaId, AudioStream audioStream, VideoStream videoStream)
Parameters
Type Name Description
System.String remoteMediaId

The remote media identifier.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(String, AudioStream, VideoStream, DataStream)

Creates an audio/video/data SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(string remoteMediaId, AudioStream audioStream, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
System.String remoteMediaId

The remote media identifier.
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(String, DataStream)

Creates a data-only SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(string remoteMediaId, DataStream dataStream)
Parameters
Type Name Description
System.String remoteMediaId

The remote media identifier.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(String, VideoStream)

Creates a video-only SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(string remoteMediaId, VideoStream videoStream)
Parameters
Type Name Description
System.String remoteMediaId

The remote media identifier.
VideoStream videoStream

The video stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuDownstreamConnection(String, VideoStream, DataStream)

Creates a video/data SFU downstream connection.

Declaration
public SfuDownstreamConnection CreateSfuDownstreamConnection(string remoteMediaId, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
System.String remoteMediaId

The remote media identifier.
VideoStream videoStream

The audio stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuDownstreamConnection

CreateSfuUpstreamConnection(AudioStream)

Creates an audio-only SFU upstream connection.

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(AudioStream, DataStream)

Creates an audio/data SFU upstream connection.

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream, DataStream dataStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(AudioStream, DataStream, String)

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

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream, DataStream dataStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
DataStream dataStream

The data stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(AudioStream, VideoStream)

Creates an audio/video SFU upstream connection.

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream, VideoStream videoStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(AudioStream, VideoStream, DataStream)

Creates an audio/video/data SFU upstream connection.

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream, VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(AudioStream, VideoStream, DataStream, String)

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

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream, VideoStream videoStream, DataStream dataStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
DataStream dataStream

The video stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(AudioStream, VideoStream, String)

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

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream, VideoStream videoStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
VideoStream videoStream

The video stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(AudioStream, String)

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

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(AudioStream audioStream, string mediaId)
Parameters
Type Name Description
AudioStream audioStream

The audio stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(DataStream)

Creates a data-only SFU upstream connection.

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(DataStream dataStream)
Parameters
Type Name Description
DataStream dataStream

The data stream.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(DataStream, String)

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

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(DataStream dataStream, string mediaId)
Parameters
Type Name Description
DataStream dataStream

The data stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(VideoStream)

Creates a video-only SFU upstream connection.

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(VideoStream videoStream)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(VideoStream, DataStream)

Creates a video/data SFU upstream connection.

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(VideoStream videoStream, DataStream dataStream)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(VideoStream, DataStream, String)

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

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(VideoStream videoStream, DataStream dataStream, string mediaId)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
DataStream dataStream

The data stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
SfuUpstreamConnection

CreateSfuUpstreamConnection(VideoStream, String)

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

Declaration
public SfuUpstreamConnection CreateSfuUpstreamConnection(VideoStream videoStream, string mediaId)
Parameters
Type Name Description
VideoStream videoStream

The video stream.
System.String mediaId

The media identifier, unique to this channel, for persistent SFU downstream connections.
Returns
Type Description
SfuUpstreamConnection

GetRemoteClientInfo(String)

Gets information about a remote client.

Declaration
public ClientInfo GetRemoteClientInfo(string clientId)
Parameters
Type Name Description
System.String clientId

The client identifier.
Returns
Type Description
ClientInfo

GetRemoteConnectionInfo(String)

Gets information about a remote connection.

Declaration
public ConnectionInfo GetRemoteConnectionInfo(string connectionId)
Parameters
Type Name Description
System.String connectionId

The connection identifier.
Returns
Type Description
ConnectionInfo

Invite(String, String)

Invites a user into this channel.

Declaration
public Future<Invitation> Invite(string userId, string protocol)
Parameters
Type Name Description
System.String userId

The user id to invite.
System.String protocol

The protocol to use for the invite.
Returns
Type Description
Future<Invitation>

Kick()

Kicks this channel.

Declaration
public Future<object> Kick()
Returns
Type Description
Future<System.Object>

A future that resolves when the channel has been kicked.

KickClient(ClientInfo)

Kicks a client in this channel.

Declaration
public Future<object> KickClient(ClientInfo remoteClientInfo)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
Returns
Type Description
Future<System.Object>

A future that resolves when the client has been kicked.

KickClient(String, String, String)

Kicks a client in this channel.

Declaration
public Future<object> KickClient(string userId, string deviceId, string clientId)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String clientId

The client identifier.
Returns
Type Description
Future<System.Object>

A future that resolves when the client has been kicked.

KickConnection(ConnectionInfo)

Kicks a connection in this channel.

Declaration
public Future<object> KickConnection(ConnectionInfo remoteConnectionInfo)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
Returns
Type Description
Future<System.Object>

A future that resolves when the connection has been kicked.

KickConnection(String, String, String, String)

Kicks a connection in this channel.

Declaration
public Future<object> KickConnection(string userId, string deviceId, string clientId, string connectionId)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String clientId

The client identifier.
System.String connectionId

The connection identifier.
Returns
Type Description
Future<System.Object>

A future that resolves when the connection has been kicked.

KickDevice(String, String)

Kicks a device in this channel.

Declaration
public Future<object> KickDevice(string userId, string deviceId)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
Returns
Type Description
Future<System.Object>

A future that resolves when the device has been kicked.

KickUser(String)

Kicks a user in this channel.

Declaration
public Future<object> KickUser(string userId)
Parameters
Type Name Description
System.String userId

The user identifier.
Returns
Type Description
Future<System.Object>

A future that resolves when the user has been kicked.

RejectPeerConnection(PeerConnectionOffer)

Rejects a peer connection offer.

Declaration
public Future<object> RejectPeerConnection(PeerConnectionOffer peerConnectionOffer)
Parameters
Type Name Description
PeerConnectionOffer peerConnectionOffer

The peer connection offer.
Returns
Type Description
Future<System.Object>

Send(Message)

Sends a message.

Declaration
protected Future<Message> Send(Message message)
Parameters
Type Name Description
Message message

The message.
Returns
Type Description
Future<Message>

SendClientMessage(String, String, String, String)

Sends a message to a client in the channel.

Declaration
public Future<object> SendClientMessage(string userId, string deviceId, string clientId, string message)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String clientId

The client identifier.
System.String message

The message to be sent.
Returns
Type Description
Future<System.Object>

SendDeviceMessage(String, String, String)

Sends a message to a device in the channel.

Declaration
public Future<object> SendDeviceMessage(string userId, string deviceId, string message)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String message

The message to be sent.
Returns
Type Description
Future<System.Object>

SendMessage(String)

Sends a message to the channel.

Declaration
public Future<object> SendMessage(string message)
Parameters
Type Name Description
System.String message

The message to be sent.
Returns
Type Description
Future<System.Object>

SendUserMessage(String, String)

Sends a message to a user in the channel.

Declaration
public Future<object> SendUserMessage(string userId, string message)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String message

The message.
Returns
Type Description
Future<System.Object>

Update(ChannelConfig)

Updates this channel.

Declaration
public Future<object> Update(ChannelConfig newConfig)
Parameters
Type Name Description
ChannelConfig newConfig

The channel configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the channel has been updated.

UpdateClient(ClientInfo, ChannelClientConfig)

Updates a client in this channel.

Declaration
public Future<object> UpdateClient(ClientInfo remoteClientInfo, ChannelClientConfig newConfig)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
ChannelClientConfig newConfig

The client configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the client has been updated.

UpdateClient(String, String, String, ChannelClientConfig)

Updates a client in this channel.

Declaration
public Future<object> UpdateClient(string userId, string deviceId, string clientId, ChannelClientConfig newConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String clientId

The client identifier.
ChannelClientConfig newConfig

The client configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the client has been updated.

UpdateClientLayout(ClientInfo, ChannelClientLayoutConfig)

Applies a layout update to all upstream connections for the specified client in this channel.

Declaration
public Future<object> UpdateClientLayout(ClientInfo remoteClientInfo, ChannelClientLayoutConfig newConfig)
Parameters
Type Name Description
ClientInfo remoteClientInfo

The remote client information.
ChannelClientLayoutConfig newConfig

The client configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the client layout has been updated.

UpdateClientLayout(String, String, String, ChannelClientLayoutConfig)

Applies a layout update to all upstream connections for the specified client in this channel.

Declaration
public Future<object> UpdateClientLayout(string userId, string deviceId, string clientId, ChannelClientLayoutConfig newConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String clientId

The client identifier.
ChannelClientLayoutConfig newConfig

The client configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the client layout has been updated.

UpdateConnection(ConnectionInfo, ChannelConnectionConfig)

Updates a connection in this channel.

Declaration
public Future<object> UpdateConnection(ConnectionInfo remoteConnectionInfo, ChannelConnectionConfig newConfig)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
ChannelConnectionConfig newConfig

The connection configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the connection has been updated.

UpdateConnection(String, String, String, String, ChannelConnectionConfig)

Updates a connection in this channel.

Declaration
public Future<object> UpdateConnection(string userId, string deviceId, string clientId, string connectionId, ChannelConnectionConfig newConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String clientId

The client identifier.
System.String connectionId

The connection identifier.
ChannelConnectionConfig newConfig

The connection configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the connection has been updated.

UpdateConnectionLayout(ConnectionInfo, ChannelConnectionLayoutConfig)

Updates a connection in this channel.

Declaration
public Future<object> UpdateConnectionLayout(ConnectionInfo remoteConnectionInfo, ChannelConnectionLayoutConfig newConfig)
Parameters
Type Name Description
ConnectionInfo remoteConnectionInfo

The remote connection information.
ChannelConnectionLayoutConfig newConfig

The connection configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the connection has been updated.

UpdateConnectionLayout(String, String, String, String, ChannelConnectionLayoutConfig)

Applies a layout update to the specified upstream connection in this channel.

Declaration
public Future<object> UpdateConnectionLayout(string userId, string deviceId, string clientId, string connectionId, ChannelConnectionLayoutConfig newConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
System.String clientId

The client identifier.
System.String connectionId

The connection identifier.
ChannelConnectionLayoutConfig newConfig

The connection configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the connection layout has been updated.

UpdateDevice(String, String, ChannelDeviceConfig)

Updates a device in this channel.

Declaration
public Future<object> UpdateDevice(string userId, string deviceId, ChannelDeviceConfig newConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
ChannelDeviceConfig newConfig

The device configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the device has been updated.

UpdateDeviceLayout(String, String, ChannelDeviceLayoutConfig)

Applies a layout update to all upstream connections for the specified device in this channel.

Declaration
public Future<object> UpdateDeviceLayout(string userId, string deviceId, ChannelDeviceLayoutConfig newConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
System.String deviceId

The device identifier.
ChannelDeviceLayoutConfig newConfig

The device layout configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the device layout has been updated.

UpdateLayout(ChannelLayoutConfig)

Applies a layout update to all upstream connections on this channel

Declaration
public Future<object> UpdateLayout(ChannelLayoutConfig newLayoutConfig)
Parameters
Type Name Description
ChannelLayoutConfig newLayoutConfig

The channel layout configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the channel layout has been updated.

UpdateUser(String, ChannelUserConfig)

Updates a user in this channel.

Declaration
public Future<object> UpdateUser(string userId, ChannelUserConfig newConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
ChannelUserConfig newConfig

The user configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the user has been updated.

UpdateUserLayout(String, ChannelUserLayoutConfig)

Applies a layout update to all upstream connections for the specified user in this channel.

Declaration
public Future<object> UpdateUserLayout(string userId, ChannelUserLayoutConfig newLayoutConfig)
Parameters
Type Name Description
System.String userId

The user identifier.
ChannelUserLayoutConfig newLayoutConfig

The user layout configuration.
Returns
Type Description
Future<System.Object>

A future that resolves when the user layout has been updated.

Events

OnClaimUpdate

Raised when the client's channel claim has been updated. Parameters:

  • oldConnectionInfo - the old channel claim
  • newConnectionInfo - the new channel claim
Declaration
public event Action2<ChannelClaim, ChannelClaim> OnClaimUpdate
Event Type
Type Description
Action2<ChannelClaim, ChannelClaim>

OnClientMessage

Raised when a channel/client-scope message is received from the server. Parameters:

  • clientInfo - the sending client information
  • message - the message
Declaration
public event Action2<ClientInfo, string> OnClientMessage
Event Type
Type Description
Action2<ClientInfo, System.String>

OnDeviceMessage

Raised when a channel/device-scope message is received from the server. Parameters:

  • clientInfo - the sending client information
  • message - the message
Declaration
public event Action2<ClientInfo, string> OnDeviceMessage
Event Type
Type Description
Action2<ClientInfo, System.String>

OnKick

Raised when the client is kicked from the channel.

Declaration
public event Action0 OnKick
Event Type
Type Description
Action0

OnMcuVideoLayout

Raised when a new MCU video layout is received from the server. Parameters:

  • videoLayout - the new MCU video layout
Declaration
public event Action1<VideoLayout> OnMcuVideoLayout
Event Type
Type Description
Action1<VideoLayout>

OnMessage

Raised when a channel-scope message is received from the server. Parameters:

  • clientInfo - the sending client information
  • message - the message
Declaration
public event Action2<ClientInfo, string> OnMessage
Event Type
Type Description
Action2<ClientInfo, System.String>

OnPeerConnectionOffer

Raised when a remote client wants to open a peer connection. Parameters:

  • peerConnectionOffer - the peer connection offer
Declaration
public event Action1<PeerConnectionOffer> OnPeerConnectionOffer
Event Type
Type Description
Action1<PeerConnectionOffer>

OnRemoteClientJoin

Raised when a remote client joins this channel. Parameters:

  • clientInfo - the remote client information
Declaration
public event Action1<ClientInfo> OnRemoteClientJoin
Event Type
Type Description
Action1<ClientInfo>

OnRemoteClientLeave

Raised when a remote client leaves this channel. Parameters:

  • clientInfo - the remote client information
Declaration
public event Action1<ClientInfo> OnRemoteClientLeave
Event Type
Type Description
Action1<ClientInfo>

OnRemoteClientUpdate

Raised when a remote client updates their config. Parameters:

  • oldClientInfo - the old remote client information
  • newClientInfo - the new remote client information
Declaration
public event Action2<ClientInfo, ClientInfo> OnRemoteClientUpdate
Event Type
Type Description
Action2<ClientInfo, ClientInfo>

OnRemoteUpstreamConnectionClose

Raised when a remote upstream (SFU or MCU) connection is closed by a remote client. Parameters:

  • connectionInfo - the remote connection information
Declaration
public event Action1<ConnectionInfo> OnRemoteUpstreamConnectionClose
Event Type
Type Description
Action1<ConnectionInfo>

OnRemoteUpstreamConnectionOpen

Raised when a remote upstream (SFU or MCU) connection is opened by a remote client. Parameters:

  • connectionInfo - the remote connection information
Declaration
public event Action1<ConnectionInfo> OnRemoteUpstreamConnectionOpen
Event Type
Type Description
Action1<ConnectionInfo>

OnRemoteUpstreamConnectionUpdate

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
Declaration
public event Action2<ConnectionInfo, ConnectionInfo> OnRemoteUpstreamConnectionUpdate
Event Type
Type Description
Action2<ConnectionInfo, ConnectionInfo>

OnUserMessage

Raised when a channel/user-scope message is received from the server. Parameters:

  • clientInfo - the sending client information
  • message - the message
Declaration
public event Action2<ClientInfo, string> OnUserMessage
Event Type
Type Description
Action2<ClientInfo, System.String>