FMIceLinkMediaSink Class Reference

Inherits from FMIceLinkMediaSinkBase : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to TBuffer
TBufferCollection
TFormat
TFrame
TIInput
TIOutput
TIOutputCollection
TSink
__covariant
Declared in FMIceLinkMediaSink.h
FMIceLinkMediaSink.m

Overview

A media sink.

The type of the output interface.The type of the output interface collection.The type of the input interface.The type of the sink.The type of the frame.The type of the buffer.The type of the buffer collection.The type of the format.

– addInput:

Adds an [input](#//api/name/input).
- (void)addInput:(TIOutput)input

Parameters

input

The input.

Discussion

Adds an [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– addInputs:

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

Parameters

inputs

The inputs.

Discussion

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

Declared In

FMIceLinkMediaSink.h

– addOnDisabledChange:

Adds a handler that is raised when Disabled is changed.
- (void)addOnDisabledChange:(FMIceLinkAction0 *)value

Discussion

Adds a handler that is raised when Disabled is changed.

Declared In

FMIceLinkMediaSink.h

– addOnProcessFrame:

Adds a handler that is raised when a frame is processed.
- (void)addOnProcessFrame:(FMIceLinkAction1<TFrame> *)value

Discussion

Adds a handler that is raised when a frame is processed.

Declared In

FMIceLinkMediaSink.h

– addOnProcessFrameException:

Adds a handler that is raised when an exception is thrown while processing a frame.
- (void)addOnProcessFrameException:(FMIceLinkAction2<TFrame,NSException*> *)value

Discussion

Adds a handler that is raised when an exception is thrown while processing a frame.

Declared In

FMIceLinkMediaSink.h

– addOnProcessFrameExceptionWithBlock

Adds a handler that is raised when an exception is thrown while processing a frame.
- (void ( ^ ) ( void ( ^ ) ( TFrame , NSException *) ))addOnProcessFrameExceptionWithBlock

Discussion

Adds a handler that is raised when an exception is thrown while processing a frame.

Declared In

FMIceLinkMediaSink.h

– addOnProcessFrameExceptionWithBlock:

Adds a handler that is raised when an exception is thrown while processing a frame.
- (void)addOnProcessFrameExceptionWithBlock:(void ( ^ ) ( TFrame , NSException *))valueBlock

Discussion

Adds a handler that is raised when an exception is thrown while processing a frame.

Declared In

FMIceLinkMediaSink.h

– addOnProcessFrameWithBlock

Adds a handler that is raised when a frame is processed.
- (void ( ^ ) ( void ( ^ ) ( TFrame ) ))addOnProcessFrameWithBlock

Discussion

Adds a handler that is raised when a frame is processed.

Declared In

FMIceLinkMediaSink.h

– addOnProcessFrameWithBlock:

Adds a handler that is raised when a frame is processed.
- (void)addOnProcessFrameWithBlock:(void ( ^ ) ( TFrame ))valueBlock

Discussion

Adds a handler that is raised when a frame is processed.

Declared In

FMIceLinkMediaSink.h

– addOnRaiseControlFrames:

Adds a handler that is raised when control frames are raised.
- (void)addOnRaiseControlFrames:(FMIceLinkAction1<NSMutableArray*> *)value

Discussion

Adds a handler that is raised when control frames are raised.

Declared In

FMIceLinkMediaSink.h

– addOnRaiseControlFramesWithBlock

Adds a handler that is raised when control frames are raised.
- (void ( ^ ) ( void ( ^ ) ( NSMutableArray *) ))addOnRaiseControlFramesWithBlock

Discussion

Adds a handler that is raised when control frames are raised.

Declared In

FMIceLinkMediaSink.h

– addOnRaiseControlFramesWithBlock:

Adds a handler that is raised when control frames are raised.
- (void)addOnRaiseControlFramesWithBlock:(void ( ^ ) ( NSMutableArray *))valueBlock

Discussion

Adds a handler that is raised when control frames are raised.

Declared In

FMIceLinkMediaSink.h

– addOnStateChange:

Adds a handler that is raised when the [state](#//api/name/state) changes.
- (void)addOnStateChange:(FMIceLinkAction1<TSink> *)value

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSink.h

– addOnStateChangeWithBlock

Adds a handler that is raised when the [state](#//api/name/state) changes.
- (void ( ^ ) ( void ( ^ ) ( TSink ) ))addOnStateChangeWithBlock

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSink.h

– addOnStateChangeWithBlock:

Adds a handler that is raised when the [state](#//api/name/state) changes.
- (void)addOnStateChangeWithBlock:(void ( ^ ) ( TSink ))valueBlock

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSink.h

– changeOutput:

Changes the current [output](#//api/name/output).
- (FMIceLinkFuture<id> *)changeOutput:(FMIceLinkSinkOutput *)output

Parameters

output

The output.

Discussion

Changes the current [output](#//api/name/output).

Declared In

FMIceLinkMediaSink.h

– createOutputCollectionWithInput:

Creates an [output](#//api/name/output) collection.
- (TIOutputCollection)createOutputCollectionWithInput:(TIInput)input

Parameters

input

The input.

Discussion

Creates an [output](#//api/name/output) collection.

Declared In

FMIceLinkMediaSink.h

– description

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

Discussion

Returns a string that represents this instance.

Declared In

FMIceLinkMediaSink.h

– destroy

Destroys this instance.
- (bool)destroy

Discussion

Destroys this instance.

Declared In

FMIceLinkMediaSink.h

– disabled

Gets a value indicating whether this sink is disabled.
- (bool)disabled

Discussion

Gets a value indicating whether this sink is disabled.

Declared In

FMIceLinkMediaSink.h

– doDestroy

Destroys this instance.
- (void)doDestroy

Discussion

Destroys this instance.

Declared In

FMIceLinkMediaSink.h

– doProcessFrame:inputBuffer:

Processes a frame.
- (void)doProcessFrame:(TFrame)frame inputBuffer:(TBuffer)inputBuffer

Parameters

frame

The frame.
inputBuffer

The input buffer.

Discussion

Processes a frame.

Declared In

FMIceLinkMediaSink.h

– doProcessSdpMediaDescription:isOffer:isLocalDescription:

Processes a remote SDP media [description](#//api/name/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 remote SDP media [description](#//api/name/description).

Declared In

FMIceLinkMediaSink.h

– doProcessStatsFromInputWithStats:

Processes stats from an [input](#//api/name/input).
- (void)doProcessStatsFromInputWithStats:(FMIceLinkMediaTrackStats *)stats

Parameters

stats

The stats.

Discussion

Processes stats from an [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– getOutputs

Gets the available outputs.
- (FMIceLinkFuture<NSMutableArray*> *)getOutputs

Discussion

Gets the available outputs.

Declared In

FMIceLinkMediaSink.h

– hasInput:

Determines whether this pipe has the specified [input](#//api/name/input).
- (bool)hasInput:(TIOutput)input

Parameters

input

The input.

Discussion

Determines whether this pipe has the specified [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– init

Initializes a new instance of the FMIceLinkMediaSink`8 class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkMediaSink`8 class.

Declared In

FMIceLinkMediaSink.h

– initWithInputFormat:

Initializes a new instance of the FMIceLinkMediaSink`8 class.
- (instancetype)initWithInputFormat:(TFormat)inputFormat

Parameters

inputFormat

The input format.

Discussion

Initializes a new instance of the FMIceLinkMediaSink`8 class.

Declared In

FMIceLinkMediaSink.h

– input

Gets the input.
- (TIOutput)input

Discussion

Gets the input.

Declared In

FMIceLinkMediaSink.h

– inputFormat

Gets the [input](#//api/name/input) format.
- (TFormat)inputFormat

Discussion

Gets the [input](#//api/name/input) format.

Declared In

FMIceLinkMediaSink.h

– inputs

Gets the inputs.
- (NSMutableArray *)inputs

Discussion

Gets the inputs.

Declared In

FMIceLinkMediaSink.h

– label

Gets a label that identifies this class.
- (NSString *)label

Discussion

Gets a label that identifies this class.

Declared In

FMIceLinkMediaSink.h

– maxInputBitrate

Gets the bitrate supported by this sink, in Kbps. -1 if unknown.
- (int)maxInputBitrate

Discussion

Gets the bitrate supported by this sink, in Kbps. -1 if unknown.

Declared In

FMIceLinkMediaSink.h

+ mediaSink

Initializes a new instance of the FMIceLinkMediaSink`8 class.
+ (FMIceLinkMediaSink *)mediaSink

Discussion

Initializes a new instance of the FMIceLinkMediaSink`8 class.

Declared In

FMIceLinkMediaSink.h

+ mediaSinkWithInputFormat:

Initializes a new instance of the FMIceLinkMediaSink`8 class.
+ (FMIceLinkMediaSink *)mediaSinkWithInputFormat:(TFormat)inputFormat

Parameters

inputFormat

The input format.

Discussion

Initializes a new instance of the FMIceLinkMediaSink`8 class.

Declared In

FMIceLinkMediaSink.h

– muted

Gets a value indicating whether this instance is muted.
- (bool)muted

Discussion

Gets a value indicating whether this instance is muted.

Declared In

FMIceLinkMediaSink.h

– output

Gets the current output.
- (FMIceLinkSinkOutput *)output

Discussion

Gets the current output.

Declared In

FMIceLinkMediaSink.h

– persistent

Gets a value indicating whether this instance is persistent. If true, this instance will not be destroyed unless FMIceLinkMediaSink`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.
- (bool)persistent

Discussion

Gets a value indicating whether this instance is persistent. If true, this instance will not be destroyed unless FMIceLinkMediaSink`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

Declared In

FMIceLinkMediaSink.h

– pipelineJson

Gets the pipeline JSON with this as the central point.
- (NSString *)pipelineJson

Discussion

Gets the pipeline JSON with this as the central point.

Declared In

FMIceLinkMediaSink.h

– pipelineJsonFromInput

Gets the pipeline JSON from an [input](#//api/name/input).
- (NSString *)pipelineJsonFromInput

Discussion

Gets the pipeline JSON from an [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– processFrame:

Processes a frame.
- (bool)processFrame:(TFrame)frame

Parameters

frame

The frame.

Discussion

Processes a frame.

Declared In

FMIceLinkMediaSink.h

– processFramePolicy

Gets the ProcessFramePolicy for this media [input](#//api/name/input).
- (FMIceLinkProcessFramePolicy)processFramePolicy

Discussion

Gets the ProcessFramePolicy for this media [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:

Processes a remote SDP media [description](#//api/name/description) from an [output](#//api/name/output).
- (FMIceLinkError *)processSdpMediaDescriptionFromInputWithMediaDescription:(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 remote SDP media [description](#//api/name/description) from an [output](#//api/name/output).

Declared In

FMIceLinkMediaSink.h

– processStatsFromInputWithStats:

Processes stats from an [input](#//api/name/input).
- (void)processStatsFromInputWithStats:(FMIceLinkMediaTrackStats *)stats

Parameters

stats

The stats.

Discussion

Processes stats from an [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– raiseControlFrame:

Raises a control frame.
- (void)raiseControlFrame:(FMIceLinkMediaControlFrame *)controlFrame

Parameters

controlFrame

The control frame.

Discussion

Raises a control frame.

Declared In

FMIceLinkMediaSink.h

– raiseControlFrames:

Raises some control frames.
- (void)raiseControlFrames:(NSMutableArray *)controlFrames

Parameters

controlFrames

The control frames.

Discussion

Raises some control frames.

Declared In

FMIceLinkMediaSink.h

– removeInput:

Removes an [input](#//api/name/input).
- (bool)removeInput:(TIOutput)input

Parameters

input

The input.

Discussion

Removes an [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– removeInputs

Removes all [inputs](#//api/name/inputs).
- (void)removeInputs

Discussion

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

Declared In

FMIceLinkMediaSink.h

– removeInputs:

Removes some [inputs](#//api/name/inputs).
- (bool)removeInputs:(NSMutableArray *)inputs

Parameters

inputs

The inputs.

Discussion

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

Declared In

FMIceLinkMediaSink.h

– removeOnDisabledChange:

Removes a handler that is raised when Disabled is changed.
- (void)removeOnDisabledChange:(FMIceLinkAction0 *)value

Discussion

Removes a handler that is raised when Disabled is changed.

Declared In

FMIceLinkMediaSink.h

– removeOnProcessFrame:

Removes a handler that is raised when a frame is processed.
- (void)removeOnProcessFrame:(FMIceLinkAction1<TFrame> *)value

Discussion

Removes a handler that is raised when a frame is processed.

Declared In

FMIceLinkMediaSink.h

– removeOnProcessFrameException:

Removes a handler that is raised when an exception is thrown while processing a frame.
- (void)removeOnProcessFrameException:(FMIceLinkAction2<TFrame,NSException*> *)value

Discussion

Removes a handler that is raised when an exception is thrown while processing a frame.

Declared In

FMIceLinkMediaSink.h

– removeOnRaiseControlFrames:

Removes a handler that is raised when control frames are raised.
- (void)removeOnRaiseControlFrames:(FMIceLinkAction1<NSMutableArray*> *)value

Discussion

Removes a handler that is raised when control frames are raised.

Declared In

FMIceLinkMediaSink.h

– removeOnStateChange:

Removes a handler that is raised when the [state](#//api/name/state) changes.
- (void)removeOnStateChange:(FMIceLinkAction1<TSink> *)value

Discussion

Removes a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSink.h

– setDisabled:

Sets a value indicating whether this sink is [disabled](#//api/name/disabled).
- (void)setDisabled:(bool)value

Discussion

Sets a value indicating whether this sink is [disabled](#//api/name/disabled).

Declared In

FMIceLinkMediaSink.h

– setInput:

Sets the [input](#//api/name/input).
- (void)setInput:(TIOutput)value

Discussion

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

Declared In

FMIceLinkMediaSink.h

– setInputs:

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

Discussion

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

Declared In

FMIceLinkMediaSink.h

– setMuted:

Sets a value indicating whether this instance is [muted](#//api/name/muted).
- (void)setMuted:(bool)value

Discussion

Sets a value indicating whether this instance is [muted](#//api/name/muted).

Declared In

FMIceLinkMediaSink.h

– setOutput:

Sets the current [output](#//api/name/output).
- (void)setOutput:(FMIceLinkSinkOutput *)value

Discussion

Sets the current [output](#//api/name/output).

Declared In

FMIceLinkMediaSink.h

– setPersistent:

Sets a value indicating whether this instance is [persistent](#//api/name/persistent). If true, this instance will not be destroyed unless FMIceLinkMediaSink`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.
- (void)setPersistent:(bool)value

Discussion

Sets a value indicating whether this instance is [persistent](#//api/name/persistent). If true, this instance will not be destroyed unless FMIceLinkMediaSink`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

Declared In

FMIceLinkMediaSink.h

– setProcessFramePolicy:

Sets the ProcessFramePolicy for this media [input](#//api/name/input).
- (void)setProcessFramePolicy:(FMIceLinkProcessFramePolicy)value

Discussion

Sets the ProcessFramePolicy for this media [input](#//api/name/input).

Declared In

FMIceLinkMediaSink.h

– state

Gets the state.
- (FMIceLinkMediaSinkState)state

Discussion

Gets the state.

Declared In

FMIceLinkMediaSink.h