Search Results for

    Show / Hide Table of Contents

    Class ServerConnection

    A server connection.

    Inheritance
    System.Object
    Serializable
    Dynamic
    ManagedConnection
    ServerConnection
    McuConnection
    SfuConnection
    Inherited Members
    ManagedConnection.MediaProtocol
    ManagedConnection.DefaultStatsInterval
    ManagedConnection.DefaultStatsReportInterval
    ManagedConnection.DefaultStatsEventInterval
    ManagedConnection.DefaultNoMediaServerTimeout
    ManagedConnection.RecordingEnabled
    ManagedConnection.OnRecordingEnabled
    ManagedConnection.OnRecordingDisabled
    ManagedConnection.AudioUnmuteDisabled
    ManagedConnection.VideoUnmuteDisabled
    ManagedConnection.OnAudioUnmuteDisabled
    ManagedConnection.OnVideoUnmuteDisabled
    ManagedConnection.OnAudioUnmuteEnabled
    ManagedConnection.OnVideoUnmuteEnabled
    ManagedConnection.Info
    ManagedConnection.Config
    ManagedConnection.LocalAudioMuted
    ManagedConnection.LocalVideoMuted
    ManagedConnection.RemoteAudioMuted
    ManagedConnection.RemoteVideoMuted
    ManagedConnection.LocalAudioDisabled
    ManagedConnection.LocalVideoDisabled
    ManagedConnection.LocalDataDisabled
    ManagedConnection.RemoteAudioDisabled
    ManagedConnection.RemoteVideoDisabled
    ManagedConnection.RemoteDataDisabled
    ManagedConnection.AudioDirection
    ManagedConnection.LocalAudioDirection
    ManagedConnection.VideoDirection
    ManagedConnection.LocalVideoDirection
    ManagedConnection.DataDirection
    ManagedConnection.LocalDataDirection
    ManagedConnection.RemoteAudioEncoding
    ManagedConnection.RemoteVideoEncoding
    ManagedConnection.LocalAudioFormats
    ManagedConnection.LocalVideoFormats
    ManagedConnection.RemoteAudioFormats
    ManagedConnection.RemoteVideoFormats
    ManagedConnection.OnRemoteAudioEncodingSwitch
    ManagedConnection.OnRemoteVideoEncodingSwitch
    ManagedConnection.OnRemoteUpdate
    ManagedConnection.ApplicationId
    ManagedConnection.ChannelId
    ManagedConnection.UserId
    ManagedConnection.DeviceId
    ManagedConnection.ClientId
    ManagedConnection.Id
    ManagedConnection.CanonicalName
    ManagedConnection.ExternalId
    ManagedConnection.MediaId
    ManagedConnection.UseWebSocketsForMedia
    ManagedConnection.RemoteMediaId
    ManagedConnection.RemoteConnectionId
    ManagedConnection.State
    ManagedConnection.SignallingState
    ManagedConnection.IceConnectionState
    ManagedConnection.GatheringState
    ManagedConnection.OnStateChange
    ManagedConnection.OnSignallingStateChange
    ManagedConnection.OnIceConnectionStateChange
    ManagedConnection.OnGatheringStateChange
    ManagedConnection.OnLocalDescription
    ManagedConnection.OnRemoteDescription
    ManagedConnection.OnLocalCandidate
    ManagedConnection.OnRemoteCandidate
    ManagedConnection.OnAutomaticIceServers
    ManagedConnection.OnNoMediaServersAvailable
    ManagedConnection.OnNoWebSocketMediaServersAvailable
    ManagedConnection.StatsInterval
    ManagedConnection.StatsReportInterval
    ManagedConnection.StatsEventInterval
    ManagedConnection.OnStats
    ManagedConnection.OnMediaQuality
    ManagedConnection.MediaQuality
    ManagedConnection.OnNetworkQuality
    ManagedConnection.NetworkQuality
    ManagedConnection.Error
    ManagedConnection.BundlePolicy
    ManagedConnection.IceGatherPolicy
    ManagedConnection.IceServer
    ManagedConnection.IceServers
    ManagedConnection.TrickleIcePolicy
    ManagedConnection.IcePolicy
    ManagedConnection.KeepAliveInterval
    ManagedConnection.PrivateIPAddress
    ManagedConnection.PrivateIPAddresses
    ManagedConnection.IcePortRange
    ManagedConnection.IceAddressTypes
    ManagedConnection.TcpConnectTimeout
    ManagedConnection.TurnAllocateRequestLimit
    ManagedConnection.StunBindingRequestLimit
    ManagedConnection.StunRequestTimeout
    ManagedConnection.IceRole
    ManagedConnection.DtlsServerMinVersion
    ManagedConnection.DtlsServerMaxVersion
    ManagedConnection.DtlsClientVersion
    ManagedConnection.DefaultLocalDtlsCertificate
    ManagedConnection.DefaultLocalDtlsCertificates
    ManagedConnection.LocalDtlsCertificate
    ManagedConnection.LocalDtlsCertificates
    ManagedConnection.DtlsCipherSuites
    ManagedConnection.MultiplexPolicy
    ManagedConnection.CreateDatagramSocket
    ManagedConnection.CreateStreamSocket
    ManagedConnection.DisableAutomaticIceServers
    ManagedConnection.TestRoundTripTime
    ManagedConnection.TestReceivedRtpBuffer
    ManagedConnection.TestSendingRtpBuffer
    ManagedConnection.LocalDescription
    ManagedConnection.RemoteDescription
    ManagedConnection.Type
    ManagedConnection.Tag
    ManagedConnection.LayoutZone
    ManagedConnection.LayoutPriority
    ManagedConnection.RemoteTag
    ManagedConnection.HasAudio
    ManagedConnection.HasVideo
    ManagedConnection.HasData
    ManagedConnection.AudioStream
    ManagedConnection.VideoStream
    ManagedConnection.DataStream
    ManagedConnection.RemoteClosed
    ManagedConnection.RemoteRejected
    ManagedConnection.NoMediaServerTimeout
    ManagedConnection.InternalRtcpDataChannel
    ManagedConnection.DeadStreamTimeout
    ManagedConnection.GetStats()
    ManagedConnection.IsMediaDirectionAllowed(String)
    ManagedConnection.Update(ConnectionConfig)
    ManagedConnection.DoCreateUpdateMessage(ConnectionConfig)
    ManagedConnection.RaiseLocalCandidate(Candidate)
    ManagedConnection.RaiseRemoteCandidate(Candidate)
    ManagedConnection.Open()
    ManagedConnection.MediaIntents
    ManagedConnection.ProcessIceServers(Message)
    ManagedConnection.WmsAddress
    ManagedConnection.WmsConnectionToken
    ManagedConnection.DoCreateUseWebSocketServiceMessage()
    ManagedConnection.Close()
    ManagedConnection.RaiseAudioBitrateRequest(AudioStream, BitrateRequest)
    ManagedConnection.RaiseVideoBitrateRequest(VideoStream, BitrateRequest)
    ManagedConnection.RaiseNoMediaServersAvailable(NoMediaServersAvailableEventArgs)
    ManagedConnection.RaiseNoWebSocketMediaServersAvailable(NoWebSocketMediaServersAvailableEventArgs)
    ManagedConnection.ProcessLocalError(Error)
    Dynamic.DynamicProperties
    Dynamic.GetDynamicValue(String)
    Dynamic.SetDynamicValue(String, Object)
    Dynamic.UnsetDynamicValue(String)
    Serializable.IsDirty
    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
    ManagedConnection.DetachInternalEventHandlers()

    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
    ManagedConnection.DoCreateCandidateMessage(Candidate)

    DoCreateCloseMessage()

    Creates a close message.

    Declaration
    protected override Message DoCreateCloseMessage()
    Returns
    Type Description
    Message
    Overrides
    ManagedConnection.DoCreateCloseMessage()

    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
    ManagedConnection.DoOpen()

    DoProcessMessage(Message)

    Processes a message.

    Declaration
    protected override void DoProcessMessage(Message message)
    Parameters
    Type Name Description
    Message message

    The message.

    Overrides
    ManagedConnection.DoProcessMessage(Message)

    ProcessAnswer(Message)

    Processes an answer.

    Declaration
    protected override void ProcessAnswer(Message message)
    Parameters
    Type Name Description
    Message message

    The message.

    Overrides
    ManagedConnection.ProcessAnswer(Message)

    ProcessError(Message)

    Processes an error message.

    Declaration
    protected override void ProcessError(Message message)
    Parameters
    Type Name Description
    Message message

    The message.

    Overrides
    ManagedConnection.ProcessError(Message)

    ProcessMediaIntentResponse(Message)

    Processes an MediaIntentResponse message.

    Declaration
    protected override void ProcessMediaIntentResponse(Message message)
    Parameters
    Type Name Description
    Message message

    The message.

    Overrides
    ManagedConnection.ProcessMediaIntentResponse(Message)

    ProcessRtcpDataChannelSignallingActivation(Message)

    Processes inband signalling activation.

    Declaration
    protected override void ProcessRtcpDataChannelSignallingActivation(Message message)
    Parameters
    Type Name Description
    Message message
    Overrides
    ManagedConnection.ProcessRtcpDataChannelSignallingActivation(Message)

    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
    ManagedConnection.RaiseAudioBitrateNotification(AudioStream, BitrateNotification)

    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
    ManagedConnection.RaiseVideoBitrateNotification(VideoStream, BitrateNotification)

    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
    ManagedConnection.Send(Message)

    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
    ManagedConnection.TrySendRtcpDataChannel(Message)

    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>
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.19.0