FMLiveSwitchRtpPacket Class Reference

An RTP packet. More...

Instance Methods

(FMLiveSwitchDataBuffer *) - buffer
 Gets the buffer. More...
 
(int) - contributingSourceCount
 Gets the number of contributingSources. More...
 
(NSMutableArray *) - contributingSources
 Gets the contributing sources. More...
 
(int) - contributingSourcesLength
 Gets the length of the contributingSources in bytes. More...
 
(int) - contributingSourcesOffset
 Gets the offset of the contributingSources array. More...
 
(bool) - extension
 Gets a value indicating whether this FMLiveSwitchRtpPacket has a header extension. More...
 
(FMLiveSwitchDataBuffer *) - header
 Gets the header. More...
 
(FMLiveSwitchDataBuffer *) - headerExtension
 Gets the header extension. More...
 
(int) - headerExtensionId
 Gets the header extension ID. More...
 
(int) - headerExtensionLength
 Gets the length of the headerExtension in bytes. More...
 
(int) - headerExtensionOffset
 Gets the offset of the headerExtensionId. More...
 
(int) - headerLength
 Gets the length of the fixed and variable headers. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchRtpPacket class. More...
 
(instancetype) - initWithPayload:
 Initializes a new instance of the FMLiveSwitchRtpPacket class. More...
 
(bool) - marker
 Gets a value indicating whether this FMLiveSwitchRtpPacket has the marker flag set. More...
 
(bool) - padding
 Gets a value indicating whether this FMLiveSwitchRtpPacket is padded. More...
 
(int) - paddingLength
 Gets the padding length. More...
 
(FMLiveSwitchDataBuffer *) - payload
 Gets the packet payload. More...
 
(int) - payloadLength
 Gets the length of the payload. More...
 
(int) - payloadOffset
 Gets the offset of the payload. More...
 
(int) - payloadType
 Gets the payload type. More...
 
(int) - sequenceNumber
 Gets the sequence number. More...
 
(void) - setContributingSources:
 Sets the contributing sources. More...
 
(void) - setHeaderExtension:
 Sets the header extension. More...
 
(void) - setHeaderExtensionId:
 Sets the header extension ID. More...
 
(void) - setMarker:
 Sets a value indicating whether this FMLiveSwitchRtpPacket has the marker flag set. More...
 
(void) - setPadding:
 Sets a value indicating whether this FMLiveSwitchRtpPacket is padded. More...
 
(void) - setPayload:
 Sets the packet payload. More...
 
(void) - setPayloadType:
 Sets the payload type. More...
 
(void) - setSequenceNumber:
 Sets the sequence number. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(void) - setTimestamp:
 Sets the timestamp. More...
 
(void) - setVersion:
 Sets the version. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 
(long long) - timestamp
 Gets the timestamp. More...
 
(int) - variableHeaderLength
 Gets the length of the variable header. More...
 
(int) - version
 Gets the version. More...
 

Class Methods

(int) + fixedHeaderLength
 Gets the length of the fixed header. More...
 
(int) + getSequenceNumberDeltaWithSequenceNumber:lastSequenceNumber:
 Retrieves the difference between two sequence numbers while accounting for overflow rollover. More...
 
(FMLiveSwitchRtpPacket *) + rtpPacket
 Initializes a new instance of the FMLiveSwitchRtpPacket class. More...
 
(FMLiveSwitchRtpPacket *) + rtpPacketWithPayload:
 Initializes a new instance of the FMLiveSwitchRtpPacket class. More...
 
(FMLiveSwitchRtpPacket *) + wrapWithBuffer:
 Parses the specified buffer. More...
 

Detailed Description

An RTP packet.

Method Documentation

◆ buffer

Gets the buffer.

◆ contributingSourceCount

- (int) contributingSourceCount

Gets the number of contributingSources.

◆ contributingSources

- (NSMutableArray*) contributingSources

Gets the contributing sources.

◆ contributingSourcesLength

- (int) contributingSourcesLength

Gets the length of the contributingSources in bytes.

◆ contributingSourcesOffset

- (int) contributingSourcesOffset

Gets the offset of the contributingSources array.

◆ extension

- (bool) extension

