/ fm / liveswitch / RtpPacketHeader

Class: RtpPacketHeader

fm.liveswitch.RtpPacketHeader

An RTP packet header.

Table of contents

Constructors

Methods

Constructors

constructor

+ new RtpPacketHeader(): RtpPacketHeader

Creates a new instance of the [[fm.liveswitch.rtpPacketHeader]] class.

Returns: RtpPacketHeader

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:49

Methods

calculateHeaderLength

▸ calculateHeaderLength(): number

Calculates the length of the header. At least 12 bytes.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:89

clone

▸ clone(): RtpPacketHeader

Clones this instance.

Returns: RtpPacketHeader

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:105

fmliveswitchRtpPacketHeaderInit

▸ PrivatefmliveswitchRtpPacketHeaderInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:37

getContributingSourceCount

▸ getContributingSourceCount(): number

Gets the number of contributing sources.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:129

getContributingSources

▸ getContributingSources(): number[]

Gets the contributing sources.

Returns: number[]

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:141

getExtension

▸ getExtension(): boolean

Gets if there is an extension.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:153

getHeaderExtension

▸ getHeaderExtension(): IRtpHeaderExtension

Gets the header extension.

Returns: IRtpHeaderExtension

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:165

getMarker

▸ getMarker(): boolean

Gets if the marker bit is set.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:177

getPadding

▸ getPadding(): boolean

Gets if the packet has padding.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:189

getPaddingLength

▸ getPaddingLength(): number

Gets the number of bytes of padding.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:201

getPayloadType

▸ getPayloadType(): number

Gets the payload type.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:213

getSequenceNumber

▸ getSequenceNumber(): number

Gets the sequence number.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:225

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets the synchronization source.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:237

getTimestamp

▸ getTimestamp(): number

Gets the timestamp.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:249

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:9

getVersion

▸ getVersion(): number

Gets the version of the packet. Should be 2.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:261

setContributingSourceCount

▸ setContributingSourceCount(value: number): void

Sets the number of contributing sources.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:273

setContributingSources

▸ setContributingSources(value: number[]): void

Sets the contributing sources.

Parameters:

Name Type
value number[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:286

setHeaderExtension

▸ setHeaderExtension(value: IRtpHeaderExtension): void

Sets the header extension.

Parameters:

Name Type
value IRtpHeaderExtension

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:306

setMarker

▸ setMarker(value: boolean): void

Sets if the marker bit is set.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:324

setPadding

▸ setPadding(value: boolean): void

Sets if the packet has padding.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:336

setPayloadType

▸ setPayloadType(value: number): void

Sets the payload type.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:357

setSequenceNumber

▸ setSequenceNumber(value: number): void

Sets the sequence number.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:370

setSynchronizationSource

▸ setSynchronizationSource(value: number): void

Sets the synchronization source.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:383

setTimestamp

▸ setTimestamp(value: number): void

Sets the timestamp.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:396

setVersion

▸ setVersion(value: number): void

Sets the version of the packet. Should be 2.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:409

writeTo

▸ writeTo(buffer: DataBuffer, offset: number): void

Writes this header to a buffer starting at the offset.

Parameters:

Name Type Description
buffer DataBuffer The target buffer.
offset number The starting offset.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:424

getFixedHeaderLength

▸ StaticgetFixedHeaderLength(): number

Gets the length of the fixed header.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/RtpPacketHeader.ts:77