FMLiveSwitchVideoFrame Class Reference

A video frame. More...

Instance Methods

(FMLiveSwitchVideoFrame *) - clone
 Clones this instance. More...
 
(FMLiveSwitchVideoFrame *) - createInstance
 Creates a new instance. More...
 
(FMLiveSwitchVideoBufferCollection *) - createMediaBufferCollection
 Creates a media buffer collection. More...
 
(NSString *) - description
 Returns a string that represents this instance. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchVideoFrame class. More...
 
(instancetype) - initWithBuffer:
 Initializes a new instance of the FMLiveSwitchVideoFrame class. More...
 
(instancetype) - initWithBuffers:
 Initializes a new instance of the FMLiveSwitchVideoFrame class. More...
 
- Instance Methods inherited from FMLiveSwitchMediaFrame
(void) - addBuffers:
 Adds some buffers. More...
 
(TBuffer) - buffer
 Gets the buffer. More...
 
(NSMutableArray *) - buffers
 Gets the buffers. More...
 
(NSMutableArray *) - contributingSources
 Gets the contributing sources. More...
 
(bool) - discard
 Gets whether this frame should be discarded. More...
 
(int) - footprint
 Gets the approximate footprint of this media frame by returning the sum of its media buffer footprints. More...
 
(TFrame) - free
 Frees the buffers referenced by this instance. More...
 
(TBuffer) - getBufferWithFormat:
 Gets the last buffer whose format is compatible with the specified format. More...
 
(TBuffer) - getBufferWithFormat:sourceId:
 Gets the last buffer whose format is compatible with the specified format and whose source ID matches the specified source ID. More...
 
(TBuffer) - getBufferWithFormatName:
 Gets the last buffer whose format name matches the specified format name. More...
 
(TBuffer) - getBufferWithIsPacketized:
 Gets the last buffer whose format packetization flag matches the specified flag. More...
 
(TBuffer) - getBufferWithIsPacketized:isEncrypted:
 Gets the last buffer whose format packetization and encryption flags matches the specified flags. More...
 
(bool) - hasBufferWithFormat:
 Checks if a buffer exists with format equivalence. More...
 
(bool) - hasBufferWithFormat:sourceId:
 Checks if a buffer exists with format equivalence and source ID. More...
 
(instancetype) - initWithBuffer:
 Initializes a new instance of the FMLiveSwitchMediaFrame`4 class. More...
 
(TFrame) - keep
 Keeps the buffers referenced by this instance. More...
 
(TBuffer) - lastBuffer
 Gets the most recent buffer. More...
 
(NSString *) - mid
 Gets the MID. More...
 
(long long) - networkSystemTimestamp
 Gets the network system timestamp. More...
 
(long long) - ntpTimestampTicks
 Gets the NTP timestamp ticks matching FMLiveSwitchMediaFrame`4timestamp, set by RTP receivers for synchronization of inbound media streams. More...
 
(void) - removeBuffer:
 Removes a buffer. More...
 
(void) - removeBuffers
 Removes all buffers. More...
 
(void) - removeBuffers:
 Removes some buffers. More...
 
(NSString *) - repairedRtpStreamId
 Gets the repaired RTP stream identifier. More...
 
(int) - rtpSequenceNumber
 Gets the RTP sequence number. More...
 
(NSString *) - rtpStreamId
 Gets the RTP stream identifier. More...
 
(long long) - rtpTimestamp
 Gets the RTP timestamp. More...
 
(long long) - sequenceNumber
 Gets the sequence number. More...
 
(void) - setBuffer:
 Sets the buffer. More...
 
(void) - setBuffers:
 Sets the buffers. More...
 
(void) - setContributingSources:
 Sets the contributing sources. More...
 
(void) - setDiscard:
 Sets whether this frame should be discarded. More...
 
(void) - setMid:
 Sets the MID. More...
 
(void) - setNetworkSystemTimestamp:
 Sets the network system timestamp. More...
 
(void) - setNtpTimestampTicks:
 Sets the NTP timestamp ticks matching FMLiveSwitchMediaFrame`4timestamp, set by RTP receivers for synchronization of inbound media streams. More...
 
(void) - setRepairedRtpStreamId:
 Sets the repaired RTP stream identifier. More...
 
(void) - setRtpSequenceNumber:
 Sets the RTP sequence number. More...
 
(void) - setRtpStreamId:
 Sets the RTP stream identifier. More...
 
(void) - setRtpTimestamp:
 Sets the RTP timestamp. More...
 
(void) - setSequenceNumber:
 Sets the sequence number. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(void) - setSynchronized:
 Sets whether this frame has a FMLiveSwitchMediaFrame`4systemTimestamp that is actively synchronized with other streams. More...
 
