FMIceLinkVideoDecoder Class Reference

Inherits from FMIceLinkVideoPipe : FMIceLinkMediaPipe : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Declared in FMIceLinkVideoDecoder.h
FMIceLinkVideoDecoder.m

Overview

A video decoder.

– delayDecode

Gets a value indicating whether decoding should be delayed.
- (bool)delayDecode

Discussion

Gets a value indicating whether decoding should be delayed.

Declared In

FMIceLinkVideoDecoder.h

– delayDecodeOnPendingKeyFrame

Gets a flag indicating whether decoding should be bypassed for incoming media packets when a key frame request has been made via a PLI message. Default is true.
- (bool)delayDecodeOnPendingKeyFrame

Discussion

Gets a flag indicating whether decoding should be bypassed for incoming media packets when a key frame request has been made via a PLI message. Default is true.

Declared In

FMIceLinkVideoDecoder.h

– doProcessFrame:inputBuffer:

Processes a frame.
- (void)doProcessFrame:(FMIceLinkVideoFrame *)frame inputBuffer:(FMIceLinkVideoBuffer *)inputBuffer

Parameters

frame

The frame.
inputBuffer

The input buffer.

Discussion

Processes a frame.

Declared In

FMIceLinkVideoDecoder.h

– doProcessSdpMediaDescription:isOffer:isLocalDescription:

Processes a SDP media description.
- (FMIceLinkError *)doProcessSdpMediaDescription:(FMIceLinkSdpMediaDescription *)mediaDescription isOffer:(bool)isOffer isLocalDescription:(bool)isLocalDescription

Parameters

mediaDescription

The media description.
isOffer

if set to true [is offer].
isLocalDescription

if set to true [is local description].

Discussion

Processes a SDP media description.

Declared In

FMIceLinkVideoDecoder.h

– doProcessStatsFromInputWithStats:

Process stats from an input.
- (void)doProcessStatsFromInputWithStats:(FMIceLinkMediaTrackStats *)stats

Parameters

stats

The stats.

Discussion

Process stats from an input.

Declared In

FMIceLinkVideoDecoder.h

– frameHeight

Gets the last frame height.
- (int)frameHeight

Discussion

Gets the last frame height.

Declared In

FMIceLinkVideoDecoder.h

– frameRate

Gets the average frame rate.
- (int)frameRate

Discussion

Gets the average frame rate.

Declared In

FMIceLinkVideoDecoder.h

– framesDecoded

Gets the number of decoded frames.
- (long long)framesDecoded

Discussion

Gets the number of decoded frames.

Declared In

FMIceLinkVideoDecoder.h

– frameWidth

Gets the last frame width.
- (int)frameWidth

Discussion

Gets the last frame width.

Declared In

FMIceLinkVideoDecoder.h

– initWithInputFormat:outputFormat:

Initializes a new instance of the FMIceLinkVideoDecoder class.
- (instancetype)initWithInputFormat:(FMIceLinkVideoFormat *)inputFormat outputFormat:(FMIceLinkVideoFormat *)outputFormat

Parameters

inputFormat

The input format.
outputFormat

The output format.

Discussion

Initializes a new instance of the FMIceLinkVideoDecoder class.

Declared In

FMIceLinkVideoDecoder.h

– isKeyFrameWithDataBuffer:

Determines whether a data buffer represents a keyframe.
- (bool)isKeyFrameWithDataBuffer:(FMIceLinkDataBuffer *)dataBuffer

Parameters

dataBuffer

The data buffer.

Discussion

Determines whether a data buffer represents a keyframe.

Declared In

FMIceLinkVideoDecoder.h

– raiseFrame:

Raises a frame.
- (void)raiseFrame:(FMIceLinkVideoFrame *)frame

Parameters

frame

The frame.

Discussion

Raises a frame.

Declared In

FMIceLinkVideoDecoder.h

– sendKeyFrameRequestWithReason:

Sends a key-frame request.
- (void)sendKeyFrameRequestWithReason:(NSString *)reason

Discussion

Sends a key-frame request.

Declared In

FMIceLinkVideoDecoder.h

– setDelayDecodeOnPendingKeyFrame:

Sets a flag indicating whether decoding should be bypassed for incoming media packets when a key frame request has been made via a PLI message. Default is true.
- (void)setDelayDecodeOnPendingKeyFrame:(bool)value

Discussion

Sets a flag indicating whether decoding should be bypassed for incoming media packets when a key frame request has been made via a PLI message. Default is true.

Declared In

FMIceLinkVideoDecoder.h

+ videoDecoderWithInputFormat:outputFormat:

Initializes a new instance of the FMIceLinkVideoDecoder class.
+ (FMIceLinkVideoDecoder *)videoDecoderWithInputFormat:(FMIceLinkVideoFormat *)inputFormat outputFormat:(FMIceLinkVideoFormat *)outputFormat

Parameters

inputFormat

The input format.
outputFormat

The output format.

Discussion

Initializes a new instance of the FMIceLinkVideoDecoder class.

Declared In

FMIceLinkVideoDecoder.h