gstrtp.rtcppacket

Module for [RTCPPacket] class

class RTCPPacket

Types 1

classRTCPPacket

Data structure that points to a packet at @offset in @buffer. The size of the structure is made public to allow stack allocations.

Fields
GstRTCPPacket _cInstance
Methods
void * _cPtr() nothrow
gstrtp.rtcpbuffer.RTCPBuffer rtcp() @property nothrowGet `rtcp` field. Returns: pointer to RTCP buffer
uint offset() @property nothrowGet `offset` field. Returns: offset of packet in buffer data
void offset(uint propval) @property nothrowSet `offset` field. Params: propval = offset of packet in buffer data
bool addProfileSpecificExt(ubyte[] data) nothrowAdd profile-specific extension data to packet. If packet already contains profile-specific extension data will be appended to the existing extension.
bool addRb(uint ssrc, ubyte fractionlost, int packetslost, uint exthighestseq, uint jitter, uint lsr, uint dlsr) nothrowAdd a new report block to packet with the given values.
ubyte * appGetData() nothrowGet the application-dependent data attached to a RTPFB or PSFB packet. Returns: A pointer to the data
ushort appGetDataLength() nothrowGet the length of the application-dependent data attached to an APP packet. Returns: The length of data in 32-bit words.
string appGetName() nothrowGet the name field of the APP packet. Returns: The 4-byte name field, not zero-terminated.
uint appGetSsrc() nothrowGet the SSRC/CSRC field of the APP packet. Returns: The SSRC/CSRC.
ubyte appGetSubtype() nothrowGet the subtype field of the APP packet. Returns: The subtype.
bool appSetDataLength(ushort wordlen) nothrowSet the length of the application-dependent data attached to an APP packet.
void appSetName(string name) nothrowSet the name field of the APP packet.
void appSetSsrc(uint ssrc) nothrowSet the SSRC/CSRC field of the APP packet.
void appSetSubtype(ubyte subtype) nothrowSet the subtype field of the APP packet.
bool byeAddSsrc(uint ssrc) nothrowAdd ssrc to the BYE packet.
bool byeAddSsrcs(uint[] ssrc) nothrowAdds len SSRCs in ssrc to BYE packet.
uint byeGetNthSsrc(uint nth) nothrowGet the nth SSRC of the BYE packet.
string byeGetReason() nothrowGet the reason in packet. Returns: The reason for the BYE packet or NULL if the packet did not contain a reason string. The string must be freed with [glib.global.gfree] after usage.
ubyte byeGetReasonLen() nothrowGet the length of the reason string. Returns: The length of the reason string or 0 when there is no reason string present.
uint byeGetSsrcCount() nothrowGet the number of SSRC fields in packet. Returns: The number of SSRC fields in packet.
bool byeSetReason(string reason) nothrowSet the reason string to reason in packet.
bool copyProfileSpecificExt(out ubyte[] data) nothrowThe profile-specific extension data is copied into a new allocated memory area data. This must be freed with [glib.global.gfree] after usage.
ubyte * fbGetFci() nothrowGet the Feedback Control Information attached to a RTPFB or PSFB packet. Returns: a pointer to the FCI
ushort fbGetFciLength() nothrowGet the length of the Feedback Control Information attached to a RTPFB or PSFB packet. Returns: The length of the FCI in 32-bit words.
uint fbGetMediaSsrc() nothrowGet the media SSRC field of the RTPFB or PSFB packet. Returns: the media SSRC.
uint fbGetSenderSsrc() nothrowGet the sender SSRC field of the RTPFB or PSFB packet. Returns: the sender SSRC.
gstrtp.types.RTCPFBType fbGetType() nothrowGet the feedback message type of the FB packet. Returns: The feedback message type.
bool fbSetFciLength(ushort wordlen) nothrowSet the length of the Feedback Control Information attached to a RTPFB or PSFB packet.
void fbSetMediaSsrc(uint ssrc) nothrowSet the media SSRC field of the RTPFB or PSFB packet.
void fbSetSenderSsrc(uint ssrc) nothrowSet the sender SSRC field of the RTPFB or PSFB packet.
void fbSetType(gstrtp.types.RTCPFBType type) nothrowSet the feedback message type of the FB packet.
ubyte getCount() nothrowGet the count field in packet. Returns: The count field in packet or -1 if packet does not point to a valid packet.
ushort getLength() nothrowGet the length field of packet. This is the length of the packet in 32-bit words minus one. Returns: The length field of packet.
bool getPadding() nothrowGet the packet padding of the packet pointed to by packet. Returns: If the packet has the padding bit set.
bool getProfileSpecificExt(out ubyte[] data) nothrow
ushort getProfileSpecificExtLength() nothrow
void getRb(uint nth, out uint ssrc, out ubyte fractionlost, out int packetslost, out uint exthighestseq, out uint jitter, out uint lsr, out uint dlsr) nothrowParse the values of the nth report block in packet and store the result in the values.
uint getRbCount() nothrowGet the number of report blocks in packet. Returns: The number of report blocks in packet.
gstrtp.types.RTCPType getType() nothrowGet the packet type of the packet pointed to by packet. Returns: The packet type or GST_RTCP_TYPE_INVALID when packet is not pointing to a valid packet.
bool moveToNext() nothrowMove the packet pointer packet to the next packet in the payload. Use [gstrtp.rtcpbuffer.RTCPBuffer.getFirstPacket] to initialize packet. Returns: TRUE if packet is pointing to a valid packet after...
bool remove() nothrowRemoves the packet pointed to by packet and moves pointer to the next one Returns: TRUE if packet is pointing to a valid packet after calling this function.
uint rrGetSsrc() nothrowGet the ssrc field of the RR packet. Returns: the ssrc.
void rrSetSsrc(uint ssrc) nothrowSet the ssrc field of the RR packet.
bool sdesAddEntry(gstrtp.types.RTCPSDESType type, ubyte[] data) nothrowAdd a new SDES entry to the current item in packet.
bool sdesAddItem(uint ssrc) nothrowAdd a new SDES item for ssrc to packet.
bool sdesCopyEntry(out gstrtp.types.RTCPSDESType type, out ubyte[] data) nothrowThis function is like [gstrtp.rtcppacket.RTCPPacket.sdesGetEntry] but it returns a null-terminated copy of the data instead. use [glib.global.gfree] after usage.
bool sdesFirstEntry() nothrowMove to the first SDES entry in the current item. Returns: true if there was a first entry.
bool sdesFirstItem() nothrowMove to the first SDES item in packet. Returns: TRUE if there was a first item.
bool sdesGetEntry(out gstrtp.types.RTCPSDESType type, out ubyte[] data) nothrowGet the data of the current SDES item entry. type (when not NULL) will contain the type of the entry. data (when not NULL) will point to len bytes.
uint sdesGetItemCount() nothrowGet the number of items in the SDES packet packet. Returns: The number of items in packet.
uint sdesGetSsrc() nothrowGet the SSRC of the current SDES item. Returns: the SSRC of the current item.
bool sdesNextEntry() nothrowMove to the next SDES entry in the current item. Returns: true if there was a next entry.
bool sdesNextItem() nothrowMove to the next SDES item in packet. Returns: TRUE if there was a next item.
void setRb(uint nth, uint ssrc, ubyte fractionlost, int packetslost, uint exthighestseq, uint jitter, uint lsr, uint dlsr) nothrowSet the nth new report block in packet with the given values.
void srGetSenderInfo(out uint ssrc, out ulong ntptime, out uint rtptime, out uint packetCount, out uint octetCount) nothrowParse the SR sender info and store the values.
void srSetSenderInfo(uint ssrc, ulong ntptime, uint rtptime, uint packetCount, uint octetCount) nothrowSet the given values in the SR packet packet.
bool xrFirstRb() nothrowMove to the first extended report block in XR packet. Returns: TRUE if there was a first extended report block.
ushort xrGetBlockLength() nothrow
gstrtp.types.RTCPXRType xrGetBlockType() nothrowGet the extended report block type of the XR packet. Returns: The extended report block type.
bool xrGetDlrrBlock(uint nth, out uint ssrc, out uint lastRr, out uint delay) nothrowParse the extended report block for DLRR report block type.
bool xrGetPrtBySeq(ushort seq, out uint receiptTime) nothrowRetrieve the packet receipt time of seq which ranges in [begin_seq, end_seq).
bool xrGetPrtInfo(out uint ssrc, out ubyte thinning, out ushort beginSeq, out ushort endSeq) nothrowParse the Packet Recept Times Report Block from a XR packet
bool xrGetRleInfo(out uint ssrc, out ubyte thinning, out ushort beginSeq, out ushort endSeq, out uint chunkCount) nothrowParse the extended report block for Loss RLE and Duplicated LRE block type.
bool xrGetRleNthChunk(uint nth, out ushort chunk) nothrowRetrieve actual chunk data.
bool xrGetRrt(out ulong timestamp) nothrow
uint xrGetSsrc() nothrowGet the ssrc field of the XR packet. Returns: the ssrc.
bool xrGetSummaryInfo(out uint ssrc, out ushort beginSeq, out ushort endSeq) nothrowExtract a basic information from static summary report block of XR packet.
bool xrGetSummaryJitter(out uint minJitter, out uint maxJitter, out uint meanJitter, out uint devJitter) nothrowExtract jitter information from the statistics summary. If the jitter flag in a block header is set as zero, all of jitters will be zero.
bool xrGetSummaryPkt(out uint lostPackets, out uint dupPackets) nothrowGet the number of lost or duplicate packets. If the flag in a block header is set as zero, lost_packets or dup_packets will be zero.
bool xrGetSummaryTtl(out bool isIpv4, out ubyte minTtl, out ubyte maxTtl, out ubyte meanTtl, out ubyte devTtl) nothrowExtract the value of ttl for ipv4, or hop limit for ipv6.
bool xrGetVoipBurstMetrics(out ubyte burstDensity, out ubyte gapDensity, out ushort burstDuration, out ushort gapDuration) nothrow
bool xrGetVoipConfigurationParams(out ubyte gmin, out ubyte rxConfig) nothrow
bool xrGetVoipDelayMetrics(out ushort roundtripDelay, out ushort endSystemDelay) nothrow
bool xrGetVoipJitterBufferParams(out ushort jbNominal, out ushort jbMaximum, out ushort jbAbsMax) nothrow
bool xrGetVoipMetricsSsrc(out uint ssrc) nothrow
bool xrGetVoipPacketMetrics(out ubyte lossRate, out ubyte discardRate) nothrow
bool xrGetVoipQualityMetrics(out ubyte rFactor, out ubyte extRFactor, out ubyte mosLq, out ubyte mosCq) nothrow
bool xrGetVoipSignalMetrics(out ubyte signalLevel, out ubyte noiseLevel, out ubyte rerl, out ubyte gmin) nothrow
bool xrNextRb() nothrowMove to the next extended report block in XR packet. Returns: TRUE if there was a next extended report block.
Constructors
this(void * ptr, Flag!"Take" take)