Namespace FM.LiveSwitch
Classes
AecContext
An acoustic echo cancellation context.
AecPipe
An acoustic echo cancellation (AEC) pipe.
AfbControlFrame
An Application Layer Feedback control (RFC 4585).
AndroidLogProvider
Log provider that writes output to the Android log.
AppControlFrame
An RTCP APP packet.
ApplicationInfo
Application information.
Ascii
ASCII encoding/decoding utility.
AsymmetricKey
An asymmetric key.
AtomicInteger
A integer that can be operatered on atomically.
AtomicLong
A long that can be operatered on atomically.
AtomicMutex
A managed mutex.
AudioBranch
An audio branch.
AudioBuffer
An audio buffer.
AudioBufferCollection
An audio buffer collection.
AudioClock
A clock used to raise audio data in appropriate intervals.
AudioConfig
An audio configuration.
AudioDecoder
An audio decoder.
AudioDepacketizer
An audio depacketizer.
AudioEncoder
An audio encoder.
AudioEncodingConfig
Audio encoding configuration.
AudioFormat
An audio format.
AudioFormatCollection
A collection of audio formats.
AudioFrame
An audio frame.
AudioMixer
A mixer that mixes multiple audio inputs into a single output.
AudioPacketizer
An audio packetizer.
AudioPipe
An audio pipe.
AudioRecorder
An audio recorder.
AudioSink
An audio sink.
AudioSource
An audio source.
AudioStream
An audio stream.
AudioSynchronizer
An audio pipe for synchronizing playout with other streams.
AudioTrack
An audio chain.
Base64
Base64 utility.
BaseStats
Base stats.
BasicAudioDepacketizer
A basic audio depacketizer.
BasicAudioPacketizer
A basic audio packetizer.
BasicVideoDepacketizer
A basic video depacketizer.
BasicVideoPacketizer
A basic video packetizer.
Binary
Common binary methods.
BitAssistant
Contains methods for cross-platform bit manipulation.
BitrateMonitor
A bitrate monitor.
BitrateNotification
A bitrate notification.
BitrateQueue
A bitrate queue.
BitrateRequest
A bitrate request.
BooleanHolder
Class to hold a boolean value passed by reference.
Build
Details about the current build.
ByeControlFrame
An RTCP BYE packet.
ByteCollection
A collection of bytes.
ByteHolder
Class to hold a byte value passed by reference.
ByteInputStream
An buffer of bytes that can be read sequentially.
ByteOutputStream
An buffer of bytes that can be written sequentially.
CameraSourceBase
A base class for camera-based sources.
Candidate
A candidate.
CandidateInfo
Candidate information.
CandidatePairInfo
Candidate pair information.
CandidatePairReport
Candidate pair report.
CandidatePairStats
Candidate pair stats.
CandidateStats
Candidate stats.
CandidateUtility
Utility functions for candidate and candidate pair.
CcmUtility
A utility for codec control messages (CCM).
Certificate<TCertificate, TFingerprint>
A certificate to be used for secure communication.
CertificateInfo
Certificate information.
CertificateStats
Certificate stats.
Channel
A channel.
ChannelClaim
A channel claim.
ChannelClientConfig
Channel client configuration.
ChannelClientLayoutConfig
Channel client configuration.
ChannelConfig
Channel configuration.
ChannelConnectionConfig
Channel connection configuration.
ChannelConnectionLayoutConfig
Channel connection configuration.
ChannelDeviceConfig
Channel device configuration.
ChannelDeviceLayoutConfig
Channel device layout configuration.
ChannelInfo
Channel information.
ChannelLayoutConfig
Channel layout configuration.
ChannelReport
Channel report.
ChannelUserConfig
Channel user configuration.
ChannelUserLayoutConfig
Channel user layout configuration.
CharacterHolder
Class to hold a character value passed by reference.
CircularBuffer
A circular buffer.
CircularDataBuffer
A DataBuffer that uses a circular buffer to manage data.
ClaimAction
A claim action.
Client
A LiveSwitch client.
ClientConfig
Client configuration.
ClientInfo
Client information.
ClientReport
Client report.
ClientStateMachine
A state machine for Client states.
CodecInfo
Codec information.
CodecStats
Codec stats.
Collection<T, TCollection>
A collection of values.
Color
A color.
ConnectionBase<TConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel>
Connection base properties/methods.
ConnectionConfig
Connection configuration.
ConnectionInfo
Connection information.
ConnectionStateMachine
A state machine for connection states.
ConnectionStats
Connection stats.
ConnectionType
A connection type.
ConsoleLogProvider
Log provider that writes output to the console/terminal.
Constants
A collection of platform-independent constant values.
ControlFrameEntry
RTCP frame entry.
Crc32
Calculates CRC32 checksums.
DataBuffer
Binary data buffer implementation
DataBufferFramer
A utility class that allows a continuous stream of data to be written to it with properly framed messages being read out of it. This class is not thread-safe for concurrent reads/writes.
DataBufferPool
A data buffer pool.
DataBufferPoolTracer
A data buffer pool tracer.
DataBufferStream
A data buffer stream.
DataBufferSubset
A subset of a DataBuffer.
DataChannel
A data channel.
DataChannelBase<TDataChannel>
Data channel base properties/methods.
DataChannelCollection
A collection of data channels.
DataChannelInfo
Data channel information.
DataChannelReceiveArgs
Arguments for the data channel receive event.
DataChannelReport
Data channel report.
DataChannelStateMachine
A state machine for data channel states.
DataChannelStats
Data channel stats.
DatagramSocket
A datagram socket.
DatagramSocketCreateArgs
Arguments for a datagram socket create event.
DataStream
A data stream.
DataStreamBase<TDataChannel>
Data stream base properties/methods.
DataStreamInfo
Data stream information.
DataStreamReport
Data stream report.
DataStreamStats
Data stream stats.
DebugLogProvider
Log provider that uses System.Diagnostics.Debug.
DiagnosticSampler
A record that calculates the min, max, and average from integer samples.
DispatchQueue<T>
A dispatch queue.
Dns
DNS utility methods.
DnsRequest
A DNS request.
DoubleHolder
Class to hold a double value passed by reference.
DtlsCertificate
A certificate to be used for DTLS communication.
DtlsFingerprint
A DTLS fingerprint.
DtlsParameters
A set of DTLS parameters.
Dynamic
Supplies class instances with a key-value mapping to support dynamic property storage.
EcdsaCrypto
Elliptic-curve-based cryptographic functions.
EcdsaKey
An elliptic-curve key.
EncodingConfig
Encoding configuration.
EncodingInfo
Encoding information.
Error
An error.
EventBatch
An event batch.
EventInfo
Event information.
EventOrigin
Event origins.
EventType
Event types.
ExternalNetworkInfo
External network information.
FakeAudioSource
A fake audio source.
FakeVideoSource
A fake video source.
FecProtectionParameters
FEC protection parameters.
Feedback
Control frame feedback.
FeedbackControlFrame
An RTCP Feedback packet.
FileAssistant
A utility class for reading/writing from/to a File.
FileLogProvider
Log provider that writes output to a file.
FileStream
A file stream.
Fingerprint
A fingerprint.
FirControlFrame
An RTCP full intra request (FIR) packet.
FirEntry
An RTCP full intra request (FIR) packet entry.
FloatHolder
Class to hold a float value passed by reference.
FormatInfo
Format information.
FrameRateController
A frame-rate controller.
FrameRatePipe
A frame-rate pipe.
FrequentReadSynchronizedHash<TKey, TValue>
Synchronized Hash for inserts/removes. Unsynchronized for reads. Optimized for frequent reads relative to writes.
FrequentReadSynchronizedList<T>
Synchronized List for inserts/removes. Unsynchronized for reads. Optimized for frequent reads relative to writes.
Future<T>
A future.
FutureBase<T>
Future base properties/methods.
FutureExtensions
Windows only Future extensions
GenericNack
A Generic NACK feedback message.
GenericNackControlFrame
An RTCP Feedback RTP-Generic NACK packet.
HashContext
A hash context.
HashContextBase
A hash context.
HttpFileTransfer
Helper methods for downloading binary files.
HttpRequestArgs
Arguments for sending an HTTP request.
HttpRequestCreatedArgs
Arguments passed into callbacks when an HTTP request is created.
HttpResponseArgs
Arguments for receiving an HTTP response.
HttpResponseReceivedArgs
Arguments passed into callbacks when an HTTP response is received.
HttpSendFinishArgs
Arguments for OnSendStart.
HttpSendStartArgs
Arguments for OnSendStart.
HttpTransfer
Base class that defines methods for transferring content over HTTP.
HttpTransferFactory
Creates implementations of HttpTransfer.
HttpWebRequestSender
An HTTP web request sender.
HttpWebRequestTransfer
Defines methods for transferring content over HTTP using the HttpWebRequest.
IAudioInputCollection
A collection of audio inputs.
IAudioOutputCollection
A collection of audio outputs.
IceParameters
A set of ICE parameters.
IcePortRange
An ICE port range.
IceServer
An ICE server.
IceServerCollection
An ICE server collection.
IceServerTest
An ICE server test.
IceServerTestResult
An ICE server test result.
IdentityAudioPipe
An audio pipe whose output matches its input.
IdentityVideoPipe
A video pipe whose output matches its input.
ImageScalePipe
An image scale pipe.
ImageSizePipe
An image size pipe.
IMediaInputCollection<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat, TMediaInputCollection>
A media input collection.
IMediaOutputCollection<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat, TMediaOutputCollection>
A media output collection.
Info
Information.
IntegerHolder
Class to hold an integer value passed by reference.
InternalNetworkInfo
Internal network information.
Invitation
An invitation to join a channel.
InviteFeedback
A class containing the feedback from invite requests.
IPNetwork
An IP network.
Iso8601Timestamp
Utility class to assist with ISO-8601 timestamp conversions.
IVideoInputCollection
A collection of video inputs.
IVideoOutputCollection
A collection of video outputs.
JitterAudioPipe
An audio pipe that wraps a jitter buffer.
JitterConfig
A Jitter config.
JitterConfig is for configuring the jitter buffer. The jitter buffer helps to eliminate the effects of varying network delay and delivery times by holding packets for a brief period of time before releasing them to the playout track. The jitter buffer holds on to the packets so that any out of order arriving packets can be released in the correct order. You can modify the buffer size, but it will increase latency, and should generally be left with default values. The option to set these values will most likely be removed in a future release as our adaptive algorithms improve.
JitterVideoPipe
A video pipe that wraps a jitter buffer.
Json
JSON utility class.
JsonConsoleLogProvider
A log provider that sends json logs to the console.
JsonLite
Contains methods for serializing/deserializing System.Json.JsonValue instances.
JsonProvider
Base class for all JSON provider implementations.
JsonSerializer
Provides methods for serializing/deserializing .NET value types to/from JSON as well as facilities for converting objects and arrays if appropriate callbacks are supplied to assist with the conversion.
Layout
A layout definition, including local and remote frame definitions.
LayoutConfig
Layout configuration.
LayoutFrame
A layout frame definition, including X/Y coordinates and width/height values.
LayoutManager<T>
A class that supplies simple video frame layout management.
LayoutPreset
A layout preset.
LayoutTable
Defines the results of a layout calculation.
LayoutUtility
Utility to assist with managing the layout of a combined video feed.
License
A license.
LinkedList<T>
A linked list.
LinkedListEnumerator<T>
A linked list enumerator.
LinkedListNode<T>
A linked list node.
LocalMedia
A collection of local audio/video tracks.
LocalMediaBase<TLocalMedia, TAudioTrack, TVideoTrack>
A collection of local audio/video track base methods.
LocalNetwork
Local network utility methods.
LockedRandomizer
Thread-safe class providing access to a single FM.LiveSwitch.LockedRandomizer.Randomizer.
Log
Log utility class.
LogEvent
Details about a specific log event.
LogEventInfo
Log event information.
LogEventLogProvider
Simple log provider that writes log events to a local array.
LogProvider
Base class for all logging provider implementations.
LogStashLogProvider
A log provider that sends logs to LogStash.
LongHolder
Class to hold a long value passed by reference.
LrrControlFrame
An RTCP layer refresh request (LRR) packet.
LrrEntry
An RTCP layer refresh request (FIR) packet entry.
MacContext
A message authentication code (MAC) context.
MacContextBase
A message authentication code (MAC) context.
ManagedAutoReleasePool
Managed auto-release pool.
ManagedAutoResetEvent
Managed AutoResetEvent.
ManagedConcurrentDictionary<TKey, TValue>
A ConcurrentDictonary that maps to the appropriate platform version.
ManagedConcurrentQueue<T>
A thread-safe queue.
ManagedConcurrentStack<TValue>
A ConcurrentStack that maps to the appropriate platform version.
ManagedCondition
A managed condition.
ManagedConnection
A managed connection.
ManagedConnectionCollection
A collection of connections.
ManagedCountdownLatch
A countdown latch that will signal when the counter reaches zero.
ManagedLock
A managed lock.
ManagedSocket
A socket.
ManagedStopwatch
Managed stopwatch.
ManagedThread
Managed thread.
ManagedTimer
A managed timer that will tick on intervals. Might catchup if callback takes too long.
MathAssistant
Contains methods for cross-platform math operations.
McuConnection
An MCU connection.
Md5Sha1HashContext
An MD5-SHA1 hash context.
Media<TAudioTrack, TVideoTrack>
A collection of audio/video tracks.
MediaBase<TIAudioTrack, TIVideoTrack>
A collection of audio/video track base methods/properties.
MediaBranch<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat>
A media branch.
MediaBuffer<TFormat, TBuffer>
A media buffer.
MediaBufferCollection<TBuffer, TBufferCollection, TFormat>
A media buffer collection.
MediaCollection
A collection of remote medias.
MediaComponentInfo
Media component information.
MediaComponentReport
Media component report.
MediaComponentStats
Media component stats.
MediaConfig<TConfig>
A media configuration.
MediaControlFrame
A media control frame.
MediaFormat<TFormat>
A media format.
MediaFormatCollection<TFormat, TFormatCollection>
A media format collection.
MediaFrame<TBuffer, TBufferCollection, TFormat, TFrame>
A media frame.
MediaInfo
Media information.
MediaPipe<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat>
A media pipe.
MediaReceiverInfo
Media receiver information.
MediaReceiverReport
Media receiver report.
MediaReceiverStats
Media receiver stats.
MediaRecorder<TBuffer, TFormat>
A recorder.
MediaSenderInfo
Media sender information.
MediaSenderReport
Media sender report.
MediaSenderStats
Media sender stats.
MediaSink<TIOutput, TIOutputCollection, TIInput, TSink, TFrame, TBuffer, TBufferCollection, TFormat>
A media sink.
MediaSinkBase
Media sink base properties/methods.
MediaSinkInfo
Media sink information.
MediaSinkStats
Media sink stats.
MediaSource<TIOutput, TIInput, TIInputCollection, TSource, TFrame, TBuffer, TBufferCollection, TFormat>
A media source.
MediaSourceBase
Media source base properties/methods.
MediaSourceInfo
Media source information.
MediaSourceStats
Media source stats.
MediaStats
Media stats.
MediaStream<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat, TFormatCollection>
A media stream.
MediaStreamBase
Media stream base properties/methods.
MediaStreamInfo
Media stream information.
MediaStreamStats
Media stream stats.
MediaTrack<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat>
A media track.
MediaTrackBase
Media track base properties/methods.
MediaTrackInfo
Media track information
MediaTrackReport
Media track report.
MediaTrackStats
Media track stats.
Message
A message.
MessageInfo
Message information.
MessageType
A message type.
MixerReport
Mixer report.
MovingAverage
A moving average.
MutablePair<T1, T2>
A mutable 2-tuple.
MutableUnit<T>
A mutable 1-tuple.
MutedConfig
Muted configuration.
NackConfig
A NACK Config.
NackConfig is for enabling/configuring negative acknowledgement. Negative acknowledgements are used by media receivers to request that a media sender retransmit a packet. It is highly effective for video in low-latency networks since video is stateful and the cost of losing a packet is high. It is far less effective for audio, where any delay is especially harmful and the cost of losing a packet is not significant. Because of this, it is enabled by default for video and disabled by default for audio. You can modify the buffer size using NackConfig, but generally, it should be left with default values. The option to set these values will most likely be removed in a future release as our adaptive algorithms improve.
Native
Base class for native interop.
NetworkInfo
Network information.
NetworkInterfaceInfo
Network interface information.
NetworkTimeProtocol
Utility class to assist with Network Time Protocol (NTP) conversions. NTP timestamps are 64-bit values that can span just over 136 years, from 1900-01-01 to 2036-02-08. Compact NTP timestamps are 32-bit values that can span span just over 18 hours. These utility methods guarantee precision to the millisecond.
NoMediaServersAvailableEventArgs
Event arguments for OnNoMediaServersAvailable.
NoWebSocketMediaServersAvailableEventArgs
Event arguments for OnNoWebSocketMediaServersAvailable.
NullAudioSink
An audio sink that discards frames.
NullAudioSource
An audio source that raises nothing.
NullJsonProvider
An implementation of a JSON provider that does nothing.
NullLogProvider
An implementation of a logging provider that does nothing.
NullVideoSink
A video sink that discards frames.
NullVideoSource
A video source that raises nothing.
NullViewSink<T>
A video view sink that does nothing.
PacketizedAudioBuffer
A AudioBuffer containing an RtpHeader.
PacketizedVideoBuffer
A VideoBuffer containing an RtpHeader.
Pair<T1, T2>
A 2-tuple.
ParseAssistant
Contains methods for cross-platform primitive parsing from strings.
PathUtility
Collection of utility methods for working with the file system.
PayloadSpecificControlFrame
An RTCP Feedback PS packet.
PeerConnection
A peer connection.
PeerConnectionOffer
A peer connection offer.
Platform
Platform-specific methods.
PliControlFrame
An RTCP Feedback PS-PLI packet.
Point
A point (x and y coordinates).
Pool<T>
A pool of objects.
PoolStatistics
Pool statistics.
PriorityQueue<T>
A priority queue.
Promise<T>
A promise.
PromiseBase<T>
Promise base properties/methods.
Proxy
Proxy utility methods.
ProxyAuthCheckResult
Proxy authentication check result.
ProxyCredentials
Proxy credentials.
ProxyCredentialsCache
Proxy credentials cache.
Randomizer
Utility class for random values.
RecordingMode
The recording mode helper.
Rectangle
A rectangle (size and origin).
RedFecConfig
RED Forward error correction (FEC) config. RedFecConfig is for enabling/configuring forward error correction. Forward error correction adds redundancy to the media stream (increased bandwidth) with the intention that media receivers can recover from packet loss without requiring the media server to retransmit anything. It is a last resort for high latency networks. It is disabled by default and not currently supported as it does not have sufficient test coverage.
RembControlFrame
An RTCP receiver estimated maximum bitrate (REMB) packet.
RemoteMedia
A collection of remote audio/video tracks.
RemoteMediaCollection
A collection of remote medias.
RemoteReceiverStats
Remote receiver stats.
Report
Report.
ReportBlock
An RTCP report block.
ReportControlFrame
An RTCP Sender or Receiver Report control frame.
Resampler
Utility class for resampling audio data.
ResetAudioPipe
An audio pipe that clones each input frame and includes only the last buffer in its output.
ResetVideoPipe
A video pipe that clones each input frame and includes only the last buffer in its output.
Rpsi
An RTCP reference picture selection indication.
RpsiControlFrame
An RTCP Feedback PS-RPSI Control Frame.
RRControlFrame
A receiver report control frame.
RsaCrypto
RSA-based cryptographic functions.
RsaKey
An RSA key.
RtcAudioTrackConfig
A WebRTC/ORTC-compatible audio track configuration.
RtcLocalMedia<TView>
A WebRTC/ORTC-compatible collection of local audio/video tracks.
RtcpDataChannelSignallingActivation
An RTCP Data Channel Signalling Activation.
RtcRemoteMedia<TView>
A WebRTC/ORTC-compatible collection of remote audio/video tracks.
RtcVideoTrackConfig
A WebRTC/ORTC-compatible video track configuration.
RtmpLayoutZones
The LayoutZones defined in the RTMP custom MCU layout
RtpControlFrame
An RTCP Feedback RTP control frame.
RtpPacket
An RTP packet.
RtpPacketHeader
An RTP packet header.
ScreenConfig
A screen configuration.
ScreenSourceBase
A base class for screen-based sources.
SdesChunk
An RTCP source description chunk.
SdesControlFrame
An RTCP SDES packet.
SdesItem
An RTCP source description item.
SdesItemType
An SDES Item Type.
Serializable
Base definition for classes that allow serialization to/from JSON.
Serializer
Provides methods for serializing/deserializing .NET value types to/from JSON as well as facilities for converting objects and arrays if appropriate callbacks are supplied to assist with the conversion.
ServerAddress
An IP address and port, along with optional public IP addresses for listening behind a 1:1 NAT.
ServerConnection
A server connection.
SessionDescription
A session description.
SfuConnection
An SFU connection.
SfuDownstreamConnection
An SFU receiving connection.
SfuUpstreamConnection
An SFU sending connection.
ShortHolder
Class to hold a short value passed by reference.
SinkOutput
A sink output (e.g. device, track, screen).
Size
A size (width and height).
Sli
An RTCP slice loss indication.
SliControlFrame
An RTCP Feedback PS-SLI packet.
Sort
Encapsulates useful sorting utilities.
SoundConverter
A pipe that converts sound.
SoundReframer
A pipe that reframes sound chunks into different durations.
SoundReframerContext
A sound reframer context that can reframe sound chunks into consistent durations.
SoundUtility
Sound utility methods.
SourceInput
A source input (e.g. device, track, screen).
Splitter
Utility class for splitting strings.
SRControlFrame
A sender report control frame.
StateMachine<T>
A simple state machine.
Stream
A peer-to-peer stream.
StreamBase
Stream base properties/methods.
StreamCollection
A stream collection.
StreamDescription
A stream description.
StreamDirectionHelper
Class containing utility methods to manipulate StreamDirection.
StreamInfo
Stream information.
StreamSocket
A stream socket.
StreamSocketCreateArgs
Arguments for a stream socket create event.
StreamStateMachine
A state machine for stream states.
StreamStats
Stream stats.
StringAssistant
Contains methods for string manipulation.
StunServer
A STUN server.
SynchronizeContext
A stream synchronization context.
SyslogLogProvider
A log provider that sends messages to a syslog server.
SystemClock
A system clock.
TcpSocket
A TCP socket.
TextLogProvider
Simple log provider that writes to a local string builder.
ThreadDispatchQueue<T>
A single-thread dispatch queue.
TimeoutTimer
A thread-safe class for running timeouts on asynchronous methods.
TlsCertificate
A certificate to be used for TLS communication.
TlsFingerprint
A TLS fingerprint.
TmmbnControlFrame
An RTCP temporary maximum media-stream bitrate notification (TMMBN) packet.
TmmbnEntry
An RTCP temporary maximum media-stream bitrate notification (TMMBN) packet entry.
TmmbrControlFrame
An RTCP temporary maximum media-stream bitrate request (TMMBR) packet.
TmmbrEntry
An RTCP temporary maximum media-stream bitrate request (TMMBR) packet entry.
Token
A token.
TokenType
A token type.
TraceLogProvider
Log provider that uses System.Diagnostics.Trace.
Transport
A transport.
TransportAddress
An IP address and port.
TransportCCControlFrame
An RTCP transport-wide congestion control (transport-cc) packet.
TransportCCPacketStatusChunk
An RTCP transport-wide congestion control (transport-cc) packet status chunk.
TransportCCRunLengthChunk
An RTCP transport-wide congestion control (transport-cc) run length chunk.
TransportCCStatusVectorChunk
An RTCP transport-wide congestion control (transport-cc) status vector chunk.
TransportInfo
Transport Information.
TransportReport
Transport report.
TransportStats
Transport stats.
Triple<T1, T2, T3>
A 3-tuple.
TurnAuthArgs
Arguments for the TurnServer's authentication callback.
TurnAuthResult
The result of attempting to authenticate a TURN request.
TurnServer
An TURN/STUN server.
UdpSocket
A UDP socket.
Unhandled
Throws exceptions on a separate thread.
UnhandledExceptionArgs
Arguments for an unhandled exception.
Unit<T>
A 1-tuple.
UnixTimestamp
Utility class to assist with Unix timestamp conversions.
Utf8
UTF-8 encoding/decoding utility.
Utility
Utility methods.
VideoBranch
A video branch.
VideoBuffer
A video buffer.
VideoBufferCollection
A video buffer collection.
VideoConfig
A video configuration.
VideoContent
Video content values.
VideoDecoder
A video decoder.
VideoDepacketizer<TFragment>
A video depacketizer.
VideoEncoder
A video encoder.
VideoEncodingConfig
Video encoding configuration.
VideoFormat
A video format.
VideoFormatCollection
A collection of video formats.
VideoFragment
A fragment of a video frame.
VideoFrame
A video frame.
VideoLayout
A description of the layout within a mixed video view.
VideoLayoutRegion
A video layout region.
VideoPacketizer
A video packetizer.
VideoPipe
A video pipe.
VideoRecorder
An video recorder.
VideoSink
A video sink.
VideoSource
A video source.
VideoStream
A video stream.
VideoSynchronizer
An video pipe for synchronizing playout with other streams.
VideoTrack
A video track.
ViewSink<T>
A video view sink.
WebhookInfo
Webhook information.
WebSocket
Implementation of the WebSocket protocol v8.
WebSocketBase
WebSocket base properties/methods.
WebSocketCloseArgs
Close arguments for the WebSocket class.
WebSocketCloseCompleteArgs
Arguments for OnComplete.
WebSocketMockRequest
A mock response object for the WebSocket protocol.
WebSocketMockResponse
A mock response object for the WebSocket protocol.
WebSocketOpenArgs
Open arguments for the WebSocket class.
WebSocketOpenFailureArgs
Arguments for OnFailure.
WebSocketOpenSuccessArgs
Arguments for OnSuccess.
WebSocketReceiveArgs
Arguments for OnReceive.
WebSocketSendArgs
Send arguments for the WebSocket class.
WebSocketStreamFailureArgs
Arguments for OnStreamFailure.
WebSocketTransfer
Base class that defines methods for transferring content over the WebSocket protocol.
WebSocketTransferFactory
Creates implementations of WebSocketWebRequestTransfer.
WebSocketWebRequestTransfer
Defines methods for transferring messages using the WebSocket protocol.
Interfaces
IAudioElement
An audio element.
IAudioInput
An audio input.
IAudioOutput
An audio output.
IAudioStream
Audio stream interface.
IAudioTrack
Audio track interface.
IConnection<TConnection, TStream, TAudioStream, TVideoStream, TDataStream>
Connection interface.
IDataBufferPool
A data buffer pool interface.
IDataChannel<TDataChannel>
Data channel interface.
IDataStream<TDataChannel>
Data stream interface.
IDispatchQueue<T>
A dispatch queue interface.
IElement
An element.
IEquivalent<T>
An interface for detecting equivalency.
IFileStream
A file stream.
IInput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>
An input.
ILocalMedia<TLocalMedia, TIAudioTrack, TIVideoTrack>
Local media interface.
ILog
ILog interface for loggers.
IMedia<TIAudioTrack, TIVideoTrack>
Media interface.
IMediaElement
A media element.
IMediaInput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>
A media input.
IMediaOutput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>
A media output.
IMediaStream
Media stream interface.
IMediaTrack
Media track interface.
IOutput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>
An output.
IPlatform
Platform-specific methods.
IPromise
Interface for a promise that can be rejected.
IRemoteMedia<TIAudioTrack, TIVideoTrack>
Remote media interface.
IRtpHeaderExtension
The interface that all rtp header extensions must implement.
IStream
Stream interface.
ISynchronizableStream
A synchronizable stream.
ISynchronizer
A media rendering synchronizer.
ISystemClock
A system clock interface.
ITimeoutTimer
A thread-safe class for running timeouts on asynchronous methods.
IVideoElement
A video element.
IVideoInput
A video input.
IVideoOutput
A video output.
IVideoStream
Video stream interface.
IVideoTrack
Video track interface.
IViewableMedia<TView>
Viewable media interface.
IViewSink<TView>
View sink interface.
IViewSinkableMedia<TView, TViewSink>
Viewable media interface with a view sink.
IWebSocket
Contract for an implementation of the WebSocket protocol v8.
Enums
AddressType
Address types.
Architecture
A CPU architecture.
AsymmetricKeyType
Asymmetric key types.
BandwidthAdaptationPolicy
RTP packet header Extension support policies.
BundlePolicy
The local bundle negotiation policy. Denotes the policy this peer uses when negotiating resulting connection bundling policy.
CandidatePairState
The state of a candidate pair.
CandidateType
The type of a candidate.
CcmFirPolicy
The CCM FIR policy.
CcmLrrPolicy
The CCM LRR policy.
CcmTmmbnPolicy
The CCM TMMBN policy.
CcmTmmbrPolicy
The CCM TMMBR policy.
ClientState
The state of a client.
CodecType
A value used to indicate whether this codec is used to encode or decode.
CompareResult
The compare result in a sort operation.
ConnectionState
The state of a connection.
CryptoLibrary
A crypto library.
DataChannelState
A data channel state.
DtlsCipherSuite
A cipher suite.
DtlsProtocolVersion
DTLS protocol versions.
DtlsRole
A DTLS role.
EcdsaNamedCurve
A named elliptic curve.
EncryptionMode
The encryption mode for the stream.
EncryptionPolicy
Indicates encryption policy for a connection.
ErrorCode
Error codes are six digit values, where the first three digits indicate component, while the remaining three digits particular problem with the component.
FecMaskType
Forward error correction mask types.
FileStreamAccess
A file stream access type.
FutureState
The state of a future.
HashType
A hash algorithm.
HttpMethod
The method used by an HTTP request.
IceConnectionState
The state of an ICE gatherer.
IceGatheringState
The state of an ICE gatherer.
IceGatherPolicy
The local policy for gathering candidates.
IcePolicy
Policy indicating whether ICE connectivity checks are required (and enabled) or disabled (and not required for a Connection)
IceRole
An ICE role.
InvitationState
The invite feedback states.
LayoutAlignment
A layout alignment definition.
LayoutDirection
Specifies the direction of the layout flow.
LayoutMode
Specifies the layout mode that should be used.
LayoutOrigin
A layout origin definition.
LayoutScale
Specifies how an element should be scaled within a layout.
LocalMediaState
The state of local media.
LogLevel
The level at which to log.
MacType
A message authentication code (MAC) algorithm.
MediaPipeState
The state of a media pipe.
MediaProtocol
The protocol used to carry media on a connection.
MediaSinkState
The state of a media sink.
MediaSourceState
The state of a media source.
MultiplexPolicy
The local policy for RTP/RTCP multiplex negotation.
NackPliPolicy
The NACK PLI policy.
NackPolicy
The local policy for the use of generic RTP Negative Acknowledgements (NACK). Cf. https://tools.ietf.org/html/draft-ietf-rtcweb-rtp-usage-26
NackPolicy is for enabling/configuring negative acknowledgement. Negative acknowledgements are used by media receivers to request that a media sender retransmit a packet. It is highly effective for video in low-latency networks since video is stateful and the cost of losing a packet is high. It is far less effective for audio, where any delay is especially harmful and the cost of losing a packet is not significant. Because of this, it is enabled by default for video and disabled by default for audio. You can modify the buffer size using NackConfig, but generally, it should be left with default values. The option to set these values will most likely be removed in a future release as our adaptive algorithms improve.
NetworkConnectionState
The internet connection state of a client.
NetworkType
A network type.
OperatingSystem
An operating system.
PeerRole
A peer role.
ProcessFramePolicy
The policy on how a media input should process the frame.
ProcessFramePolicy affects how media packets move from one processing element to the next in a media track. The default behaviour is synchronous, which is recommended for almost all applications. There are a few niche use cases (generally server-side) where a media track includes a branch with hundreds or thousands of leaves, in which case processing asynchronously (with accompanying thread-pool tuning) can eliminate the effects of favoritism in processing time towards the first leaves.
ProtocolType
A protocol type.
RedFecPolicy
The local policy for the RED Forward Error Correction support. Cf. https://tools.ietf.org/html/draft-ietf-rtcweb-fec-04
RedFecPolicy is for enabling/configuring forward error correction. Forward error correction adds redundancy to the media stream (increased bandwidth) with the intention that media receivers can recover from packet loss without requiring the media server to retransmit anything. It is a last resort for high latency networks. It is disabled by default and not currently supported as it does not have sufficient test coverage.
RembPolicy
The local policy for the use of Receiver Estimated Maximum Bitrates (goog-remb). Cf. https://tools.ietf.org/html/draft-alvestrand-rmcat-remb-03
SdesPolicy
Indicates Sdes policy for stream.
SessionDescriptionType
A session description type.
SignallingState
The signalling state of a connection.
SimulcastMode
The simulcast mode.
SourceLanguage
A source language.
StreamDirection
A stream direction.
StreamState
The state of a stream.
StreamType
A stream type.
TransportCCPacketStatusSymbol
An RTCP transport-wide congestion control (transport-cc) packet status symbol.
TrickleIcePolicy
The local policy for TrickleIce support. Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-04
TurnAuthOperation
An authenticated TURN operation.
VideoDegradationPreference
A video degradation preference.
VideoType
A video type.
WebSocketStatusCode
An enumeration of potential WebSocket status codes.
Delegates
Action0
Generic method signature for callbacks with no parameters.
Action1<T>
Generic method signature for callbacks with one parameter.
Action10<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>
Generic method signature for callbacks with ten parameters.
Action2<T1, T2>
Generic method signature for callbacks with two parameters.
Action3<T1, T2, T3>
Generic method signature for callbacks with three parameters.
Action4<T1, T2, T3, T4>
Generic method signature for callbacks with four parameters.
Action5<T1, T2, T3, T4, T5>
Generic method signature for callbacks with five parameters.
Action6<T1, T2, T3, T4, T5, T6>
Generic method signature for callbacks with six parameters.
Action7<T1, T2, T3, T4, T5, T6, T7>
Generic method signature for callbacks with seven parameters.
Action8<T1, T2, T3, T4, T5, T6, T7, T8>
Generic method signature for callbacks with eight parameters.
Action9<T1, T2, T3, T4, T5, T6, T7, T8, T9>
Generic method signature for callbacks with nine parameters.
Function0<R>
Generic method signature for callbacks with no parameters and a return value.
Function1<T, R>
Generic method signature for callbacks with one parameter and a return value.
Function10<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, R>
Generic method signature for callbacks with ten parameters and a return value.
Function2<T1, T2, R>
Generic method signature for callbacks with two parameters and a return value.
Function3<T1, T2, T3, R>
Generic method signature for callbacks with three parameters and a return value.
Function4<T1, T2, T3, T4, R>
Generic method signature for callbacks with four parameters and a return value.
Function5<T1, T2, T3, T4, T5, R>
Generic method signature for callbacks with five parameters and a return value.
Function6<T1, T2, T3, T4, T5, T6, R>
Generic method signature for callbacks with six parameters and a return value.
Function7<T1, T2, T3, T4, T5, T6, T7, R>
Generic method signature for callbacks with seven parameters and a return value.
Function8<T1, T2, T3, T4, T5, T6, T7, T8, R>
Generic method signature for callbacks with eight parameters and a return value.
Function9<T1, T2, T3, T4, T5, T6, T7, T8, T9, R>
Generic method signature for callbacks with nine parameters and a return value.
Native.AllocCallbackDelegate
An alloc callback delegate.
Native.DebugLogCallbackDelegate
A debug log callback delegate.
Native.DebugLogWithScopeCallbackDelegate
A debug log with scope callback delegate.
Native.ErrorLogCallbackDelegate
An error log callback delegate.
Native.ErrorLogWithScopeCallbackDelegate
An error log with scope callback delegate.
Native.InfoLogCallbackDelegate
An info log callback delegate.
Native.InfoLogWithScopeCallbackDelegate
An info log with scope callback delegate.
Native.ReleaseCallbackDelegate
A release callback delegate.
Native.WarnLogCallbackDelegate
A warn log callback delegate.
Native.WarnLogWithScopeCallbackDelegate
A warn log with scope callback delegate.
TcpSocket.ClientSslAuthenticateDelegate
Authenticates an SSL stream as a client.
TcpSocket.ClientSslValidateServerCertificateDelegate
Validates an SSL server certificate as a client.
TcpSocket.ServerSslAuthenticateDelegate
Authenticates an SSL stream as a server.