FMIceLinkRtpPacketHeader Class Reference

Inherits from NSObject
Declared in FMIceLinkRtpPacketHeader.h
FMIceLinkRtpPacketHeader.m

Overview

The header of an Rtp packet.

– calculateHeaderLength

Calculates the length of the header. At least 12 bytes.
- (int)calculateHeaderLength

Discussion

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

Declared In

FMIceLinkRtpPacketHeader.h

– clone

Clones this RtpPacketHeader instance.
- (FMIceLinkRtpPacketHeader *)clone

Discussion

Clones this RtpPacketHeader instance.

Declared In

FMIceLinkRtpPacketHeader.h

– contributingSourceCount

Gets the number of contributing sources added to this rtp packet.
- (int)contributingSourceCount

Discussion

Gets the number of contributing sources added to this rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

– contributingSources

Gets the contributing sources in this rtp packet.
- (NSMutableArray *)contributingSources

Discussion

Gets the contributing sources in this rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

– extension

Gets if there is an extension added to this rtp packet.
- (bool)extension

Discussion

Gets if there is an extension added to this rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

+ fixedHeaderLength

Gets the length of the fixed header.
+ (int)fixedHeaderLength

Discussion

Gets the length of the fixed header.

Declared In

FMIceLinkRtpPacketHeader.h

– headerExtension

Gets the header [extension](#//api/name/extension).
- (NSObject<FMIceLinkIRtpHeaderExtension> *)headerExtension

Discussion

Gets the header [extension](#//api/name/extension).

Declared In

FMIceLinkRtpPacketHeader.h

– init

Creates a new instance of the Packet Header.
- (instancetype)init

Discussion

Creates a new instance of the Packet Header.

Declared In

FMIceLinkRtpPacketHeader.h

– marker

Gets if the marker bit is set.
- (bool)marker

Discussion

Gets if the marker bit is set.

Declared In

FMIceLinkRtpPacketHeader.h

– padding

Gets if this rtp packet has padding.
- (bool)padding

Discussion

Gets if this rtp packet has padding.

Declared In

FMIceLinkRtpPacketHeader.h

– paddingLength

Gets the number of bytes of [padding](#//api/name/padding) of the decoded rtp packet.
- (int)paddingLength

Discussion

Gets the number of bytes of [padding](#//api/name/padding) of the decoded rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

– payloadType

Gets the payload type of this rtp packet.
- (int)payloadType

Discussion

Gets the payload type of this rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

+ readFromWithBuffer:

Parses the Rtp header from a DataBuffer. If [padding](#//api/name/padding) exists, also calculates the [padding](#//api/name/padding) length.
+ (FMIceLinkRtpPacketHeader *)readFromWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

buffer

The DataBuffer containing the header and payload.

Discussion

Parses the Rtp header from a DataBuffer. If [padding](#//api/name/padding) exists, also calculates the [padding](#//api/name/padding) length.

Declared In

FMIceLinkRtpPacketHeader.h

+ rtpPacketHeader

Creates a new instance of the Packet Header.
+ (FMIceLinkRtpPacketHeader *)rtpPacketHeader

Discussion

Creates a new instance of the Packet Header.

Declared In

FMIceLinkRtpPacketHeader.h

– sequenceNumber

Gets the sequence number of the packet.
- (int)sequenceNumber

Discussion

Gets the sequence number of the packet.

Declared In

FMIceLinkRtpPacketHeader.h

– setContributingSourceCount:

Sets the number of contributing sources added to this rtp packet.
- (void)setContributingSourceCount:(int)value

Discussion

Sets the number of contributing sources added to this rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

– setContributingSources:

Sets the contributing sources in this rtp packet.
- (void)setContributingSources:(NSMutableArray *)value

Discussion

Sets the contributing sources in this rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

– setHeaderExtension:

Sets the header [extension](#//api/name/extension).
- (void)setHeaderExtension:(NSObject<FMIceLinkIRtpHeaderExtension> *)value

Discussion

Sets the header [extension](#//api/name/extension).

Declared In

FMIceLinkRtpPacketHeader.h

– setMarker:

Sets if the [marker](#//api/name/marker) bit is set.
- (void)setMarker:(bool)value

Discussion

Sets if the [marker](#//api/name/marker) bit is set.

Declared In

FMIceLinkRtpPacketHeader.h

– setPadding:

Sets if this rtp packet has [padding](#//api/name/padding).
- (void)setPadding:(bool)value

Discussion

Sets if this rtp packet has [padding](#//api/name/padding).

Declared In

FMIceLinkRtpPacketHeader.h

– setPayloadType:

Sets the payload type of this rtp packet.
- (void)setPayloadType:(int)value

Discussion

Sets the payload type of this rtp packet.

Declared In

FMIceLinkRtpPacketHeader.h

– setSequenceNumber:

Sets the sequence number of the packet.
- (void)setSequenceNumber:(int)value

Discussion

Sets the sequence number of the packet.

Declared In

FMIceLinkRtpPacketHeader.h

– setSynchronizationSource:

Sets the synchronization source source of the packet.
- (void)setSynchronizationSource:(long long)value

Discussion

Sets the synchronization source source of the packet.

Declared In

FMIceLinkRtpPacketHeader.h

– setTimestamp:

Sets the [timestamp](#//api/name/timestamp) of the packet.
- (void)setTimestamp:(long long)value

Discussion

Sets the [timestamp](#//api/name/timestamp) of the packet.

Declared In

FMIceLinkRtpPacketHeader.h

– setVersion:

Sets the [version](#//api/name/version) of the rtp packet. Should be 2.
- (void)setVersion:(int)value

Discussion

Sets the [version](#//api/name/version) of the rtp packet. Should be 2.

Declared In

FMIceLinkRtpPacketHeader.h

– synchronizationSource

Gets the synchronization source source of the packet.
- (long long)synchronizationSource

Discussion

Gets the synchronization source source of the packet.

Declared In

FMIceLinkRtpPacketHeader.h

– timestamp

Gets the timestamp of the packet.
- (long long)timestamp

Discussion

Gets the timestamp of the packet.

Declared In

FMIceLinkRtpPacketHeader.h

– version

Gets the version of the rtp packet. Should be 2.
- (int)version

Discussion

Gets the version of the rtp packet. Should be 2.

Declared In

FMIceLinkRtpPacketHeader.h

– writeToWithBuffer:offset:

Writes this Rtp packet to a DataBuffer starting at the offset.

@param buffer @param offset

- (void)writeToWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset

Discussion

Writes this Rtp packet to a DataBuffer starting at the offset.

@param buffer @param offset

Declared In

FMIceLinkRtpPacketHeader.h