(void) - setSystemTimestamp:
 Sets the system timestamp matching FMLiveSwitchMediaFrame`4timestamp but measured in system ticks. More...
 
(void) - setTimestamp:
 Sets the timestamp, measured according to the last buffer format's clock rate. More...
 
(void) - setTransportSystemTimestamp:
 Sets the transport system timestamp. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 
(bool) - synchronized
 Gets whether this frame has a FMLiveSwitchMediaFrame`4systemTimestamp that is actively synchronized with other streams. More...
 
(long long) - systemTimestamp
 Gets the system timestamp matching FMLiveSwitchMediaFrame`4timestamp but measured in system ticks. More...
 
(long long) - timestamp
 Gets the timestamp, measured according to the last buffer format's clock rate. More...
 
(long long) - transportSystemTimestamp
 Gets the transport system timestamp. More...
 
(void) - updateTimestampWithBaseTimestamp:baseRtpTimestamp:inputClockRate:outputClockRate:
 Updates the timestamp to match resampling. More...
 

Class Methods

(FMLiveSwitchVideoFrame *) + generateFrameWithWidth:height:formatName:
 Generates a black video frame for the given width, height, and format. More...
 
(FMLiveSwitchVideoFrame *) + videoFrame
 Initializes a new instance of the FMLiveSwitchVideoFrame class. More...
 
(FMLiveSwitchVideoFrame *) + videoFrameWithBuffer:
 Initializes a new instance of the FMLiveSwitchVideoFrame class. More...
 
(FMLiveSwitchVideoFrame *) + videoFrameWithBuffers:
 Initializes a new instance of the FMLiveSwitchVideoFrame class. More...
 
- Class Methods inherited from FMLiveSwitchMediaFrame
(long long) + calculateSystemTimestampWithBaseSystemTimestamp:timestamp:clockRate:baseTimestamp:
 Calculates a system timestamp given a base system timestamp, the current timestamp, a clock rate, and a base timestamp. More...
 
(long long) + calculateTimestampWithBaseSystemTimestamp:systemTimestamp:clockRate:
 Calculates a timestamp given a base system timestamp, the current system timestamp, and a clock rate. More...
 
(long long) + calculateTimestampWithBaseSystemTimestamp:systemTimestamp:clockRate:baseTimestamp:
 Calculates a timestamp given a base system timestamp, the current system timestamp, a clock rate, and a base timestamp. More...
 
(FMLiveSwitchMediaFrame *) + mediaFrame
 Initializes a new instance of the FMLiveSwitchMediaFrame`4 class. More...
 
(FMLiveSwitchMediaFrame *) + mediaFrameWithBuffer:
 Initializes a new instance of the FMLiveSwitchMediaFrame`4 class. More...
 
(FMLiveSwitchMediaFrame *) + mediaFrameWithBuffers:
 Initializes a new instance of the FMLiveSwitchMediaFrame`4 class. More...
 

Additional Inherited Members

- Protected Attributes inherited from FMLiveSwitchMediaFrame
 __pad0__: FMLiveSwitchDynamic- (void) addBuffer:(TBuffer)buffer
 

Detailed Description

A video frame.

Method Documentation

◆ clone

Clones this instance.

Implements FMLiveSwitchMediaFrame.

◆ createInstance

- (FMLiveSwitchVideoFrame*) createInstance

Creates a new instance.

Implements FMLiveSwitchMediaFrame.

◆ createMediaBufferCollection

- (FMLiveSwitchVideoBufferCollection*) createMediaBufferCollection

Creates a media buffer collection.

Implements FMLiveSwitchMediaFrame.

◆ description

- (NSString*) description

Returns a string that represents this instance.

◆ generateFrameWithWidth:height:formatName:

+ (FMLiveSwitchVideoFrame*) generateFrameWithWidth: (int)  width
height: (int)  height
formatName: (NSString *)  formatName 

Generates a black video frame for the given width, height, and format.

Parameters
widthThe width.
heightThe height.
formatNameThe format name.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchVideoFrame class.

Implements FMLiveSwitchMediaFrame.

◆ initWithBuffer:

- (instancetype) initWithBuffer: (FMLiveSwitchVideoBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchVideoFrame class.

Parameters
bufferThe buffer.

◆ initWithBuffers:

- (instancetype) initWithBuffers: (NSMutableArray *)  buffers

Initializes a new instance of the FMLiveSwitchVideoFrame class.

Parameters
buffersThe buffers.

Implements FMLiveSwitchMediaFrame.

◆ videoFrame

+ (FMLiveSwitchVideoFrame*) videoFrame

Initializes a new instance of the FMLiveSwitchVideoFrame class.

◆ videoFrameWithBuffer:

+ (FMLiveSwitchVideoFrame*) videoFrameWithBuffer: (FMLiveSwitchVideoBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchVideoFrame class.

Parameters
bufferThe buffer.

◆ videoFrameWithBuffers:

+ (FMLiveSwitchVideoFrame*) videoFrameWithBuffers: (NSMutableArray *)  buffers

Initializes a new instance of the FMLiveSwitchVideoFrame class.

Parameters
buffersThe buffers.