FMIceLinkMediaBuffer Class Reference

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

Overview

A media buffer.

The type of the format.The type of the buffer.

– clone

Clones this instance.
- (TBuffer)clone

Discussion

Clones this instance.

Declared In

FMIceLinkMediaBuffer.h

– createInstance

Creates a new instance.
- (TBuffer)createInstance

Discussion

Creates a new instance.

Declared In

FMIceLinkMediaBuffer.h

– dataBuffer

Gets the data buffer.
- (FMIceLinkDataBuffer *)dataBuffer

Discussion

Gets the data buffer.

Declared In

FMIceLinkMediaBuffer.h

– dataBuffers

Gets the data buffers.
- (NSMutableArray *)dataBuffers

Discussion

Gets the data buffers.

Declared In

FMIceLinkMediaBuffer.h

– description

Returns a string that represents this instance.
- (NSString *)description

Discussion

Returns a string that represents this instance.

Declared In

FMIceLinkMediaBuffer.h

– format

Gets the format.
- (TFormat)format

Discussion

Gets the format.

Declared In

FMIceLinkMediaBuffer.h

– free

Frees the data buffers referenced by this instance.
- (void)free

Discussion

Frees the data buffers referenced by this instance.

Declared In

FMIceLinkMediaBuffer.h

– init

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.

Declared In

FMIceLinkMediaBuffer.h

– initWithDataBuffer:format:

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.
- (instancetype)initWithDataBuffer:(FMIceLinkDataBuffer *)dataBuffer format:(TFormat)format

Parameters

dataBuffer

The data buffer.
format

The format.

Discussion

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.

Declared In

FMIceLinkMediaBuffer.h

– initWithDataBuffers:format:

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.
- (instancetype)initWithDataBuffers:(NSMutableArray *)dataBuffers format:(TFormat)format

Parameters

dataBuffers

The data buffers.
format

The format.

Discussion

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.

Declared In

FMIceLinkMediaBuffer.h

– isMuted

Gets a value indicating whether this instance has been muted.
- (bool)isMuted

Discussion

Gets a value indicating whether this instance has been muted.

Declared In

FMIceLinkMediaBuffer.h

– keep

Keeps the data buffers referenced by this instance.
- (void)keep

Discussion

Keeps the data buffers referenced by this instance.

Declared In

FMIceLinkMediaBuffer.h

– lastSequenceNumber

Gets the last sequence number.
- (long long)lastSequenceNumber

Discussion

Gets the last sequence number.

Declared In

FMIceLinkMediaBuffer.h

+ mediaBuffer

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.
+ (FMIceLinkMediaBuffer *)mediaBuffer

Discussion

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.

Declared In

FMIceLinkMediaBuffer.h

+ mediaBufferWithDataBuffer:format:

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.
+ (FMIceLinkMediaBuffer *)mediaBufferWithDataBuffer:(FMIceLinkDataBuffer *)dataBuffer format:(TFormat)format

Parameters

dataBuffer

The data buffer.
format

The format.

Discussion

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.

Declared In

FMIceLinkMediaBuffer.h

+ mediaBufferWithDataBuffers:format:

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.
+ (FMIceLinkMediaBuffer *)mediaBufferWithDataBuffers:(NSMutableArray *)dataBuffers format:(TFormat)format

Parameters

dataBuffers

The data buffers.
format

The format.

Discussion

Initializes a new instance of the FMIceLinkMediaBuffer`2 class.

Declared In

FMIceLinkMediaBuffer.h

– mute

Mutes this instance. This is a one-way operation that clears the underlying data buffer. If the buffer has an unsupported [format](#//api/name/format), this method will return false.
- (bool)mute

Discussion

Mutes this instance. This is a one-way operation that clears the underlying data buffer. If the buffer has an unsupported [format](#//api/name/format), this method will return false.

Declared In

FMIceLinkMediaBuffer.h

– recoveredByFec

Gets a value indicating whether this buffer contains data recovered by forward error correction (FEC).
- (bool)recoveredByFec

Discussion

Gets a value indicating whether this buffer contains data recovered by forward error correction (FEC).

Declared In

FMIceLinkMediaBuffer.h

– rtpHeader

Gets the Rtp Packet Header for this media buffer.
- (FMIceLinkRtpPacketHeader *)rtpHeader

Discussion

Gets the Rtp Packet Header for this media buffer.

Declared In

FMIceLinkMediaBuffer.h

– rtpHeaders

Gets the Rtp Packet Headers for this media buffer.
- (NSMutableArray *)rtpHeaders

Discussion

Gets the Rtp Packet Headers for this media buffer.

Declared In

FMIceLinkMediaBuffer.h

– rtpSequenceNumber

Gets the RTP sequence number.
- (int)rtpSequenceNumber

Discussion

Gets the RTP sequence number.

Declared In

FMIceLinkMediaBuffer.h

– rtpSequenceNumbers

Gets the RTP sequence numbers.
- (NSMutableArray *)rtpSequenceNumbers

Discussion

Gets the RTP sequence numbers.

Declared In

FMIceLinkMediaBuffer.h

– sequenceNumber

Gets the sequence number.
- (long long)sequenceNumber

Discussion

Gets the sequence number.

Declared In

FMIceLinkMediaBuffer.h

– sequenceNumbers

Gets the sequence numbers.
- (NSMutableArray *)sequenceNumbers

Discussion

Gets the sequence numbers.

Declared In

FMIceLinkMediaBuffer.h

– setDataBuffer:

Sets the data buffer.
- (void)setDataBuffer:(FMIceLinkDataBuffer *)value

Discussion

Sets the data buffer.

Declared In

FMIceLinkMediaBuffer.h

– setDataBuffers:

Sets the data buffers.
- (void)setDataBuffers:(NSMutableArray *)value

Discussion

Sets the data buffers.

Declared In

FMIceLinkMediaBuffer.h

– setFormat:

Sets the [format](#//api/name/format).
- (void)setFormat:(TFormat)value

Discussion

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

Declared In

FMIceLinkMediaBuffer.h

– setRecoveredByFec:

Sets a value indicating whether this buffer contains data recovered by forward error correction (FEC).
- (void)setRecoveredByFec:(bool)value

Discussion

Sets a value indicating whether this buffer contains data recovered by forward error correction (FEC).

Declared In

FMIceLinkMediaBuffer.h

– setRtpHeader:

Sets the Rtp Packet Header for this media buffer.
- (void)setRtpHeader:(FMIceLinkRtpPacketHeader *)value

Discussion

Sets the Rtp Packet Header for this media buffer.

Declared In

FMIceLinkMediaBuffer.h

– setRtpHeaders:

Sets the Rtp Packet Headers for this media buffer.
- (void)setRtpHeaders:(NSMutableArray *)value

Discussion

Sets the Rtp Packet Headers for this media buffer.

Declared In

FMIceLinkMediaBuffer.h

– setSequenceNumber:

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

Discussion

Sets the sequence number.

Declared In

FMIceLinkMediaBuffer.h

– setSequenceNumbers:

Sets the sequence numbers.
- (void)setSequenceNumbers:(NSMutableArray *)value

Discussion

Sets the sequence numbers.

Declared In

FMIceLinkMediaBuffer.h

– setSourceId:

Sets the source identifier.
- (void)setSourceId:(NSString *)value

Discussion

Sets the source identifier.

Declared In

FMIceLinkMediaBuffer.h

– sourceId

Gets the source identifier.
- (NSString *)sourceId

Discussion

Gets the source identifier.

Declared In

FMIceLinkMediaBuffer.h