Class RtspBackChannelSink

Namespace

VAST.RTSP

Assembly

VAST.RTSP.dll

Represents an RTSP back channel sink that pushes audio data to a remote peer via RTSP.

public class RtspBackChannelSink : INetworkSink, IMediaSink, IDisposable, INetworkEndPoint, INetworkStat

Inheritance

object

RtspBackChannelSink

Implements

INetworkSink

IMediaSink

IDisposable

INetworkEndPoint

INetworkStat

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RtspBackChannelSink()

Initializes a new instance of the RtspBackChannelSink class.

public RtspBackChannelSink()

Properties

Accept

Whether sink is accepted or not

public bool Accept { get; set; }

Property Value

bool

Capabilities

Gets the list of sink capabilities

public List<SinkCapability> Capabilities { get; }

Property Value

List<SinkCapability>

CurrentStat

Gets current network statistics

public NetworkStat CurrentStat { get; }

Property Value

NetworkStat

EndPoint

Connected end point info

public IPProtoEndPoint EndPoint { get; }

Property Value

IPProtoEndPoint

IsNetworkSink

whether it's a network or local sink. Necessary to apply longer timeouts in media session processing logic.

public bool IsNetworkSink { get; }

Property Value

bool

Parameters

Gets or sets sink parameters

public SinkParameters Parameters { get; set; }

Property Value

SinkParameters

PublishingPath

Publishing point name extracted from the sink URI or by any other means (depends on the protocol)

public string PublishingPath { get; set; }

Property Value

string

ReceivedUri

End point URI used when connected (depends on the protocol)

public string ReceivedUri { get; set; }

Property Value

string

SocketError

Socket error got on disconnection

public ExtendedSocketError SocketError { get; }

Property Value

ExtendedSocketError

State

Current source state

public MediaState State { get; }

Property Value

MediaState

UniqueId

Unique stream id

public Guid UniqueId { get; set; }

Property Value

Guid

Uri

URI to be opened. Exact URI syntax depends on the implementation.

public string Uri { get; set; }

Property Value

string

Methods

AddStream(int, MediaType)

Add media stream for pushing

public void AddStream(int streamIndex, MediaType mediaType)

Parameters

streamIndex int

Stream index

mediaType MediaType

Stream media type

Dispose()

Releases all resources used by the RtspBackChannelSink class.

public void Dispose()

Open()

Open sink using specified URI

public void Open()

PushMedia(int, VersatileBuffer)

Push media sample

public void PushMedia(int streamIndex, VersatileBuffer sample)

Parameters

streamIndex int

Stream index

sample VersatileBuffer

Media sample

Start(bool)

Start media pushing

public void Start(bool delayedStart = false)

Parameters

delayedStart bool

Whether media samples are expected immediately or after significant time interval. Not used in current sink

Stop()

Stop media pushing

public void Stop()

Events

Error

Occurs when an error is encountered during streaming.

public event EventHandler<ErrorEventArgs> Error

Event Type

EventHandler<ErrorEventArgs>

StateChanged

Occurs when the sink state changes.

public event EventHandler<MediaState> StateChanged

Event Type

EventHandler<MediaState>