FMLiveSwitchMediaBuffer Class Reference

A media buffer. More...

Instance Methods

(TBuffer) - createInstance
 Creates a new instance. More...
 
(FMLiveSwitchDataBuffer *) - dataBuffer
 Gets the data buffer. More...
 
(NSMutableArray *) - dataBuffers
 Gets the data buffers. More...
 
(NSString *) - description
 Returns a string that represents this instance. More...
 
(int) - footprint
 Gets the approximate footprint of this media buffer by returning the sum of its data buffer lengths. More...
 
(TFormat) - format
 Gets the format. More...
 
(TBuffer) - free
 Frees the data buffers referenced by this instance. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class. More...
 
(instancetype) - initWithDataBuffer:format:
 Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class. More...
 
(instancetype) - initWithDataBuffers:format:
 Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class. More...
 
(bool) - isMuted
 Gets a value indicating whether this instance has been muted. More...
 
(TBuffer) - keep
 Keeps the data buffers referenced by this instance. More...
 
(long long) - lastSequenceNumber
 Gets the last sequence number. More...
 
(bool) - mute
 Mutes this instance. More...
 
(bool) - recoveredByFec
 Gets a value indicating whether this buffer contains data recovered by forward error correction (FEC). More...
 
(FMLiveSwitchRtpPacketHeader *) - rtpHeader
 Gets the Rtp Packet Header for this media buffer. More...
 
(NSMutableArray *) - rtpHeaders
 Gets the RTP Packet Headers for this media buffer. More...
 
(int) - rtpSequenceNumber
 Gets the RTP sequence number. More...
 
(NSMutableArray *) - rtpSequenceNumbers
 Gets the RTP sequence numbers. More...
 
(long long) - sequenceNumber
 Gets the sequence number. More...
 
(NSMutableArray *) - sequenceNumbers
 Gets the sequence numbers. More...
 
(void) - setDataBuffer:
 Sets the data buffer. More...
 
(void) - setDataBuffers:
 Sets the data buffers. More...
 
(void) - setFormat:
 Sets the format. More...
 
(void) - setRecoveredByFec:
 Sets a value indicating whether this buffer contains data recovered by forward error correction (FEC). More...
 
(void) - setRtpHeader:
 Sets the Rtp Packet Header for this media buffer. More...
 
(void) - setRtpHeaders:
 Sets the RTP Packet Headers for this media buffer. More...
 
(void) - setSequenceNumber:
 Sets the sequence number. More...
 
(void) - setSequenceNumbers:
 Sets the sequence numbers. More...
 
(void) - setSourceId:
 Sets the source identifier. More...
 
(NSString *) - sourceId
 Gets the source identifier. More...
 
(bool) - tryKeep
 Attempts to keep the data buffers referenced by this instance. More...
 

Class Methods

(FMLiveSwitchMediaBuffer *) + mediaBuffer
 Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class. More...
 
(FMLiveSwitchMediaBuffer *) + mediaBufferWithDataBuffer:format:
 Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class. More...
 
(FMLiveSwitchMediaBuffer *) + mediaBufferWithDataBuffers:format:
 Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchDynamic- (TBuffer) clone
 

Detailed Description

A media buffer.

Method Documentation

◆ createInstance

- (TBuffer) createInstance

◆ dataBuffer

- (FMLiveSwitchDataBuffer*) dataBuffer

Gets the data buffer.

◆ dataBuffers

- (NSMutableArray*) dataBuffers

Gets the data buffers.

◆ description

- (NSString*) description

Returns a string that represents this instance.

◆ footprint

- (int) footprint

Gets the approximate footprint of this media buffer by returning the sum of its data buffer lengths.

◆ format

- (TFormat) format

Gets the format.

◆ free

- (TBuffer) free

Frees the data buffers referenced by this instance.

Returns
This instance.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class.

Implemented in FMLiveSwitchVideoBuffer, and FMLiveSwitchAudioBuffer.

