Class ByeControlFrame

An RTCP BYE packet.

Inheritance
System.Object
Serializable
Dynamic
MediaControlFrame
ByeControlFrame
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class ByeControlFrame : MediaControlFrame

Constructors

ByeControlFrame()

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame()

ByeControlFrame(DataBuffer)

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame(DataBuffer buffer)
Parameters
Type Name Description
DataBuffer buffer

The packet.

ByeControlFrame(Int64)

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame(long synchronizationSource)
Parameters
Type Name Description
System.Int64 synchronizationSource

The synchronization source.

ByeControlFrame(Int64, String)

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame(long synchronizationSource, string reasonForLeaving)
Parameters
Type Name Description
System.Int64 synchronizationSource

The synchronization source.
System.String reasonForLeaving

The reason for leaving.

ByeControlFrame(Int64[])

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame(long[] synchronizationSources)
Parameters
Type Name Description
System.Int64[] synchronizationSources

The synchronization sources.

ByeControlFrame(Int64[], Int64[])

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame(long[] synchronizationSources, long[] contributingSources)
Parameters
Type Name Description
System.Int64[] synchronizationSources

The synchronization sources.
System.Int64[] contributingSources

The contributing sources.

ByeControlFrame(Int64[], Int64[], String)

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame(long[] synchronizationSources, long[] contributingSources, string reasonForLeaving)
Parameters
Type Name Description
System.Int64[] synchronizationSources

The synchronization sources.
System.Int64[] contributingSources

The contributing sources.
System.String reasonForLeaving

The reason for leaving.

ByeControlFrame(Int64[], String)

Initializes a new instance of the ByeControlFrame class.

Declaration
public ByeControlFrame(long[] synchronizationSources, string reasonForLeaving)
Parameters
Type Name Description
System.Int64[] synchronizationSources

The synchronization sources.
System.String reasonForLeaving

The reason for leaving.

Properties

FixedPayloadHeaderLength

Gets the length of the fixed payload header.

Declaration
public static int FixedPayloadHeaderLength { get; }
Property Value
Type Description
System.Int32

FixedReasonForLeavingPayloadHeaderLength

Gets the length of the fixed reason for leaving header.

Declaration
public static int FixedReasonForLeavingPayloadHeaderLength { get; }
Property Value
Type Description
System.Int32

Reason

Gets a value indicating whether this instance has a reason for leaving.

Declaration
public bool Reason { get; }
Property Value
Type Description
System.Boolean

ReasonForLeaving

Gets the reason for leaving as a string.

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

ReasonForLeavingLength

Gets the length of the reason for leaving.

Declaration
public int ReasonForLeavingLength { get; }
Property Value
Type Description
System.Int32

ReasonForLeavingOffset

Gets the offset of the ReasonForLeaving in the payload.

Declaration
public int ReasonForLeavingOffset { get; }
Property Value
Type Description
System.Int32

ReasonForLeavingPayload

Gets or sets the reason for leaving.

Declaration
public DataBuffer ReasonForLeavingPayload { get; }
Property Value
Type Description
DataBuffer

RegisteredPayloadType

Gets the goodbye payload type.

Declaration
public static int RegisteredPayloadType { get; }
Property Value
Type Description
System.Int32

SourceCount

Gets the number of Sources.

Declaration
public int SourceCount { get; }
Property Value
Type Description
System.Int32

Sources

Gets or sets the synchronization and contributing sources.

Declaration
public long[] Sources { get; set; }
Property Value
Type Description
System.Int64[]

SourcesLength

Gets the length of the Sources in bytes.

Declaration
public int SourcesLength { get; }
Property Value
Type Description
System.Int32

SourcesPayloadOffset

Gets the offset of the Sources array in the payload.

Declaration
public int SourcesPayloadOffset { get; }
Property Value
Type Description
System.Int32