Class ByePacket
Hierarchy (View Summary)
- RtcpPacket
- ByePacket
Index
Constructors
Methods
Methods
add
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): ByePacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns ByePacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): ByePacketDump
Dump RTCP BYE packet info.
-Returns ByePacketDump
get
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
Class CompoundPacket
RTCP Compound packet.
-See
-
-
- RFC 3550 -
Hierarchy (View Summary)
- Packet
- CompoundPacket
Index
Constructors
Methods
Constructors
constructor
- new CompoundPacket(view?: DataView): CompoundPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP Compound -packet will be created.
-
Returns CompoundPacket
Methods
add
- addPacket(packet: RtcpPacket): void
Add a new RtcpPacket at the end of this RTCP Compound packet.
-Parameters
- packet: RtcpPacket
Returns void
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): CompoundPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns CompoundPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): CompoundPacketDump
Dump RTCP Compound packet info.
-Returns CompoundPacketDump
get
get
- getPackets(): RtcpPacket[]
Return the RtcpPacket entries in this RTCP Compound packet.
-Returns RtcpPacket[]
Remarks
-
-
- The returned value is an array of RtcpPacket, which is an -abstract class. -
- By inspecting RtcpPacket.getPacketType we can cast each packet -to its specific class. -
Example
- -import { packets } from 'rtp.js';
const { CompoundPacket, RtcpPacketType, SdesPacket } = packets;
const compoundPacket = new CompoundPacket(view);
for (const packet of compoundPacket.getPackets())
{
switch (packet.getPacketType())
{
case RtcpPacketType.SDES:
{
const sdesPacket = packet as SdesPacket;
console.log(sdesPacket.getChunks());
break;
}
// etc.
}
} -
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
- setPackets(packets: RtcpPacket[]): void
Set the RtcpPacket entries in this RTCP Compound packet.
-Parameters
- packets: RtcpPacket[]
Returns void
Class DlrrExtendedReport
DLRR Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=5 | reserved | block length |
-+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-| SSRC_1 (SSRC of first receiver) | sub-
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ block
-| last RR (LRR) | 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| delay since last RR (DLRR) |
-+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-| SSRC_2 (SSRC of second receiver) | sub-
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ block
-: ... : 2
-+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-Hierarchy (View Summary)
- ExtendedReport
- DlrrExtendedReport
Index
Constructors
Methods
Constructors
constructor
- new DlrrExtendedReport(view?: DataView): DlrrExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty DLRR Extended -Report will be created.
-
Returns DlrrExtendedReport
Methods
add
- addSubReport(subReport: DlrrSubReport): void
Add sub-report.
-Parameters
- subReport: DlrrSubReport
Returns void
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DlrrExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns DlrrExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): DlrrExtendedReportDump
Dump DLRR Extended Report info.
-Returns DlrrExtendedReportDump
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
- getSubReports(): DlrrSubReport[]
Get sub-reports.
-Returns DlrrSubReport[]
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
- setSubReports(subReports: DlrrSubReport[]): void
Set sub-reports.
-Parameters
- subReports: DlrrSubReport[]
Returns void
Class DrleExtendedReport
Duplicate RLE Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=2 | rsvd. | T | block length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| begin_seq | end_seq |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| chunk 1 | chunk 2 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: ... :
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| chunk n-1 | chunk n |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- DrleExtendedReport
Index
Constructors
Methods
Constructors
constructor
- new DrleExtendedReport(view?: DataView): DrleExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty Duplicate RLE -Extended Report will be created.
-
Returns DrleExtendedReport
Methods
add
- addChunk(chunk: number): void
Add chunk.
-Parameters
- chunk: number
Returns void
Remarks
-
-
- Chunk must be given as 2 byte integer. -
- Use createExtendedReportRunLengthChunk or -createExtendedReportBitVectorChunk to create it. -
- Given chunk cannot be a terminating null chunk (0 number). -
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DrleExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns DrleExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): DrleExtendedReportDump
Dump Duplicate RLE Extended Report info.
-Returns DrleExtendedReportDump
get
get
get
- getChunks(): number[]
Get chunks.
-Returns number[]
Remarks
-
-
- Chunks are given as a list of 2 byte integers. -
- Use parseExtendedReportChunk to parse them. -
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
- setChunks(chunks: number[]): void
Set chunks.
-Parameters
- chunks: number[]
Returns void
Remarks
-
-
- Chunks must be given as a list of 2 byte integers. -
- Use createExtendedReportRunLengthChunk or -createExtendedReportBitVectorChunk to create them. -
set
set
set
Class EcnExtendedReport
ECN Summary Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=13 | reserved | block length = 5 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of Media Sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| ECT (0) Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| ECT (1) Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| ECN-CE Counter | not-ECT Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| Lost Packets Counter | Duplication Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- EcnExtendedReport
Index
Constructors
Methods
clone
-dump
-get
Constructors
constructor
- new EcnExtendedReport(view?: DataView): EcnExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty ECN Summary -Extended Report will be created.
-
Returns EcnExtendedReport
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): EcnExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns EcnExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): EcnExtendedReportDump
Dump ECN Summary Extended Report info.
-Returns EcnExtendedReportDump
get
get
get
get
get
get
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
set
set
set
Class EcnPacket
RTCP ECN packet (RTCP Transport Layer Feedback).
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT=8 | PT=RTPFB=205 | length=7 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| Extended Highest Sequence Number |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| ECT (0) Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| ECT (1) Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| ECN-CE Counter | not-ECT Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| Lost Packets Counter | Duplication Counter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- FeedbackPacket
- EcnPacket
Index
Constructors
Methods
clone
-dump
-get
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): EcnPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns EcnPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): EcnPacketDump
Dump RTCP ECN packet info.
-Returns EcnPacketDump
get
get
get
get
get
get
get
get
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
set
set
set
set
set
Class ExtendedJitterReportsPacket
RTCP Extended Jitter Reports packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-header |V=2|P| RC | PT=195 | length |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | inter-arrival jitter |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- : ... :
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- RtcpPacket
- ExtendedJitterReportsPacket
Index
Constructors
Methods
Constructors
constructor
- new ExtendedJitterReportsPacket(view?: DataView): ExtendedJitterReportsPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP Extended -Jitter Reports packet will be created.
-
Returns ExtendedJitterReportsPacket
Methods
add
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): ExtendedJitterReportsPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns ExtendedJitterReportsPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): ExtendedJitterReportsPacketDump
Dump RTCP Extended Jitter Reports packet info.
-Returns ExtendedJitterReportsPacketDump
get
get
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
Class ExtendedReportAbstract
Parent class of all XrPacket Extended Reports.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT | type-specific | block length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: type-specific block contents :
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
Index
Methods
Methods
Abstractclone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): Serializable Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns Serializable
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): ExtendedReportDump
Base Extended Report dump.
-Returns ExtendedReportDump
Abstractget
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
Abstractserialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
Class FeedbackPacketAbstract
RTCP Feedback packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT | PT | length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: Feedback Control Information (FCI) :
-: :
-Hierarchy (View Summary)
Index
Methods
Abstractclone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): Serializable Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns Serializable
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): FeedbackPacketDump
Base RTCP Feedback packet dump.
-Returns FeedbackPacketDump
Abstractget
get
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
Abstractserialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
Class GenericExtendedReport
Generic Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=??? | type-specific | block length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| body |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: ... :
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- GenericExtendedReport
Index
Constructors
Methods
Constructors
constructor
- new GenericExtendedReport(
view?: DataView,
reportType?: number,
): GenericExtendedReport Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty generic -Extended Report will be created.
-OptionalreportType: numberIf
-viewis not given, this parameter must be given.
Returns GenericExtendedReport
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): GenericExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns GenericExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): ExtendedReportDump
Dump generic Extended Report info.
-Returns ExtendedReportDump
get
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
Class GenericFeedbackPacket
RTCP generic Feedback packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT=??? | PT=205|206 | length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: Feedback Control Information (FCI) :
-: :
-Hierarchy (View Summary)
- FeedbackPacket
- GenericFeedbackPacket
Index
Constructors
Methods
Constructors
constructor
- new GenericFeedbackPacket(
view?: DataView,
packetType?: RTPFB | PSFB,
messageType?: RtpFeedbackMessageType | PsFeedbackMessageType,
): GenericFeedbackPacket Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP generic -Feedback packet will be created.
-OptionalpacketType: RTPFB | PSFBIf
-viewis not given, this parameter must be given.OptionalmessageType: RtpFeedbackMessageType | PsFeedbackMessageTypeIf
-viewis not given, this parameter must be given.
Returns GenericFeedbackPacket
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): GenericFeedbackPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns GenericFeedbackPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): GenericFeedbackPacketDump
Dump RTCP generic Feedback packet info.
-Returns GenericFeedbackPacketDump
get
get
get
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
Class GenericPacket
RTCP generic packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-header |V=2|P| SC | PT=??? | length |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-body | ... |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- : ... :
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-See
-
-
- RFC 3550 -
Hierarchy (View Summary)
- RtcpPacket
- GenericPacket
Index
Constructors
Methods
Constructors
constructor
- new GenericPacket(view?: DataView, packetType?: number): GenericPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP generic -packet will be created.
-OptionalpacketType: numberIf
-viewis not given, this parameter must be given.
Returns GenericPacket
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): GenericPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns GenericPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): GenericPacketDump
Dump RTCP generic packet info.
-Returns GenericPacketDump
get
get
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
Class LrleExtendedReport
Loss RLE Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=1 | rsvd. | T | block length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| begin_seq | end_seq |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| chunk 1 | chunk 2 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: ... :
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| chunk n-1 | chunk n |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- LrleExtendedReport
Index
Constructors
Methods
Constructors
constructor
- new LrleExtendedReport(view?: DataView): LrleExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty Loss RLE -Extended Report will be created.
-
Returns LrleExtendedReport
Methods
add
- addChunk(chunk: number): void
Add chunk.
-Parameters
- chunk: number
Returns void
Remarks
-
-
- Chunk must be given as 2 byte integer. -
- Use createExtendedReportRunLengthChunk or -createExtendedReportBitVectorChunk to create it. -
- Given chunk cannot be a terminating null chunk (0 number). -
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): LrleExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns LrleExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): LrleExtendedReportDump
Dump Loss RLE Extended Report info.
-Returns LrleExtendedReportDump
get
get
get
- getChunks(): number[]
Get chunks.
-Returns number[]
Remarks
-
-
- Chunks are given as a list of 2 byte integers. -
- Use parseExtendedReportChunk to parse them. -
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
- setChunks(chunks: number[]): void
Set chunks.
-Parameters
- chunks: number[]
Returns void
Remarks
-
-
- Chunks must be given as a list of 2 byte integers. -
- Use createExtendedReportRunLengthChunk or -createExtendedReportBitVectorChunk to create them. -
set
set
set
Class NackPacket
RTCP NACK packet (RTCP Transport Layer Feedback).
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT=1 | PT=RTPFB=205 | length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| PID | BLP |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: ... :
-+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-Hierarchy (View Summary)
- FeedbackPacket
- NackPacket
Index
Constructors
Methods
Constructors
constructor
- new NackPacket(view?: DataView): NackPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP NACK -packet will be created.
-
Returns NackPacket
Methods
add
- addItem(pid: number, bitmask: number): void
Add NACK item value.
-Parameters
- pid: number
- bitmask: number
Returns void
Remarks
-
-
- Use createNackItem to create the NACK item. -
- Serialization is needed after calling this method. -
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): NackPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns NackPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): NackPacketDump
Dump RTCP NACK packet info.
-Returns NackPacketDump
get
get
get
- getItems(): { bitmask: number; pid: number }[]
Get NACK items.
-Returns { bitmask: number; pid: number }[]
Remarks
-
-
- Use parseNackItem to parse returned NACK items. -
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
- setItems(items: { bitmask: number; pid: number }[]): void
Set NACK items.
-Parameters
- items: { bitmask: number; pid: number }[]
Returns void
Remarks
-
-
- Use createNackItem to create NACK items. -
- Serialization is needed after calling this method. -
set
set
Class PacketAbstract
Parent class of all RTP and RTCP packets.
-Hierarchy (View Summary)
Index
Methods
Methods
Abstractclone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): Serializable Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns Serializable
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): PacketDump
Base RTCP packet dump.
-Returns PacketDump
Abstractget
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
Abstractserialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
Class PliPacket
RTCP PLI packet (RTCP Payload Specific Feedback).
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT=1 | PT=PSFB=206 | length=2 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- FeedbackPacket
- PliPacket
Index
Constructors
Methods
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): PliPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns PliPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): FeedbackPacketDump
Dump RTCP PLI packet info.
-Returns FeedbackPacketDump
get
get
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
Class PrtExtendedReport
Packet Receipt Times Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=3 | rsvd. | T | block length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| begin_seq | end_seq |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| Receipt time of packet begin_seq |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| Receipt time of packet (begin_seq + 1) mod 65536 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: ... :
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| Receipt time of packet (end_seq - 1) mod 65536 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- PrtExtendedReport
Index
Constructors
Methods
Constructors
constructor
- new PrtExtendedReport(view?: DataView): PrtExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty Packet Receipt -Times Extended Report will be created.
-
Returns PrtExtendedReport
Methods
add
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): PrtExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns PrtExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): PrtExtendedReportDump
Dump Packet Receipt Times Extended Report info.
-Returns PrtExtendedReportDump
get
get
get
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
set
Class ReceiverReportPacket
RTCP Receiver Report packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-header |V=2|P| RC | PT=RR=201 | length |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | SSRC of packet sender |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-report | SSRC_1 (SSRC of first source) |
-block +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- 1 | fraction lost | cumulative number of packets lost |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | extended highest sequence number received |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | interarrival jitter |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | last SR (LSR) |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | delay since last SR (DLSR) |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-report | SSRC_2 (SSRC of second source) |
-block +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- 2 : ... :
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- | profile-specific extensions |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- RtcpPacket
- ReceiverReportPacket
Index
Constructors
Methods
Constructors
constructor
- new ReceiverReportPacket(view?: DataView): ReceiverReportPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP Receiver -Report packet will be created.
-
Returns ReceiverReportPacket
Methods
add
- addReport(report: ReceptionReport): void
Add Reception Report.
-Parameters
- report: ReceptionReport
Returns void
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): ReceiverReportPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns ReceiverReportPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): ReceiverReportPacketDump
Dump Receiver Report packet info.
-Returns ReceiverReportPacketDump
get
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
- getReports(): ReceptionReport[]
Get Reception Reports.
-Returns ReceptionReport[]
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
- setReports(reports: ReceptionReport[]): void
Set Reception Reports.
-Parameters
- reports: ReceptionReport[]
Returns void
set
Class ReceptionReport
RTCP Reception Report.
-Hierarchy (View Summary)
- Serializable
- ReceptionReport
Index
Constructors
Methods
Constructors
constructor
- new ReceptionReport(view?: DataView): ReceptionReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP Receiver -Report will be created.
-
Returns ReceptionReport
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): ReceptionReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns ReceptionReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): ReceptionReportDump
Dump Reception Report info.
-Returns ReceptionReportDump
get
get
get
get
get
get
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
set
set
set
Class RpsiPacket
RTCP RPSI packet (RTCP Payload Specific Feedback).
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT=3 | PT=PSFB=206 | length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| PB |0| Payload Type| Native RPSI bit string |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| defined per codec ... | Padding (0) |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- FeedbackPacket
- RpsiPacket
Index
Constructors
Methods
Constructors
constructor
- new RpsiPacket(view?: DataView): RpsiPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP RPSI -packet will be created.
-
Returns RpsiPacket
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): RpsiPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns RpsiPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): RpsiPacketDump
Dump RTCP RPSI packet info.
-Returns RpsiPacketDump
get
get
get
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
Class RrtExtendedReport
Receiver Reference Time Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=4 | reserved | block length = 2 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| NTP timestamp, most significant word |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| NTP timestamp, least significant word |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- RrtExtendedReport
Index
Constructors
Methods
Constructors
constructor
- new RrtExtendedReport(view?: DataView): RrtExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty Receiver -Reference Time Extended Report will be created.
-
Returns RrtExtendedReport
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): RrtExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns RrtExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): RrtExtendedReportDump
Dump Receiver Reference Time Extended Report info.
-Returns RrtExtendedReportDump
get
get
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
Class RtcpPacketAbstract
RTCP packet. Parent class of all RTCP packets.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-header |V=2|P| SC | PT | length |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-Hierarchy (View Summary)
Index
Methods
Methods
Abstractclone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): Serializable Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns Serializable
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): RtcpPacketDump
Base RTCP packet dump.
-Returns RtcpPacketDump
Abstractget
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
Abstractserialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
Class RtpPacket
RTP packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P|X| CC |M| PT | sequence number |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| timestamp |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| synchronization source (SSRC) identifier |
-+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-| contributing source (CSRC) identifiers |
-| .... |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| defined by profile | length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| header extension |
-| .... |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- Packet
- RtpPacket
Index
Constructors
Methods
clear
Methods
clear
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): RtpPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns RtpPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
delete
dump
- dump(): RtpPacketDump
Dump RTP packet info.
-Returns RtpPacketDump
enable
enable
get
- getAbsSendTimeExtension(): undefined | number
Read the value of the RtpExtensionType.ABS_SEND_TIME RTP -extension.
-Returns undefined | number
Remarks
-
-
- Returned value is "Absolute Send Time" format. See -timeMsToAbsSendTime. -
get
get
get
get
- getExtensionMapping(): Partial<Record<RtpExtensionType, number>>
Get RTP extension mapping (association of RTP extension types and their -numeric ids in this RTP packet).
-Returns Partial<Record<RtpExtensionType, number>>
get
get
get
- getMidExtension(): undefined | string
Read the value of the RtpExtensionType.MID RTP extension.
-Returns undefined | string
get
get
get
get
- getRepairedRidExtension(): undefined | string
Read the value of the RtpExtensionType.RTP_REPAIRED_STREAM_ID RTP -extension.
-Returns undefined | string
get
- getRidExtension(): undefined | string
Read the value of the RtpExtensionType.RTP_STREAM_ID RTP -extension.
-Returns undefined | string
get
get
get
- getSsrcAudioLevelExtension(): undefined | SsrcAudioLevelExtension
Read the value of the RtpExtensionType.SSRC_AUDIO_LEVEL RTP -extension.
-Returns undefined | SsrcAudioLevelExtension
get
get
- getTransmissionOffsetExtension(): undefined | number
Read the value of the RtpExtensionType.TOFFSET RTP extension.
-Returns undefined | number
get
- getTransportWideSeqNumberExtension(): undefined | number
Read the value of the RtpExtensionType.TRANSPORT_WIDE_SEQ_NUMBER -RTP extension.
-Returns undefined | number
get
- getVideoOrientationExtension(): undefined | VideoOrientationExtension
Read the value of the RtpExtensionType.VIDEO_ORIENTATION RTP -extension.
-Returns undefined | VideoOrientationExtension
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
has
has
needs
pad
rtx
rtx
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
- setAbsSendTimeExtension(absSendTime?: number): void
Set the value of the RtpExtensionType.ABS_SEND_TIME RTP -extension.
-Parameters
OptionalabsSendTime: number
Returns void
Remarks
-
-
- Given
absSendTimemust be in "Absolute Send Time" format. See -timeMsToAbsSendTime.
-
set
set
set
- setExtensionMapping(
extensionMapping: Partial<Record<RtpExtensionType, number>>,
): void Set RTP extension mapping (association of RTP extension types and their -numeric ids in this RTP packet).
-Parameters
- extensionMapping: Partial<Record<RtpExtensionType, number>>
Returns void
set
set
- setMidExtension(mid?: string): void
Set the value of the RtpExtensionType.MID RTP extension.
-Parameters
Optionalmid: string
Returns void
set
set
set
- setRepairedRidExtension(rrid?: string): void
Set the value of the RtpExtensionType.RTP_REPAIRED_STREAM_ID RTP -extension.
-Parameters
Optionalrrid: string
Returns void
set
- setRidExtension(rid?: string): void
Set the value of the RtpExtensionType.RTP_STREAM_ID RTP -extension.
-Parameters
Optionalrid: string
Returns void
set
set
set
- setSsrcAudioLevelExtension(ssrcAudioLevel?: SsrcAudioLevelExtension): void
Set the value of the RtpExtensionType.SSRC_AUDIO_LEVEL RTP -extension.
-Parameters
OptionalssrcAudioLevel: SsrcAudioLevelExtension
Returns void
set
set
- setTransmissionOffsetExtension(offset?: number): void
Set the value of the RtpExtensionType.TOFFSET RTP extension.
-Parameters
Optionaloffset: number
Returns void
set
- setTransportWideSeqNumberExtension(sequenceNumber?: number): void
Set the value of the RtpExtensionType.TRANSPORT_WIDE_SEQ_NUMBER -RTP extension.
-Parameters
OptionalsequenceNumber: number
Returns void
set
- setVideoOrientationExtension(videoOrientation?: VideoOrientationExtension): void
Set the value of the RtpExtensionType.VIDEO_ORIENTATION RTP -extension.
-Parameters
OptionalvideoOrientation: VideoOrientationExtension
Returns void
Class SdesChunk
SDES Chunk.
-Hierarchy (View Summary)
- Serializable
- SdesChunk
Index
Constructors
Methods
Methods
add
- addItem(type: SdesItemType, text: string): void
Add SDES Item.
-Parameters
- type: SdesItemType
- text: string
Returns void
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): SdesChunk Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns SdesChunk
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): SdesChunkDump
Dump SDES Chunk info.
-Returns SdesChunkDump
get
get
- getItems(): { text: string; type: SdesItemType }[]
Get SDES Items.
-Returns { text: string; type: SdesItemType }[]
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
- setItems(items: { text: string; type: SdesItemType }[]): void
Set SDES Items.
-Parameters
- items: { text: string; type: SdesItemType }[]
Returns void
set
Class SdesPacket
RTCP SDES packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-header |V=2|P| SC | PT=SDES=202 | length |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-chunk | SSRC/CSRC_1 |
- 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | SDES items |
- | ... |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-chunk | SSRC/CSRC_2 |
- 2 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | SDES items |
- | ... |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-Hierarchy (View Summary)
- RtcpPacket
- SdesPacket
Index
Constructors
Methods
Constructors
constructor
- new SdesPacket(view?: DataView): SdesPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP SDES -packet will be created.
-
Returns SdesPacket
Methods
add
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): SdesPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns SdesPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): SdesPacketDump
Dump Receiver Report packet info.
-Returns SdesPacketDump
get
get
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
Class SenderReportPacket
RTCP Sender Report packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-header |V=2|P| RC | PT=SR=200 | length |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | SSRC of sender |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-sender | NTP timestamp, most significant word |
-info +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | NTP timestamp, least significant word |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | RTP timestamp |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | sender's packet count |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | sender's octet count |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-report | SSRC_1 (SSRC of first source) |
-block +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- 1 | fraction lost | cumulative number of packets lost |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | extended highest sequence number received |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | interarrival jitter |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | last SR (LSR) |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | delay since last SR (DLSR) |
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-report | SSRC_2 (SSRC of second source) |
-block +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- 2 : ... :
- +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- | profile-specific extensions |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- RtcpPacket
- SenderReportPacket
Index
Constructors
Methods
add
Constructors
constructor
- new SenderReportPacket(view?: DataView): SenderReportPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP Sender -Report packet will be created.
-
Returns SenderReportPacket
Methods
add
- addReport(report: ReceptionReport): void
Add Reception Report.
-Parameters
- report: ReceptionReport
Returns void
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): SenderReportPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns SenderReportPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): SenderReportPacketDump
Dump Sender Report packet info.
-Returns SenderReportPacketDump
get
get
get
get
get
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
- getReports(): ReceptionReport[]
Get Reception Reports.
-Returns ReceptionReport[]
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
set
- setReports(reports: ReceptionReport[]): void
Set Reception Reports.
-Parameters
- reports: ReceptionReport[]
Returns void
set
set
Class SerializableAbstract
Class holding a serializable buffer view. All RTP and RTCP packets inherit -from this class, and also items in some RTCP packets.
-Hierarchy (View Summary)
- Serializable
Index
Methods
Methods
Abstractclone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): Serializable Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns Serializable
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): SerializableDump
Serializable dump.
-Returns SerializableDump
Abstractget
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
Abstractserialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
Class SliPacket
RTCP SLI packet (RTCP Payload Specific Feedback).
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT=2 | PT=PSFB=206 | length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| First | Number | PictureID |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-: ... :
-+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-Hierarchy (View Summary)
- FeedbackPacket
- SliPacket
Index
Constructors
Methods
Methods
add
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): SliPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns SliPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): SliPacketDump
Dump RTCP SLI packet info.
-Returns SliPacketDump
get
get
get
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
Class SrReqPacket
RTCP SR REQ packet (RTCP Transport Layer Feedback).
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|V=2|P| FMT=5 | PT=RTPFB=205 | length=2 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of packet sender |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of media source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-See
-
-
- RFC 6051 -
Hierarchy (View Summary)
- FeedbackPacket
- SrReqPacket
Index
Constructors
Methods
Constructors
constructor
- new SrReqPacket(view?: DataView): SrReqPacket
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty RTCP SR REQ -packet will be created.
-
Returns SrReqPacket
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): SrReqPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns SrReqPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): FeedbackPacketDump
Dump RTCP SR REQ packet info.
-Returns FeedbackPacketDump
get
get
get
get
- getMessageType(): RtpFeedbackMessageType | PsFeedbackMessageType
Get the RTCP Feedback message type.
-Returns RtpFeedbackMessageType | PsFeedbackMessageType
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
Class SsExtendedReport
Statistics Summary Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=6 |L|D|J|ToH|rsvd.| block length = 9 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| begin_seq | end_seq |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| lost_packets |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| dup_packets |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| min_jitter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| max_jitter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| mean_jitter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| dev_jitter |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| min_ttl_or_hl | max_ttl_or_hl |mean_ttl_or_hl | dev_ttl_or_hl |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- SsExtendedReport
Index
Constructors
Methods
clone
-dump
-get
Constructors
constructor
- new SsExtendedReport(view?: DataView): SsExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty Statistics -Summary Extended Report will be created.
-
Returns SsExtendedReport
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): SsExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns SsExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): SsExtendedReportDump
Dump Statistics Summary Extended Report info.
-Returns SsExtendedReportDump
get
get
get
get
get
get
get
get
get
get
get
get
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
set
set
set
set
set
set
set
set
set
Class VmExtendedReport
VoIP Metrics Extended Report.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| BT=7 | reserved | block length = 8 |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| SSRC of source |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| loss rate | discard rate | burst density | gap density |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| burst duration | gap duration |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| round trip delay | end system delay |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| signal level | noise level | RERL | Gmin |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| R factor | ext. R factor | MOS-LQ | MOS-CQ |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| RX config | reserved | JB nominal |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-| JB maximum | JB abs max |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- ExtendedReport
- VmExtendedReport
Index
Constructors
Methods
clone
-dump
-get
Constructors
constructor
- new VmExtendedReport(view?: DataView): VmExtendedReport
Parameters
Optionalview: DataViewIf given it will be parsed. Otherwise an empty VoIP Metrics -Extended Report will be created.
-
Returns VmExtendedReport
Methods
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): VmExtendedReport Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns VmExtendedReport
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): VmExtendedReportDump
Dump VoIP Metrics Extended Report info.
-Returns VmExtendedReportDump
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
get
- getReportType(): ExtendedReportType
Get the Extended Report type.
-Returns ExtendedReportType
get
getRFactor
get
get
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
set
setRFactor
set
set
set
Class XrPacket
RTCP XR packet.
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-header |V=2|P|reserved | PT=XR=207 | length |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | SSRC |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-report : report blocks :
-blocks +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Hierarchy (View Summary)
- RtcpPacket
- XrPacket
Index
Constructors
Methods
Methods
add
- addReport(report: ExtendedReport): void
Add Extended Report.
-Parameters
- report: ExtendedReport
Returns void
clone
- clone(
buffer?: ArrayBuffer,
byteOffset?: number,
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): XrPacket Clone the packet or item. The cloned instance does not share any memory -with the original one. The cloned instance is a new class instance -referencing a different buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be cloned. If not given, a -new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere clonation will -start.OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given -
-serializationBufferwhere serialization (if needed) will start.
Returns XrPacket
Remarks
-
-
- The buffer is serialized if needed (to apply pending modifications) by -internally calling serialize. -
dump
- dump(): XrPacketDump
Dump XR packet info.
-Returns XrPacketDump
get
get
get
- getPacketType(): RtcpPacketType
Get the RTCP packet type.
-Returns RtcpPacketType
get
get
- getReports(): ExtendedReport[]
Get Extended Reports.
-Returns ExtendedReport[]
Remarks
-
-
- The returned value is an array of ExtendedReport, which is an -abstract class. -
- By inspecting ExtendedReport.getReportType we can cast each -extended report to its specific class. -
Example
- -import { packets } from 'rtp.js';
const { XrPacket, ExtendedReportType, LrleExtendedReport } = packets;
const packet = new XrPacket(view);
for (const extendedReport of packet.getReports())
{
switch (extendedReport.getReportType())
{
case ExtendedReportType.LRLE:
{
const lrleExtendedReport = extendedReport as LrleExtendedReport;
console.log(lrleExtendedReport.getThinning());
break;
}
// etc.
}
} -
get
get
- getView(
serializationBuffer?: ArrayBuffer,
serializationByteOffset?: number,
): DataView Get a buffer view containing the serialized content of the packet or item.
-Parameters
OptionalserializationBuffer: ArrayBufferBuffer in which the content will be serialized -in case serialization is needed. If not given, a new one will internally -allocated.
-OptionalserializationByteOffset: numberByte offset of the given
-serializationBuffer-where serialization (if needed) will start.
Returns DataView
Remarks
-
-
- The internal buffer is serialized if needed (to apply pending -modifications) by internally calling serialize. -
needs
pad
serialize
- serialize(buffer?: ArrayBuffer, byteOffset?: number): void
Apply pending changes and serialize the content of the packet or item into -a new buffer.
-Parameters
Optionalbuffer: ArrayBufferBuffer in which the content will be serialized. If not -given, a new one will internally allocated.
-OptionalbyteOffset: numberByte offset of the given
-bufferwhere serialization -will start.
Returns void
Remarks
-
-
- In most cases there is no need to use this method since many setter -methods apply changes within the current buffer. To be sure, check -needsSerialization before. -
Throws
-
-
- If serialization fails due to invalid content previously added. -
- If given
bufferdoesn't have space enough to serialize the content.
- - If the
buffermember of the givenArrayBufferis the same than the -internal buffer in this packet and the givenbyteOffsetwould make -the serialization happen in bytes currently used by the packet (this would -corrupt the packet).
-
set
- setReports(reports: ExtendedReport[]): void
Set Extended Reports.
-Parameters
- reports: ExtendedReport[]
Returns void
set
rtp.js
-
RTP stack for Node.js and browser written in TypeScript. rtp.js provides with an API to parse, generate and modify RTP and RTCP packets.
-Installation
npm install rtp.js
-Usage
-
-
- - - -
-
-
All RTP and RTCP classes, types and packet related helpers are exported by the
-packetsmodule.
- -import { packets } from 'rtp.js';
const {
isRtp,
isRtcp,
RtpPacket,
CompoundPacket,
ReceiverReportPacket,
SenderReportPacket,
ReceptionReport,
ByePacket,
SdesPacket,
NackPacket,
SrReqPacket,
EcnPacket,
PliPacket,
SliPacket,
RpsiPacket,
XrPacket,
ExtendedJitterReportsPacket,
GenericPacket,
// etc.
} = packets; -
- -
-
The
-utilsmodule exports some generic helpers and utilities.
- -import { utils } from 'rtp.js';
const view = utils.stringToDataView('foo'); -
-
Authors
-License
-Enumeration ExtendedReportType
Extended Report types.
-Enumeration PsFeedbackMessageType
RTCP Feedback payload specific message types.
-Enumeration RtcpPacketType
RTCP packet types.
- Enumeration Members
APP
APP: 204
RTCP APP packet.
-BYE
BYE: 203
RTCP BYE packet.
-IJ
IJ: 195
Extended Jitter Reports packet.
-PSFB
PSFB: 206
RTCP Payload Specific Feedback packet.
-RR
RR: 201
RTCP Receiver Report packet.
-RTPFB
RTPFB: 205
RTCP Transport Layer Feedback packet.
-SDES
SDES: 202
RTCP Sender Report packet.
-SR
SR: 200
RTCP Sender Report packet.
-XR
XR: 207
RTCP Extended Report packet.
-Enumeration RtpExtensionType
RTP extensions.
- Index
Enumeration Members
Enumeration Members
ABS_
ABS_SEND_TIME: 3
Absolute Send Time.
-URI: http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time
MID
MID: 0
Media identification.
-URI: urn:ietf:params:rtp-hdrext:sdes:mid
See
-
-
- RFC 9143 -
RTP_
RTP_REPAIRED_STREAM_ID: 2
RTP Repaired Stream Identifier.
-URI: urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id
See
-
-
- RFC 8852 -
RTP_
RTP_STREAM_ID: 1
RTP Stream Identifier.
-URI: urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id
See
-
-
- RFC 8852 -
SSRC_
SSRC_AUDIO_LEVEL: 5
Audio Level
-URI: urn:ietf:params:rtp-hdrext:ssrc-audio-level
See
-
-
- RFC 6464 -
TOFFSET
TOFFSET: 7
Transmission Time Offsets.
-URI: urn:ietf:params:rtp-hdrext:toffset
See
-
-
- RFC 5450 -
TRANSPORT_
TRANSPORT_WIDE_SEQ_NUMBER: 4
Transport-wide Sequence Number.
-URI: http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01
VIDEO_
VIDEO_ORIENTATION: 6
Video Orientation.
-URI: urn:3gpp:video-orientation
diff --git a/docs/enums/packets.SdesItemType.html b/docs/enums/packets.SdesItemType.html
deleted file mode 100644
index 5b18393b..00000000
--- a/docs/enums/packets.SdesItemType.html
+++ /dev/null
@@ -1,18 +0,0 @@
-
Enumeration SdesItemType
SDES Chunk Item types.
- Enumeration Members
CNAME
CNAME: 1
Canonical End-Point Identifier SDES Item.
-EMAIL: 3
Electronic Mail Address SDES Item.
-LOC
LOC: 5
Geographic User Location SDES Item.
-NAME
NAME: 2
User Name SDES Item.
-NOTE
NOTE: 7
Notice/Status SDES Item.
-PHONE
PHONE: 4
Phone Number SDES Item.
-PRIV
PRIV: 8
Private Extensions SDES Item.
-TOOL
TOOL: 6
Application or Tool Name SDES Item.
-Function createExtendedReportBitVectorChunk
- createExtendedReportBitVectorChunk(bitVector: number): number
Create a Bit Vector Chunk and return a 2 bytes number representing it.
-
- -0 1 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -|C| bit vector | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -Parameters
- bitVector: number
Returns number
Function createExtendedReportRunLengthChunk
- createExtendedReportRunLengthChunk(
runType: "zeros" | "ones",
runLength: number,
): number Create a Run Length Chunk and return a 2 bytes number representing it.
-
- -0 1 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -|C|R| run length | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -Parameters
- runType: "zeros" | "ones"
- runLength: number
Returns number
Function createNackItem
diff --git a/docs/functions/packets.isRtp.html b/docs/functions/packets.isRtp.html
deleted file mode 100644
index b3e66b4c..00000000
--- a/docs/functions/packets.isRtp.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/packets.parseExtendedReportChunk.html b/docs/functions/packets.parseExtendedReportChunk.html
deleted file mode 100644
index 5c46478d..00000000
--- a/docs/functions/packets.parseExtendedReportChunk.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
Function parseExtendedReportChunk
- parseExtendedReportChunk(chunk: number): ExtendedReportChunk
Parse given 2 bytes number as a Extended Report chunk.
-Parameters
- chunk: number
Returns ExtendedReportChunk
diff --git a/docs/functions/packets.rtpExtensionUriToType.html b/docs/functions/packets.rtpExtensionUriToType.html
deleted file mode 100644
index 8642dbff..00000000
--- a/docs/functions/packets.rtpExtensionUriToType.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Function rtpExtensionUriToType
- rtpExtensionUriToType(uri: string): RtpExtensionType | undefined
Get the RTP extension type associated to the given RTP extension URI.
-Parameters
- uri: string
Returns RtpExtensionType | undefined
diff --git a/docs/functions/utils.arrayBufferToNodeBuffer.html b/docs/functions/utils.arrayBufferToNodeBuffer.html
deleted file mode 100644
index e729e1e9..00000000
--- a/docs/functions/utils.arrayBufferToNodeBuffer.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/utils.arrayBufferToString.html b/docs/functions/utils.arrayBufferToString.html
deleted file mode 100644
index d82a9b61..00000000
--- a/docs/functions/utils.arrayBufferToString.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/utils.dataViewToNodeBuffer.html b/docs/functions/utils.dataViewToNodeBuffer.html
deleted file mode 100644
index 5a301c32..00000000
--- a/docs/functions/utils.dataViewToNodeBuffer.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/utils.dataViewToString.html b/docs/functions/utils.dataViewToString.html
deleted file mode 100644
index 9ff1ea95..00000000
--- a/docs/functions/utils.dataViewToString.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/utils.getStringByteLength.html b/docs/functions/utils.getStringByteLength.html
deleted file mode 100644
index 819e4677..00000000
--- a/docs/functions/utils.getStringByteLength.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/utils.nodeBufferToArrayBuffer.html b/docs/functions/utils.nodeBufferToArrayBuffer.html
deleted file mode 100644
index 24933fdd..00000000
--- a/docs/functions/utils.nodeBufferToArrayBuffer.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/utils.nodeBufferToDataView.html b/docs/functions/utils.nodeBufferToDataView.html
deleted file mode 100644
index aa8e6edf..00000000
--- a/docs/functions/utils.nodeBufferToDataView.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/utils.numberToDataView.html b/docs/functions/utils.numberToDataView.html
deleted file mode 100644
index 6612ce1c..00000000
--- a/docs/functions/utils.numberToDataView.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/utils.numericArrayToDataView.html b/docs/functions/utils.numericArrayToDataView.html
deleted file mode 100644
index 464e954d..00000000
--- a/docs/functions/utils.numericArrayToDataView.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/utils.padTo4Bytes.html b/docs/functions/utils.padTo4Bytes.html
deleted file mode 100644
index 9bf8395a..00000000
--- a/docs/functions/utils.padTo4Bytes.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/functions/utils.stringToDataView.html b/docs/functions/utils.stringToDataView.html
deleted file mode 100644
index 20c03a16..00000000
--- a/docs/functions/utils.stringToDataView.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
deleted file mode 100644
index 8a6c3084..00000000
--- a/docs/hierarchy.html
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index add36fb2..00000000
--- a/docs/index.html
+++ /dev/null
@@ -1,29 +0,0 @@
-
rtp.js - v0.13.1
rtp.js
-
RTP stack for Node.js and browser written in TypeScript. rtp.js provides with an API to parse, generate and modify RTP and RTCP packets.
-Installation
npm install rtp.js
-Usage
-
-
- - - -
-
-
All RTP and RTCP classes, types and packet related helpers are exported by the
-packetsmodule.
- -import { packets } from 'rtp.js';
const {
isRtp,
isRtcp,
RtpPacket,
CompoundPacket,
ReceiverReportPacket,
SenderReportPacket,
ReceptionReport,
ByePacket,
SdesPacket,
NackPacket,
SrReqPacket,
EcnPacket,
PliPacket,
SliPacket,
RpsiPacket,
XrPacket,
ExtendedJitterReportsPacket,
GenericPacket,
// etc.
} = packets; -
- -
-
The
-utilsmodule exports some generic helpers and utilities.
- -import { utils } from 'rtp.js';
const view = utils.stringToDataView('foo'); -
-
Authors
-License
-Module packets
RTP
RTCP
- PsFeedbackMessageType
- RtcpPacketType
- RtpFeedbackMessageType
- SdesItemType
- ByePacket
- CompoundPacket
- EcnPacket
- ExtendedJitterReportsPacket
- FeedbackPacket
- GenericFeedbackPacket
- GenericPacket
- NackPacket
- PliPacket
- ReceiverReportPacket
- ReceptionReport
- RpsiPacket
- RtcpPacket
- SdesChunk
- SdesPacket
- SenderReportPacket
- SliPacket
- SrReqPacket
- XrPacket
- ByePacketDump
- CompoundPacketDump
- EcnPacketDump
- ExtendedJitterReportsPacketDump
- FeedbackPacketDump
- GenericFeedbackPacketDump
- GenericPacketDump
- NackPacketDump
- PliPacketDump
- ReceiverReportPacketDump
- ReceptionReportDump
- RpsiPacketDump
- RtcpPacketDump
- SdesChunkDump
- SdesPacketDump
- SenderReportPacketDump
- SliPacketDump
- SrReqPacketDump
- XrPacketDump
- createNackItem
- isRtcp
- parseNackItem
RTCP Extended Reports
- ExtendedReportType
- DlrrExtendedReport
- DrleExtendedReport
- EcnExtendedReport
- ExtendedReport
- GenericExtendedReport
- LrleExtendedReport
- PrtExtendedReport
- RrtExtendedReport
- SsExtendedReport
- VmExtendedReport
- DlrrExtendedReportDump
- DlrrSubReport
- DrleExtendedReportDump
- EcnExtendedReportDump
- ExtendedReportChunk
- ExtendedReportDump
- GenericExtendedReportDump
- LrleExtendedReportDump
- PrtExtendedReportDump
- RrtExtendedReportDump
- SsExtendedReportDump
- VmExtendedReportDump
- createExtendedReportBitVectorChunk
- createExtendedReportRunLengthChunk
- parseExtendedReportChunk
diff --git a/docs/types/packets.ByePacketDump.html b/docs/types/packets.ByePacketDump.html
deleted file mode 100644
index 4f526a69..00000000
--- a/docs/types/packets.ByePacketDump.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias ByePacketDump
RTCP BYE packet info dump.
-Type Alias CompoundPacketDump
RTCP Compound packet info dump.
-Type Alias DlrrExtendedReportDump
DLRR Extended Report dump.
-
diff --git a/docs/types/packets.DrleExtendedReportDump.html b/docs/types/packets.DrleExtendedReportDump.html
deleted file mode 100644
index a1fdb404..00000000
--- a/docs/types/packets.DrleExtendedReportDump.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias DrleExtendedReportDump
DrleExtendedReportDump: ExtendedReportDump & {
beginSeq: number;
chunks: number[];
endSeq: number;
ssrc: number;
thinning: number;
}
beginSeq: number;
chunks: number[];
endSeq: number;
ssrc: number;
thinning: number;
}
Duplicate RLE Extended Report dump.
-Type Alias EcnExtendedReportDump
EcnExtendedReportDump: ExtendedReportDump & {
duplicationCounter: number;
ecnCeCounter: number;
ect0Counter: number;
ect1Counter: number;
lostPacketsCounter: number;
nonEctCounter: number;
ssrc: number;
}
duplicationCounter: number;
ecnCeCounter: number;
ect0Counter: number;
ect1Counter: number;
lostPacketsCounter: number;
nonEctCounter: number;
ssrc: number;
}
ECN Summary Extended Report dump.
-Type Alias EcnPacketDump
EcnPacketDump: FeedbackPacketDump & {
duplicationCounter: number;
ecnCeCounter: number;
ect0Counter: number;
ect1Counter: number;
extendedHighestSequenceNumber: number;
lostPacketsCounter: number;
nonEctCounter: number;
}
duplicationCounter: number;
ecnCeCounter: number;
ect0Counter: number;
ect1Counter: number;
extendedHighestSequenceNumber: number;
lostPacketsCounter: number;
nonEctCounter: number;
}
RTCP ECN packet info dump.
-Type Alias ExtendedJitterReportsPacketDump
RTCP Extended Jitter Reports packet info dump.
-Type Alias ExtendedReportChunk
ExtendedReportChunk: {
bitVector?: number;
chunkType: "run-length" | "bit-vector" | "terminating-null";
runLength?: number;
runType?: "zeros" | "ones";
}
bitVector?: number;
chunkType: "run-length" | "bit-vector" | "terminating-null";
runLength?: number;
runType?: "zeros" | "ones";
}
Loss RLE and Duplicate RLE Extended Report chunk info.
-Run Length Chunk
- 0 1
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|C|R| run length |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-Bit Vector Chunk
- 0 1
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|C| bit vector |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-Terminating Null Chunk
- 0 1
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0|
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-Type declaration
OptionalbitVector?: numberChunk bit vector (only set if
-chunkTypeis 'bit-vector').chunkType: "run-length" | "bit-vector" | "terminating-null"
Chunk type (Run Length Chunk, Bit Vector Chunk or Terminating Null Chunk).
-OptionalrunLength?: numberChunk run length (only set if
-chunkTypeis 'run-length').OptionalrunType?: "zeros" | "ones"Chunk run type (only set if
-chunkTypeis 'run-length').
Type Alias ExtendedReportDump
Extended Report dump.
-Type Alias FeedbackPacketDump
FeedbackPacketDump: RtcpPacketDump & {
mediaSsrc: number;
messageType: RtpFeedbackMessageType | PsFeedbackMessageType;
senderSsrc: number;
}
mediaSsrc: number;
messageType: RtpFeedbackMessageType | PsFeedbackMessageType;
senderSsrc: number;
}
RTCP Feedback packet info dump.
-Type Alias GenericExtendedReportDump
Generic Extended Report dump.
-Type Alias GenericFeedbackPacketDump
RTCP generic Feedback packet info.
-Type Alias GenericPacketDump
RTCP generic packet info dump.
-Type Alias LrleExtendedReportDump
LrleExtendedReportDump: ExtendedReportDump & {
beginSeq: number;
chunks: number[];
endSeq: number;
ssrc: number;
thinning: number;
}
beginSeq: number;
chunks: number[];
endSeq: number;
ssrc: number;
thinning: number;
}
Loss RLE Extended Report dump.
-Type Alias NackPacketDump
RTCP NACK packet info dump.
-Type Alias PacketDump
Packet info dump.
-
diff --git a/docs/types/packets.PrtExtendedReportDump.html b/docs/types/packets.PrtExtendedReportDump.html
deleted file mode 100644
index c8a86e80..00000000
--- a/docs/types/packets.PrtExtendedReportDump.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias PrtExtendedReportDump
PrtExtendedReportDump: ExtendedReportDump & {
beginSeq: number;
endSeq: number;
receiptTimes: number[];
ssrc: number;
thinning: number;
}
beginSeq: number;
endSeq: number;
receiptTimes: number[];
ssrc: number;
thinning: number;
}
Packet Receipt Times Extended Report dump.
-Type Alias ReceiverReportPacketDump
RTCP Receiver Report packet info dump.
-Type Alias ReceptionReportDump
ReceptionReportDump: SerializableDump & {
dlsr: number;
fractionLost: number;
highestSeq: number;
jitter: number;
lsr: number;
ssrc: number;
totalLost: number;
}
dlsr: number;
fractionLost: number;
highestSeq: number;
jitter: number;
lsr: number;
ssrc: number;
totalLost: number;
}
Reception Report dump.
-Type Alias RpsiPacketDump
RpsiPacketDump: FeedbackPacketDump & {
bitStringLength: number;
paddingBits: number;
payloadType: number;
}
bitStringLength: number;
paddingBits: number;
payloadType: number;
}
RTCP RPSI packet info dump.
-Type Alias RrtExtendedReportDump
Receiver Reference Time Extended Report dump.
-Type Alias RtcpPacketDump
Base RTCP packet info dump.
-Type Alias RtpExtensionMapping
Mapping of RTP extension types and their corresponding RTP extension ids.
-Type Alias RtpPacketDump
RtpPacketDump: PacketDump & {
absSendTimeExt?: number;
csrcs: number[];
extensions: { id: number; length: number }[];
headerExtensionId?: number;
marker: boolean;
midExt?: string;
payloadLength: number;
payloadType: number;
repairedRidExt?: string;
ridExt?: string;
sequenceNumber: number;
ssrc: number;
ssrcAudioLevelExt?: SsrcAudioLevelExtension;
timestamp: number;
transmissionOffsetExt?: number;
transportWideSeqNumberExt?: number;
videoOrientationExt?: VideoOrientationExtension;
}
absSendTimeExt?: number;
csrcs: number[];
extensions: { id: number; length: number }[];
headerExtensionId?: number;
marker: boolean;
midExt?: string;
payloadLength: number;
payloadType: number;
repairedRidExt?: string;
ridExt?: string;
sequenceNumber: number;
ssrc: number;
ssrcAudioLevelExt?: SsrcAudioLevelExtension;
timestamp: number;
transmissionOffsetExt?: number;
transportWideSeqNumberExt?: number;
videoOrientationExt?: VideoOrientationExtension;
}
RTP packet info dump.
-Type Alias SdesChunkDump
SDES Chunk dump.
-Type Alias SdesPacketDump
RTCP SDES packet info dump.
-Type Alias SenderReportPacketDump
SenderReportPacketDump: RtcpPacketDump & {
ntpFraction: number;
ntpSeq: number;
octetCount: number;
packetCount: number;
reports: ReceptionReportDump[];
rtpTimestamp: number;
ssrc: number;
}
ntpFraction: number;
ntpSeq: number;
octetCount: number;
packetCount: number;
reports: ReceptionReportDump[];
rtpTimestamp: number;
ssrc: number;
}
RTCP Sender Report packet info dump.
-
diff --git a/docs/types/packets.SliPacketDump.html b/docs/types/packets.SliPacketDump.html
deleted file mode 100644
index 2ab1ab1a..00000000
--- a/docs/types/packets.SliPacketDump.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias SliPacketDump
SliPacketDump: FeedbackPacketDump & {
items: { first: number; number: number; pictureId: number }[];
}
items: { first: number; number: number; pictureId: number }[];
}
RTCP SLI packet info dump.
-
diff --git a/docs/types/packets.SsExtendedReportDump.html b/docs/types/packets.SsExtendedReportDump.html
deleted file mode 100644
index 3aa9fde7..00000000
--- a/docs/types/packets.SsExtendedReportDump.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias SsExtendedReportDump
SsExtendedReportDump: ExtendedReportDump & {
beginSeq: number;
devJitter?: number;
devTtlOrHl?: number;
duplicatePackets?: number;
endSeq: number;
lostPackets?: number;
maxJitter?: number;
maxTtlOrHl?: number;
meanJitter?: number;
meanTtlOrHl?: number;
minJitter?: number;
minTtlOrHl?: number;
ssrc: number;
ttlOrHlMode?: "ipv4-ttl" | "ipv6-hop-limit";
}
beginSeq: number;
devJitter?: number;
devTtlOrHl?: number;
duplicatePackets?: number;
endSeq: number;
lostPackets?: number;
maxJitter?: number;
maxTtlOrHl?: number;
meanJitter?: number;
meanTtlOrHl?: number;
minJitter?: number;
minTtlOrHl?: number;
ssrc: number;
ttlOrHlMode?: "ipv4-ttl" | "ipv6-hop-limit";
}
Statistics Summary Extended Report dump.
-Type Alias SsrcAudioLevelExtension
SsrcAudioLevelExtension: { voice: boolean; volume: number }
SSRC Audio Level data.
-Type declaration
See
-
-
- RFC 6464 -
diff --git a/docs/types/packets.VmExtendedReportDump.html b/docs/types/packets.VmExtendedReportDump.html
deleted file mode 100644
index d82fd083..00000000
--- a/docs/types/packets.VmExtendedReportDump.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Type Alias VmExtendedReportDump
VmExtendedReportDump: ExtendedReportDump & {
burstDensity: number;
burstDuration: number;
discardRate: number;
endSystemDelay: number;
extRFactor: number;
gapDensity: number;
gapDuration: number;
gmin: number;
jba: number;
jbAbsMax: number;
jbMax: number;
jbNominal: number;
jbRate: number;
lossRate: number;
mosCq: number;
mosLq: number;
noiseLevel: number;
plc: number;
rerl: number;
rFactor: number;
roundTripDelay: number;
signalLevel: number;
ssrc: number;
}
burstDensity: number;
burstDuration: number;
discardRate: number;
endSystemDelay: number;
extRFactor: number;
gapDensity: number;
gapDuration: number;
gmin: number;
jba: number;
jbAbsMax: number;
jbMax: number;
jbNominal: number;
jbRate: number;
lossRate: number;
mosCq: number;
mosLq: number;
noiseLevel: number;
plc: number;
rerl: number;
rFactor: number;
roundTripDelay: number;
signalLevel: number;
ssrc: number;
}
VoIP Metrics Extended Report dump.
-Type Alias XrPacketDump
RTCP XR packet info dump.
-
RTCP BYE packet.
- - -See
-- RFC 3550 section 6.6
-
-