◆ initWithDataBuffer:format:

- (instancetype) initWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer
format: (TFormat)  format 

Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class.

Parameters
dataBufferThe data buffer.
formatThe format.

◆ initWithDataBuffers:format:

- (instancetype) initWithDataBuffers: (NSMutableArray *)  dataBuffers
format: (TFormat)  format 

Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class.

Parameters
dataBuffersThe data buffers.
formatThe format.

◆ isMuted

- (bool) isMuted

Gets a value indicating whether this instance has been muted.

Implemented in FMLiveSwitchVideoBuffer, and FMLiveSwitchAudioBuffer.

◆ keep

- (TBuffer) keep

Keeps the data buffers referenced by this instance.

Returns
This instance.

◆ lastSequenceNumber

- (long long) lastSequenceNumber

Gets the last sequence number.

◆ mediaBuffer

+ (FMLiveSwitchMediaBuffer*) mediaBuffer

Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class.

◆ mediaBufferWithDataBuffer:format:

+ (FMLiveSwitchMediaBuffer*) mediaBufferWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer
format: (TFormat)  format 

Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class.

Parameters
dataBufferThe data buffer.
formatThe format.

◆ mediaBufferWithDataBuffers:format:

+ (FMLiveSwitchMediaBuffer*) mediaBufferWithDataBuffers: (NSMutableArray *)  dataBuffers
format: (TFormat)  format 

Initializes a new instance of the FMLiveSwitchMediaBuffer`2 class.

Parameters
dataBuffersThe data buffers.
formatThe format.

◆ mute

- (bool) mute

Mutes this instance.

This is a one-way operation that clears the underlying data buffer. If the buffer has an unsupported format, this method will return false.

Implemented in FMLiveSwitchVideoBuffer, and FMLiveSwitchAudioBuffer.

◆ recoveredByFec

- (bool) recoveredByFec

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

◆ rtpHeader

Gets the Rtp Packet Header for this media buffer.

◆ rtpHeaders

- (NSMutableArray*) rtpHeaders

Gets the RTP Packet Headers for this media buffer.

◆ rtpSequenceNumber

- (int) rtpSequenceNumber

Gets the RTP sequence number.

◆ rtpSequenceNumbers

- (NSMutableArray*) rtpSequenceNumbers

Gets the RTP sequence numbers.

◆ sequenceNumber

- (long long) sequenceNumber

Gets the sequence number.

◆ sequenceNumbers

- (NSMutableArray*) sequenceNumbers

Gets the sequence numbers.

◆ setDataBuffer:

- (void) setDataBuffer: (FMLiveSwitchDataBuffer *)  value

Sets the data buffer.

◆ setDataBuffers:

- (void) setDataBuffers: (NSMutableArray *)  value

Sets the data buffers.

◆ setFormat:

- (void) setFormat: (TFormat)  value

Sets the format.

◆ setRecoveredByFec:

- (void) setRecoveredByFec: (bool)  value

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

◆ setRtpHeader:

- (void) setRtpHeader: (FMLiveSwitchRtpPacketHeader *)  value

Sets the Rtp Packet Header for this media buffer.

◆ setRtpHeaders:

- (void) setRtpHeaders: (NSMutableArray *)  value

Sets the RTP Packet Headers for this media buffer.

◆ setSequenceNumber:

- (void) setSequenceNumber: (long long)  value

Sets the sequence number.

◆ setSequenceNumbers:

- (void) setSequenceNumbers: (NSMutableArray *)  value

Sets the sequence numbers.

◆ setSourceId:

- (void) setSourceId: (NSString *)  value

Sets the source identifier.

◆ sourceId

- (NSString*) sourceId

Gets the source identifier.

◆ tryKeep

- (bool) tryKeep

Attempts to keep the data buffers referenced by this instance.

Returns
True if succeeded.

Member Data Documentation

◆ __pad0__

- __pad0__
protected