Gets a value indicating whether this FMLiveSwitchRtpPacket has a header extension.

If the extension bit is set, the fixed header MUST be followed by exactly one header extension.

◆ fixedHeaderLength

+ (int) fixedHeaderLength

Gets the length of the fixed header.

◆ getSequenceNumberDeltaWithSequenceNumber:lastSequenceNumber:

+ (int) getSequenceNumberDeltaWithSequenceNumber: (int)  sequenceNumber
lastSequenceNumber: (int)  lastSequenceNumber 

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

Parameters
sequenceNumberThe current sequence number.
lastSequenceNumberThe last (previous) sequence number.
Returns
The difference between the two sequence numbers.

◆ header

Gets the header.

◆ headerExtension

- (FMLiveSwitchDataBuffer*) headerExtension

Gets the header extension.

◆ headerExtensionId

- (int) headerExtensionId

Gets the header extension ID.

◆ headerExtensionLength

- (int) headerExtensionLength

Gets the length of the headerExtension in bytes.

◆ headerExtensionOffset

- (int) headerExtensionOffset

Gets the offset of the headerExtensionId.

◆ headerLength

- (int) headerLength

Gets the length of the fixed and variable headers.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchRtpPacket class.

◆ initWithPayload:

- (instancetype) initWithPayload: (FMLiveSwitchDataBuffer *)  payload

Initializes a new instance of the FMLiveSwitchRtpPacket class.

Parameters
payloadThe payload for the RTP packet.

◆ marker

- (bool) marker

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

◆ padding

- (bool) padding

Gets a value indicating whether this FMLiveSwitchRtpPacket is padded.

◆ paddingLength

- (int) paddingLength

Gets the padding length.

◆ payload

- (FMLiveSwitchDataBuffer*) payload

Gets the packet payload.

◆ payloadLength

- (int) payloadLength

Gets the length of the payload.

◆ payloadOffset

- (int) payloadOffset

Gets the offset of the payload.

◆ payloadType

- (int) payloadType

Gets the payload type.

◆ rtpPacket

+ (FMLiveSwitchRtpPacket*) rtpPacket

Initializes a new instance of the FMLiveSwitchRtpPacket class.

◆ rtpPacketWithPayload:

+ (FMLiveSwitchRtpPacket*) rtpPacketWithPayload: (FMLiveSwitchDataBuffer *)  payload

Initializes a new instance of the FMLiveSwitchRtpPacket class.

Parameters
payloadThe payload for the RTP packet.

◆ sequenceNumber

- (int) sequenceNumber

Gets the sequence number.

◆ setContributingSources:

- (void) setContributingSources: (NSMutableArray *)  value

Sets the contributing sources.

◆ setHeaderExtension:

- (void) setHeaderExtension: (FMLiveSwitchDataBuffer *)  value

Sets the header extension.

◆ setHeaderExtensionId:

- (void) setHeaderExtensionId: (int)  value

Sets the header extension ID.

◆ setMarker:

- (void) setMarker: (bool)  value

Sets a value indicating whether this FMLiveSwitchRtpPacket has the marker flag set.

◆ setPadding:

- (void) setPadding: (bool)  value

Sets a value indicating whether this FMLiveSwitchRtpPacket is padded.

◆ setPayload:

- (void) setPayload: (FMLiveSwitchDataBuffer *)  value

Sets the packet payload.

◆ setPayloadType:

- (void) setPayloadType: (int)  value

Sets the payload type.

◆ setSequenceNumber:

- (void) setSequenceNumber: (int)  value

Sets the sequence number.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the synchronization source.

◆ setTimestamp:

- (void) setTimestamp: (long long)  value

Sets the timestamp.

◆ setVersion:

- (void) setVersion: (int)  value

Sets 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.)

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.

◆ timestamp

- (long long) timestamp

Gets the timestamp.

◆ variableHeaderLength

- (int) variableHeaderLength

Gets the length of the variable header.

◆ version

- (int) 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.)

◆ wrapWithBuffer:

+ (FMLiveSwitchRtpPacket*) wrapWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Parses the specified buffer.

Parameters
bufferThe buffer.
Returns
Rtp.Packet