Class RtcpHeader

Class for creating and parsing Real Time Control Protocol (RTCP) headers.

Inheritance

object

RtcpHeader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SipLib.Rtp

Assembly: SipLib.dll

Syntax

public class RtcpHeader

Constructors

RtcpHeader()

Creates a new RtcpHeader for building RTCP packets.

Declaration

public RtcpHeader()

RtcpHeader(byte[], int)

Constructs a new RtcpHeader object from a byte array. Use this constructor when parsing a received RTCP packet.

Declaration

public RtcpHeader(byte[] Bytes, int StartIdx)

Parameters

Type	Name	Description
byte[]	Bytes	Byte array containing the RTCP header. Note: There must be at least 4 bytes between the StartIdx and the end of this byte array.
int	StartIdx	Index of the start of the RTCP header.

Fields

RTCP_HEADER_LENGTH

Length of a RTCP header

Declaration

public const int RTCP_HEADER_LENGTH = 4

Field Value

Type	Description
int

Properties

Count

Gets or sets the Count field.

Declaration

public int Count { get; set; }

Property Value

Type	Description
int

HeaderLength

Gets the fixed header length or an RTCP packet header.

Declaration

public static int HeaderLength { get; }

Property Value

Type	Description
int

Length

Gets or sets the Length field.

Declaration

public ushort Length { get; set; }

Property Value

Type	Description
ushort

PacketType

Gets or sets the PT (Packet Type) field.

Declaration

public RtcpPacketType PacketType { get; set; }

Property Value

Type	Description
RtcpPacketType

Padding

Gets or sets the Padding bit.

Declaration

public bool Padding { get; set; }

Property Value

Type	Description
bool

PaddingBit

Sets or gets the Padding bit value as an int

Declaration

public int PaddingBit { get; set; }

Property Value

Type	Description
int

Version

Gets the Version field.

Declaration

public int Version { get; }

Property Value

Type	Description
int

Methods

LoadBytes(byte[], int)

Loads the byte array containing the RTCP header block into a destination byte array.

Declaration

public void LoadBytes(byte[] Dest, int StartIdx)

Parameters

Type	Name	Description
byte[]	Dest	Destination array for the RTCP header bytes. This byte array must be long enough to hold this object beginning at the StartIdx position.
int	StartIdx	Starting index to load the header bytes at.