FMIceLinkRtpPacket Class Reference

Inherits from NSObject
Declared in FMIceLinkRtpPacket.h
FMIceLinkRtpPacket.m

Overview

An RTP packet Fixed Header fileds: 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](#//api/name/timestamp) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | synchronization source(SSRC) identifier | +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+ | contributing source(CSRC) identifiers | | .... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

– buffer

Gets the buffer.
- (FMIceLinkDataBuffer *)buffer

Discussion

Gets the buffer.

Declared In

FMIceLinkRtpPacket.h

– contributingSourceCount

Gets the number of FMIceLinkRtpPacket#[contributingSources](#//api/name/contributingSources).
- (int)contributingSourceCount

Discussion

Gets the number of FMIceLinkRtpPacket#[contributingSources](#//api/name/contributingSources).

Declared In

FMIceLinkRtpPacket.h

– contributingSources

Gets the contributing sources.
- (NSMutableArray *)contributingSources

Discussion

Gets the contributing sources.

Declared In

FMIceLinkRtpPacket.h

– contributingSourcesLength

Gets the length of the FMIceLinkRtpPacket#[contributingSources](#//api/name/contributingSources) in bytes.
- (int)contributingSourcesLength

Discussion

Gets the length of the FMIceLinkRtpPacket#[contributingSources](#//api/name/contributingSources) in bytes.

Declared In

FMIceLinkRtpPacket.h

– contributingSourcesOffset

Gets the offset of the FMIceLinkRtpPacket#[contributingSources](#//api/name/contributingSources) array.
- (int)contributingSourcesOffset

Discussion

Gets the offset of the FMIceLinkRtpPacket#[contributingSources](#//api/name/contributingSources) array.

Declared In

FMIceLinkRtpPacket.h

– extension

Gets a value indicating whether this FMIceLinkRtpPacket has a [header](#//api/name/header) extension. If the extension bit is set, the fixed [header](#//api/name/header) MUST be followed by exactly one [header](#//api/name/header) extension.
- (bool)extension

Discussion

Gets a value indicating whether this FMIceLinkRtpPacket has a [header](#//api/name/header) extension. If the extension bit is set, the fixed [header](#//api/name/header) MUST be followed by exactly one [header](#//api/name/header) extension.

Declared In

FMIceLinkRtpPacket.h

+ fixedHeaderLength

Gets the length of the fixed [header](#//api/name/header).
+ (int)fixedHeaderLength

Discussion

Gets the length of the fixed [header](#//api/name/header).

Declared In

FMIceLinkRtpPacket.h

+ getSequenceNumberDeltaWithSequenceNumber:lastSequenceNumber:

Retrieves the difference between two sequence numbers while accounting for overflow rollover.
+ (int)getSequenceNumberDeltaWithSequenceNumber:(int)sequenceNumber lastSequenceNumber:(int)lastSequenceNumber

Parameters

sequenceNumber

The current sequence number.
lastSequenceNumber

The last (previous) sequence number.

Return Value

The difference between the two sequence numbers.

Discussion

Retrieves the difference between two sequence numbers while accounting for overflow rollover.

Declared In

FMIceLinkRtpPacket.h

– header

Gets the header.
- (FMIceLinkDataBuffer *)header

Discussion

Gets the header.

Declared In

FMIceLinkRtpPacket.h

– headerExtension

Gets the [header](#//api/name/header) [extension](#//api/name/extension).
- (FMIceLinkDataBuffer *)headerExtension

Discussion

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

Declared In

FMIceLinkRtpPacket.h

– headerExtensionId

Gets the [header](#//api/name/header) [extension](#//api/name/extension) ID.
- (int)headerExtensionId

Discussion

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

Declared In

FMIceLinkRtpPacket.h

– headerExtensionLength

Gets the length of the FMIceLinkRtpPacket#[headerExtension](#//api/name/headerExtension) in bytes.
- (int)headerExtensionLength

Discussion

Gets the length of the FMIceLinkRtpPacket#[headerExtension](#//api/name/headerExtension) in bytes.

Declared In

FMIceLinkRtpPacket.h

– headerExtensionOffset

Gets the offset of the FMIceLinkRtpPacket#[headerExtensionId](#//api/name/headerExtensionId).
- (int)headerExtensionOffset

Discussion

Gets the offset of the FMIceLinkRtpPacket#[headerExtensionId](#//api/name/headerExtensionId).

Declared In

FMIceLinkRtpPacket.h

– headerLength

Gets the length of the fixed and variable headers.
- (int)headerLength

Discussion

Gets the length of the fixed and variable headers.

Declared In

FMIceLinkRtpPacket.h

– init

Initializes a new instance of the FMIceLinkRtpPacket class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkRtpPacket class.

Declared In

FMIceLinkRtpPacket.h

– initWithPayload:

Initializes a new instance of the FMIceLinkRtpPacket class.
- (instancetype)initWithPayload:(FMIceLinkDataBuffer *)payload

Parameters

payload

The payload for the RTP packet.

Discussion

Initializes a new instance of the FMIceLinkRtpPacket class.

Declared In

FMIceLinkRtpPacket.h

– marker

Gets a value indicating whether this FMIceLinkRtpPacket has the marker flag set.
- (bool)marker

Discussion

Gets a value indicating whether this FMIceLinkRtpPacket has the marker flag set.

Declared In

FMIceLinkRtpPacket.h

– padding

Gets a value indicating whether this FMIceLinkRtpPacket is padded.
- (bool)padding

Discussion

Gets a value indicating whether this FMIceLinkRtpPacket is padded.

Declared In

FMIceLinkRtpPacket.h

– paddingLength

Gets the [padding](#//api/name/padding) length.
- (int)paddingLength

Discussion

Gets the [padding](#//api/name/padding) length.

Declared In

FMIceLinkRtpPacket.h

– payload

Gets the packet payload.
- (FMIceLinkDataBuffer *)payload

Discussion

Gets the packet payload.

Declared In

FMIceLinkRtpPacket.h

– payloadLength

Gets the length of the FMIceLinkRtpPacket#[payload](#//api/name/payload).
- (int)payloadLength

Discussion

Gets the length of the FMIceLinkRtpPacket#[payload](#//api/name/payload).

Declared In

FMIceLinkRtpPacket.h

– payloadOffset

Gets the offset of the FMIceLinkRtpPacket#[payload](#//api/name/payload).
- (int)payloadOffset

Discussion

Gets the offset of the FMIceLinkRtpPacket#[payload](#//api/name/payload).

Declared In

FMIceLinkRtpPacket.h

– payloadType

Gets the [payload](#//api/name/payload) type.
- (int)payloadType

Discussion

Gets the [payload](#//api/name/payload) type.

Declared In

FMIceLinkRtpPacket.h

+ rtpPacket

Initializes a new instance of the FMIceLinkRtpPacket class.
+ (FMIceLinkRtpPacket *)rtpPacket

Discussion

Initializes a new instance of the FMIceLinkRtpPacket class.

Declared In

FMIceLinkRtpPacket.h

+ rtpPacketWithPayload:

Initializes a new instance of the FMIceLinkRtpPacket class.
+ (FMIceLinkRtpPacket *)rtpPacketWithPayload:(FMIceLinkDataBuffer *)payload

Parameters

payload

The payload for the RTP packet.

Discussion

Initializes a new instance of the FMIceLinkRtpPacket class.

Declared In

FMIceLinkRtpPacket.h

– sequenceNumber

Gets the sequence number.
- (int)sequenceNumber

Discussion

Gets the sequence number.

Declared In

FMIceLinkRtpPacket.h

– setContributingSources:

Sets the contributing sources.
- (void)setContributingSources:(NSMutableArray *)value

Discussion

Sets the contributing sources.

Declared In

FMIceLinkRtpPacket.h

– setHeaderExtension:

Sets the [header](#//api/name/header) [extension](#//api/name/extension).
- (void)setHeaderExtension:(FMIceLinkDataBuffer *)value

Discussion

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

Declared In

FMIceLinkRtpPacket.h

– setHeaderExtensionId:

Sets the [header](#//api/name/header) [extension](#//api/name/extension) ID.
- (void)setHeaderExtensionId:(int)value

Discussion

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

Declared In

FMIceLinkRtpPacket.h

– setMarker:

Sets a value indicating whether this FMIceLinkRtpPacket has the [marker](#//api/name/marker) flag set.
- (void)setMarker:(bool)value

Discussion

Sets a value indicating whether this FMIceLinkRtpPacket has the [marker](#//api/name/marker) flag set.

Declared In

FMIceLinkRtpPacket.h

– setPadding:

Sets a value indicating whether this FMIceLinkRtpPacket is padded.
- (void)setPadding:(bool)value

Discussion

Sets a value indicating whether this FMIceLinkRtpPacket is padded.

Declared In

FMIceLinkRtpPacket.h

– setPayload:

Sets the packet [payload](#//api/name/payload).
- (void)setPayload:(FMIceLinkDataBuffer *)value

Discussion

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

Declared In

FMIceLinkRtpPacket.h

– setPayloadType:

Sets the [payload](#//api/name/payload) type.
- (void)setPayloadType:(int)value

Discussion

Sets the [payload](#//api/name/payload) type.

Declared In

FMIceLinkRtpPacket.h

– setSequenceNumber:

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

Discussion

Sets the sequence number.

Declared In

FMIceLinkRtpPacket.h

– setSynchronizationSource:

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

Discussion

Sets the synchronization source.

Declared In

FMIceLinkRtpPacket.h

– setTimestamp:

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

Discussion

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

Declared In

FMIceLinkRtpPacket.h

– setVersion:

Sets the [version](#//api/name/version). This field identifies the [version](#//api/name/version) of RTP. The [version](#//api/name/version) defined by this specification is two(2). (The value 1 is used by the first draft [version](#//api/name/version) of RTP and the value 0 is used by the protocol initially implemented in the "vat" audio tool.)
- (void)setVersion:(int)value

Discussion

Sets the [version](#//api/name/version). This field identifies the [version](#//api/name/version) of RTP. The [version](#//api/name/version) defined by this specification is two(2). (The value 1 is used by the first draft [version](#//api/name/version) of RTP and the value 0 is used by the protocol initially implemented in the "vat" audio tool.)

Declared In

FMIceLinkRtpPacket.h

– synchronizationSource

Gets the synchronization source.
- (long long)synchronizationSource

Discussion

Gets the synchronization source.

Declared In

FMIceLinkRtpPacket.h

– timestamp

Gets the timestamp.
- (long long)timestamp

Discussion

Gets the timestamp.

Declared In

FMIceLinkRtpPacket.h

– variableHeaderLength

Gets the length of the variable [header](#//api/name/header).
- (int)variableHeaderLength

Discussion

Gets the length of the variable [header](#//api/name/header).

Declared In

FMIceLinkRtpPacket.h

– version

Gets the version. This field identifies the version of RTP. The version defined by this specification is two(2). (The value 1 is used by the first draft version of RTP and the value 0 is used by the protocol initially implemented in the "vat" audio tool.)
- (int)version

Discussion

Gets the version. This field identifies the version of RTP. The version defined by this specification is two(2). (The value 1 is used by the first draft version of RTP and the value 0 is used by the protocol initially implemented in the "vat" audio tool.)

Declared In

FMIceLinkRtpPacket.h

+ wrapWithBuffer:

Parses the specified [buffer](#//api/name/buffer).
+ (FMIceLinkRtpPacket *)wrapWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

buffer

The buffer.

Return Value

Rtp.Packet

Discussion

Parses the specified [buffer](#//api/name/buffer).

Declared In

FMIceLinkRtpPacket.h