Class ByePacket

Class for building and parsing RTCP BYE packets. See Section 6.6 of RFC 3550.

Inheritance

object

ByePacket

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 ByePacket

Constructors

ByePacket()

Constructor

Declaration

public ByePacket()

ByePacket(List<uint>, string)

Constructs a new BYE packet for sending.

Declaration

public ByePacket(List<uint> Ssrcs, string Reason)

Parameters

Type	Name	Description
List<uint>	Ssrcs	Contains a list of SSRC identifies that the BYE packet pertains to. The list must contain at least one SSRC.
string	Reason	A string that describes the reason for leaving.

Properties

Header

Gets the RtcpHeader for this packet.

Declaration

public RtcpHeader? Header { get; }

Property Value

Type	Description
RtcpHeader

Reason

Gets the reason for the BYE packet. Returns null if this packet is not valid.

Declaration

public string? Reason { get; }

Property Value

Type	Description
string

SSRCs

Gets the list of SSRCs. Always returns a non-null value. If the list is empty then this packet is not valid.

Declaration

public List<uint> SSRCs { get; }

Property Value

Type	Description
List<uint>

Methods

Parse(byte[], int)

Parses a received byte array into a ByePacket object

Declaration

public static ByePacket? Parse(byte[] Bytes, int StartIdx)

Parameters

Type	Name	Description
byte[]	Bytes	Received input byte array
int	StartIdx	Start index of the ByePacket in the array

Returns

Type	Description
ByePacket	Returns a new ByePacket or null if a parsing error occurred

ToByteArray()

Converts this object to a byte array.

Declaration

public byte[] ToByteArray()

Returns

Type	Description
byte[]	Returns a byte array containing the binary version of this object. The returned byte array is padded so that it contains a whole number of 4-byte words.