FMIceLinkMediaFrame Class Reference

Inherits from FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to TBuffer
TBufferCollection
TFormat
TFrame
__covariant
Declared in FMIceLinkMediaFrame.h
FMIceLinkMediaFrame.m

Overview

A media frame.

The type of the buffer.The type of the buffer collection.The type of the format.The type of the frame.

– addBuffer:

Adds a [buffer](#//api/name/buffer).
- (void)addBuffer:(TBuffer)buffer

Parameters

buffer

The buffer.

Discussion

Adds a [buffer](#//api/name/buffer).

Declared In

FMIceLinkMediaFrame.h

– addBuffers:

Adds some [buffers](#//api/name/buffers).
- (void)addBuffers:(NSMutableArray *)buffers

Parameters

buffers

The buffers.

Discussion

Adds some [buffers](#//api/name/buffers).

Declared In

FMIceLinkMediaFrame.h

– buffer

Gets the buffer.
- (TBuffer)buffer

Discussion

Gets the buffer.

Declared In

FMIceLinkMediaFrame.h

– buffers

Gets the buffers.
- (NSMutableArray *)buffers

Discussion

Gets the buffers.

Declared In

FMIceLinkMediaFrame.h

– clone

Clones this instance.
- (TFrame)clone

Discussion

Clones this instance.

Declared In

FMIceLinkMediaFrame.h

– contributingSources

Gets the contributing sources.
- (NSMutableArray *)contributingSources

Discussion

Gets the contributing sources.

Declared In

FMIceLinkMediaFrame.h

– createInstance

Creates a new instance.
- (TFrame)createInstance

Discussion

Creates a new instance.

Declared In

FMIceLinkMediaFrame.h

– createMediaBufferCollection

Creates a media [buffer](#//api/name/buffer) collection.
- (TBufferCollection)createMediaBufferCollection

Discussion

Creates a media [buffer](#//api/name/buffer) collection.

Declared In

FMIceLinkMediaFrame.h

– getBufferWithFormat:

Gets the last [buffer](#//api/name/buffer) whose format is equivalent to the specified format.
- (TBuffer)getBufferWithFormat:(TFormat)format

Parameters

format

The format.

Discussion

Gets the last [buffer](#//api/name/buffer) whose format is equivalent to the specified format.

Declared In

FMIceLinkMediaFrame.h

– getBufferWithFormat:sourceId:

Gets the last [buffer](#//api/name/buffer) whose format is equivalent to the specified format and whose source ID matches the specified source ID.
- (TBuffer)getBufferWithFormat:(TFormat)format sourceId:(NSString *)sourceId

Parameters

format

The format.
sourceId

The source identifier.

Discussion

Gets the last [buffer](#//api/name/buffer) whose format is equivalent to the specified format and whose source ID matches the specified source ID.

Declared In

FMIceLinkMediaFrame.h

– getBufferWithFormatName:

Gets the last [buffer](#//api/name/buffer) whose format name matches the specified format name.
- (TBuffer)getBufferWithFormatName:(NSString *)formatName

Parameters

formatName

The format name.

Discussion

Gets the last [buffer](#//api/name/buffer) whose format name matches the specified format name.

Declared In

FMIceLinkMediaFrame.h

– getBufferWithIsPacketized:

Gets the last [buffer](#//api/name/buffer) whose format packetization flag matches the specified flag.
- (TBuffer)getBufferWithIsPacketized:(bool)isPacketized

Parameters

isPacketized

Whether the buffer is packetized.

Discussion

Gets the last [buffer](#//api/name/buffer) whose format packetization flag matches the specified flag.

Declared In

FMIceLinkMediaFrame.h

– getBufferWithIsPacketized:isEncrypted:

Gets the last [buffer](#//api/name/buffer) whose format packetization and encryption flags matches the specified flags.
- (TBuffer)getBufferWithIsPacketized:(bool)isPacketized isEncrypted:(bool)isEncrypted

Parameters

isPacketized

Whether the buffer is packetized.
isEncrypted

Whether the buffer is encrypted.

Discussion

Gets the last [buffer](#//api/name/buffer) whose format packetization and encryption flags matches the specified flags.

Declared In

FMIceLinkMediaFrame.h

– hasBufferWithFormat:

Checks if a [buffer](#//api/name/buffer) exists with format equivalence.
- (bool)hasBufferWithFormat:(TFormat)format

Parameters

format

The format.

Return Value

true if the buffer exists; otherwise, false.

Discussion

Checks if a [buffer](#//api/name/buffer) exists with format equivalence.

Declared In

FMIceLinkMediaFrame.h

– hasBufferWithFormat:sourceId:

Checks if a [buffer](#//api/name/buffer) exists with format equivalence and source ID.
- (bool)hasBufferWithFormat:(TFormat)format sourceId:(NSString *)sourceId

Parameters

format

The format.
sourceId

The source identifier.

Return Value

true if the buffer exists; otherwise, false.

Discussion

Checks if a [buffer](#//api/name/buffer) exists with format equivalence and source ID.

Declared In

FMIceLinkMediaFrame.h

– init

Initializes a new instance of the FMIceLinkMediaFrame`4 class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkMediaFrame`4 class.

Declared In

FMIceLinkMediaFrame.h

– initWithBuffer:

Initializes a new instance of the FMIceLinkMediaFrame`4 class.
- (instancetype)initWithBuffer:(TBuffer)buffer

Parameters

buffer

The buffer.

Discussion

Initializes a new instance of the FMIceLinkMediaFrame`4 class.

Declared In

FMIceLinkMediaFrame.h

– initWithBuffers:

Initializes a new instance of the FMIceLinkMediaFrame`4 class.
- (instancetype)initWithBuffers:(NSMutableArray *)buffers

Parameters

buffers

The buffers.

Discussion

Initializes a new instance of the FMIceLinkMediaFrame`4 class.

Declared In

FMIceLinkMediaFrame.h

– lastBuffer

Gets the most recent [buffer](#//api/name/buffer).
- (TBuffer)lastBuffer

Discussion

Gets the most recent [buffer](#//api/name/buffer).

Declared In

FMIceLinkMediaFrame.h

+ mediaFrame

Initializes a new instance of the FMIceLinkMediaFrame`4 class.
+ (FMIceLinkMediaFrame *)mediaFrame

Discussion

Initializes a new instance of the FMIceLinkMediaFrame`4 class.

Declared In

FMIceLinkMediaFrame.h

+ mediaFrameWithBuffer:

Initializes a new instance of the FMIceLinkMediaFrame`4 class.
+ (FMIceLinkMediaFrame *)mediaFrameWithBuffer:(TBuffer)buffer

Parameters

buffer

The buffer.

Discussion

Initializes a new instance of the FMIceLinkMediaFrame`4 class.

Declared In

FMIceLinkMediaFrame.h

+ mediaFrameWithBuffers:

Initializes a new instance of the FMIceLinkMediaFrame`4 class.
+ (FMIceLinkMediaFrame *)mediaFrameWithBuffers:(NSMutableArray *)buffers

Parameters

buffers

The buffers.

Discussion

Initializes a new instance of the FMIceLinkMediaFrame`4 class.

Declared In

FMIceLinkMediaFrame.h

– removeBuffer:

Removes a [buffer](#//api/name/buffer).
- (void)removeBuffer:(TBuffer)buffer

Parameters

buffer

The buffer.

Discussion

Removes a [buffer](#//api/name/buffer).

Declared In

FMIceLinkMediaFrame.h

– removeBuffers

Removes all [buffers](#//api/name/buffers).
- (void)removeBuffers

Discussion

Removes all [buffers](#//api/name/buffers).

Declared In

FMIceLinkMediaFrame.h

– removeBuffers:

Removes some [buffers](#//api/name/buffers).
- (void)removeBuffers:(NSMutableArray *)buffers

Parameters

buffers

The buffers.

Discussion

Removes some [buffers](#//api/name/buffers).

Declared In

FMIceLinkMediaFrame.h

– rtpSequenceNumber

Gets the RTP sequence number.
- (int)rtpSequenceNumber

Discussion

Gets the RTP sequence number.

Declared In

FMIceLinkMediaFrame.h

– rtpTimestamp

Gets the RTP [timestamp](#//api/name/timestamp).
- (long long)rtpTimestamp

Discussion

Gets the RTP [timestamp](#//api/name/timestamp).

Declared In

FMIceLinkMediaFrame.h

– sequenceNumber

Gets the sequence number.
- (long long)sequenceNumber

Discussion

Gets the sequence number.

Declared In

FMIceLinkMediaFrame.h

– setBuffer:

Sets the [buffer](#//api/name/buffer).
- (void)setBuffer:(TBuffer)value

Discussion

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

Declared In

FMIceLinkMediaFrame.h

– setBuffers:

Sets the [buffers](#//api/name/buffers).
- (void)setBuffers:(NSMutableArray *)value

Discussion

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

Declared In

FMIceLinkMediaFrame.h

– setContributingSources:

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

Discussion

Sets the contributing sources.

Declared In

FMIceLinkMediaFrame.h

– setRtpSequenceNumber:

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

Discussion

Sets the RTP sequence number.

Declared In

FMIceLinkMediaFrame.h

– setRtpTimestamp:

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

Discussion

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

Declared In

FMIceLinkMediaFrame.h

– setSequenceNumber:

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

Discussion

Sets the sequence number.

Declared In

FMIceLinkMediaFrame.h

– setSynchronizationSource:

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

Discussion

Sets the synchronization source.

Declared In

FMIceLinkMediaFrame.h

– setTimestamp:

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

Discussion

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

Declared In

FMIceLinkMediaFrame.h

– synchronizationSource

Gets the synchronization source.
- (long long)synchronizationSource

Discussion

Gets the synchronization source.

Declared In

FMIceLinkMediaFrame.h

– timestamp

Gets the timestamp.
- (long long)timestamp

Discussion

Gets the timestamp.

Declared In

FMIceLinkMediaFrame.h