Class ServerConnection
A server connection.
Inheritance
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public abstract class ServerConnection : ManagedConnection
Constructors
ServerConnection(Object, String, String, String, String, String, Function1<Message, Future<Message>>, String, AudioStream, VideoStream, DataStream, String)
ServerConnection constructor.
Declaration
protected ServerConnection(object sharedLock, string applicationId, string channelId, string userId, string deviceId, string clientId, Function1<Message, Future<Message>> send, string connectionType, AudioStream audioStream, VideoStream videoStream, DataStream dataStream, string mediaId)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sharedLock | |
System.String | applicationId | |
System.String | channelId | |
System.String | userId | |
System.String | deviceId | |
System.String | clientId | |
Function1<Message, Future<Message>> | send | |
System.String | connectionType | |
AudioStream | audioStream | |
VideoStream | videoStream | |
DataStream | dataStream | |
System.String | mediaId |
ServerConnection(Object, String, String, String, String, String, Function1<Message, Future<Message>>, String, AudioStream, VideoStream, DataStream, String, Boolean)
ServerConnection constructor.
Declaration
protected ServerConnection(object sharedLock, string applicationId, string channelId, string userId, string deviceId, string clientId, Function1<Message, Future<Message>> send, string connectionType, AudioStream audioStream, VideoStream videoStream, DataStream dataStream, string mediaId, bool useWebSocketsForMedia)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sharedLock | |
System.String | applicationId | |
System.String | channelId | |
System.String | userId | |
System.String | deviceId | |
System.String | clientId | |
Function1<Message, Future<Message>> | send | |
System.String | connectionType | |
AudioStream | audioStream | |
VideoStream | videoStream | |
DataStream | dataStream | |
System.String | mediaId | |
System.Boolean | useWebSocketsForMedia |
Properties
InboundAudioBitrate
Gets the current inbound audio bitrate.
Declaration
public int InboundAudioBitrate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
InboundVideoBitrate
Gets the current inbound video bitrate.
Declaration
public int InboundVideoBitrate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
MediaServerId
Gets the identifier of the Media Server handling this connection.
Declaration
public string MediaServerId { get; }
Property Value
Type | Description |
---|---|
System.String |
PreferredMediaServerId
Gets or sets the preferred identifier of the Media Server to handle this connection.
Declaration
public string PreferredMediaServerId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
DetachInternalEventHandlers()
Detaches internal event handlers.
Declaration
protected override void DetachInternalEventHandlers()
Overrides
DoCreateCandidateMessage(Candidate)
Creates a candidate message.
Declaration
protected override Message DoCreateCandidateMessage(Candidate candidate)
Parameters
Type | Name | Description |
---|---|---|
Candidate | candidate | The candidate. |
Returns
Type | Description |
---|---|
Message |
Overrides
DoCreateCloseMessage()
Creates a close message.
Declaration
protected override Message DoCreateCloseMessage()
Returns
Type | Description |
---|---|
Message |
Overrides
DoCreateOfferMessage(SessionDescription)
Creates an offer message.
Declaration
protected abstract Message DoCreateOfferMessage(SessionDescription offer)
Parameters
Type | Name | Description |
---|---|---|
SessionDescription | offer | The offer. |
Returns
Type | Description |
---|---|
Message |
DoOpen()
Opens the connection.
Declaration
protected override void DoOpen()
Overrides
DoProcessMessage(Message)
Processes a message.
Declaration
protected override void DoProcessMessage(Message message)
Parameters
Type | Name | Description |
---|---|---|
Message | message | The message. |
Overrides
ProcessAnswer(Message)
Processes an answer.
Declaration
protected override void ProcessAnswer(Message message)
Parameters
Type | Name | Description |
---|---|---|
Message | message | The message. |
Overrides
ProcessError(Message)
Processes an error message.
Declaration
protected override void ProcessError(Message message)
Parameters
Type | Name | Description |
---|---|---|
Message | message | The message. |
Overrides
ProcessMediaIntentResponse(Message)
Processes an MediaIntentResponse message.
Declaration
protected override void ProcessMediaIntentResponse(Message message)
Parameters
Type | Name | Description |
---|---|---|
Message | message | The message. |
Overrides
ProcessRtcpDataChannelSignallingActivation(Message)
Processes inband signalling activation.
Declaration
protected override void ProcessRtcpDataChannelSignallingActivation(Message message)
Parameters
Type | Name | Description |
---|---|---|
Message | message |
Overrides
RaiseAudioBitrateNotification(AudioStream, BitrateNotification)
Raises an audio bitrate notification.
Declaration
protected override void RaiseAudioBitrateNotification(AudioStream audioStream, BitrateNotification bitrateNotification)
Parameters
Type | Name | Description |
---|---|---|
AudioStream | audioStream | The audio stream. |
BitrateNotification | bitrateNotification | The bitrate notification. |
Overrides
RaiseVideoBitrateNotification(VideoStream, BitrateNotification)
Raises a video bitrate notification.
Declaration
protected override void RaiseVideoBitrateNotification(VideoStream videoStream, BitrateNotification bitrateNotification)
Parameters
Type | Name | Description |
---|---|---|
VideoStream | videoStream | The video stream. |
BitrateNotification | bitrateNotification | The bitrate notification. |
Overrides
Send(Message)
Sends a message.
Declaration
protected override Future<Message> Send(Message message)
Parameters
Type | Name | Description |
---|---|---|
Message | message | The message. |
Returns
Type | Description |
---|---|
Future<Message> |
Overrides
TrySendRtcpDataChannel(Message)
Sends bitrate messages.
Declaration
protected override bool TrySendRtcpDataChannel(Message message)
Parameters
Type | Name | Description |
---|---|---|
Message | message | The message to send. |
Returns
Type | Description |
---|---|
System.Boolean |
Overrides
Events
OnInboundAudioBitrateChange
Raised when the inbound audio bitrate changes.
Declaration
public event Action2<int, int> OnInboundAudioBitrateChange
Event Type
Type | Description |
---|---|
Action2<System.Int32, System.Int32> |
OnInboundVideoBitrateChange
Raised when the inbound video bitrate changes.
Declaration
public event Action2<int, int> OnInboundVideoBitrateChange
Event Type
Type | Description |
---|---|
Action2<System.Int32, System.Int32> |