FMLiveSwitchMediaSink Class Reference

A media sink. More...

Instance Methods

(void) - addInput:
 Adds an input. More...
 
(void) - addInputs:
 Adds some inputs. More...
 
(void) - addOnDisabledChange:
 Adds a handler that is raised when the Disabled property changes state. More...
 
(void) - addOnPausedChange:
 Adds a handler that is raised when the Paused property changes state. More...
 
(void) - addOnProcessControlFrameResponses:
 Adds a handler that is raised when control frame responses are processed. More...
 
(NSMutableArray *) - addOnProcessControlFrameResponsesWithBlock
 Adds a handler that is raised when control frame responses are processed. More...
 
(void) - addOnProcessControlFrameResponsesWithBlock:
 Adds a handler that is raised when control frame responses are processed. More...
 
(void) - addOnProcessedControlFrameResponses:
 Adds a handler that is raised when control frame responses have been processed. More...
 
(NSMutableArray *) - addOnProcessedControlFrameResponsesWithBlock
 Adds a handler that is raised when control frame responses have been processed. More...
 
(void) - addOnProcessedControlFrameResponsesWithBlock:
 Adds a handler that is raised when control frame responses have been processed. More...
 
(void) - addOnProcessedFrame:
 Adds a handler that is raised when a frame has been processed. More...
 
(TFrame) - addOnProcessedFrameWithBlock
 Adds a handler that is raised when a frame has been processed. More...
 
(void) - addOnProcessedFrameWithBlock:
 Adds a handler that is raised when a frame has been processed. More...
 
(void) - addOnProcessFrame:
 Adds a handler that is raised when a frame is being processed. More...
 
(void) - addOnProcessFrameException:
 Adds a handler that is raised when an exception is thrown while processing a frame. More...
 
(TFrame, NSException *) - addOnProcessFrameExceptionWithBlock
 Adds a handler that is raised when an exception is thrown while processing a frame. More...
 
(void) - addOnProcessFrameExceptionWithBlock:
 Adds a handler that is raised when an exception is thrown while processing a frame. More...
 
(TFrame) - addOnProcessFrameWithBlock
 Adds a handler that is raised when a frame is being processed. More...
 
(void) - addOnProcessFrameWithBlock:
 Adds a handler that is raised when a frame is being processed. More...
 
(void) - addOnRaiseControlFrames:
 Adds a handler that is raised when control frames are raised. More...
 
(NSMutableArray *) - addOnRaiseControlFramesWithBlock
 Adds a handler that is raised when control frames are raised. More...
 
(void) - addOnRaiseControlFramesWithBlock:
 Adds a handler that is raised when control frames are raised. More...
 
(void) - addOnRaisedControlFrames:
 Adds a handler that is raised when control frames have been raised. More...
 
(NSMutableArray *) - addOnRaisedControlFramesWithBlock
 Adds a handler that is raised when control frames have been raised. More...
 
(void) - addOnRaisedControlFramesWithBlock:
 Adds a handler that is raised when control frames have been raised. More...
 
(void) - addOnStateChange:
 Adds a handler that is raised when the state changes. More...
 
(TSink) - addOnStateChangeWithBlock
 Adds a handler that is raised when the state changes. More...
 
(void) - addOnStateChangeWithBlock:
 Adds a handler that is raised when the state changes. More...
 
(bool) - allowDiagnosticTimer
 Gets whether this media sink is allowed to be timed. More...
 
(bool) - allowInputRateTimer
 Gets whether this media pipe input rate is allowed to be timed. More...
 
(FMLiveSwitchFuture< id > *) - changeOutput:
 Changes the current output. More...
 
(NSString *) - content
 Gets the content descriptor. More...
 
(TIOutputCollection) - createOutputCollectionWithInput:
 Creates an output collection. More...
 
(bool) - deactivated
 Gets a value indicating whether this sink is deactivated. More...
 
(NSString *) - description
 Returns a string that represents this instance. More...
 
(bool) - destroy
 Destroys this instance. More...
 
(bool) - disabled
 Gets a value indicating whether this sink is disabled. More...
 
(void) - doDestroy
 Destroys this instance. More...
 
(void) - doPostProcessFrame:inputBuffer:
 Post-processes a frame. More...
 
(void) - doPreProcessFrame:inputBuffer:
 Pre-processes a frame. More...
 
(void) - doProcessControlFrameResponses:
 Processes control frame responses. More...
 
(void) - doProcessFrame:inputBuffer:
 Processes a frame. More...
 
(FMLiveSwitchError *) - doProcessSdpMediaDescription:isOffer:isLocalDescription:
 Processes a remote SDP media description. More...
 
(void) - doProcessSinkStatsFromInputWithSinkStats:
 Processes sink stats from an input. More...
 
(void) - doProcessTrackStatsFromInputWithTrackStats:
 Processes track stats from an input. More...
 
(int) - getCcmSequenceNumber
 Gets the CCM sequence number. More...
 
(FMLiveSwitchFuture< NSMutableArray * > *) - getOutputs
 Gets the available outputs. More...
 
(long long) - getPipelineSystemDelayWithOutputFormat:
 Gets the total pipeline system delay in ticks for a given output format. More...
 
(bool) - hasInput:
 Determines whether this pipe has the specified input. More...
 
(void) - incrementCcmSequenceNumber
 Increments the CCM sequence number. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchMediaSink`8 class. More...
 
(instancetype) - initWithInputFormat:
 Initializes a new instance of the FMLiveSwitchMediaSink`8 class. More...
 
(TIOutput) - input
 Gets the input. More...
 
(void) - inputAddedWithInput:
 Called when an input is added. More...
 
(bool) - inputDeactivated
 Gets whether input is deactivated. More...
 
(TFormat) - inputFormat
 Gets the input format. More...
 
(bool) - inputMuted
 Gets whether input is muted. More...
 
(void) - inputRemovedWithInput:
 Called when an input is removed. More...
 
(NSString *) - inputRtpStreamId
 Gets the input RTP stream identifier. More...
 
(NSMutableArray *) - inputs
 Gets the inputs. More...
 
(long long) - inputSynchronizationSource
 Gets the input synchronization source. More...
 
(bool) - isMixer
 Gets whether this sink processes media from different sources. More...
 
(NSString *) - label
 Gets a label that identifies this class. More...
 
(int) - maxInputBitrate
 Gets the maximum allowed input bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - maxInputEncoding
 Gets the maximum allowed input encoding. More...
 
(int) - minInputBitrate
 Gets the minimum allowed input bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - minInputEncoding
 Gets the minimum allowed input encoding. More...
 
(bool) - muted
 Gets whether input is muted. More...
 
(FMLiveSwitchSinkOutput *) - output
 Gets the current output. More...
 
(bool) - overConstrained
 Gets whether this sink is over-constrained. More...
 
(bool) - overConstrainedBitrate
 Gets whether the sink bitrate is over-constrained. More...
 
(bool) - overConstrainedInput
 Gets whether the input is over-contrained. More...
 
(bool) - overConstrainedInputBitrate
 Gets whether the minimum allowed input bitrate exceeds the maximum allowed input bitrate. More...
 
(bool) - paused
 Gets a value indicating whether this sink is paused. More...
 
(bool) - persistent
 Gets a value indicating whether this instance is persistent. More...
 
(NSString *) - pipelineJson
 Gets the pipeline JSON with this as the central point. More...
 
(NSString *) - pipelineJsonFromInput
 Gets the pipeline JSON from an input. More...
 
(void) - processControlFrameResponse:
 Processes a control frame response. More...
 
(void) - processControlFrameResponses:
 Processes control frame responses. More...
 
(bool) - processFrame:
 Processes a frame. More...
 
(FMLiveSwitchProcessFramePolicy) - processFramePolicy
 Gets the ProcessFramePolicy for this media input. More...
 
(FMLiveSwitchError *) - processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:
 Processes a remote SDP media description from an output. More...
 
(void) - processSinkStatsFromInputWithSinkStats:
 Processes sink stats from an input. More...
 
(void) - processTrackStatsFromInputWithTrackStats:
 Processes track stats from an input. More...
 
(void) - raiseControlFrame:
 Raises a control frame. More...
 
(void) - raiseControlFrame:inputs:
 Raises a control frame. More...
 
(void) - raiseControlFrames:
 Raises control frames. More...
 
(void) - raiseControlFrames:inputs:
 Raises control frames. More...
 
(void) - raiseDisabledChange
 Raises the OnDisabledChange event. More...
 
(bool) - removeInput:
 Removes an input. More...
 
(void) - removeInputs
 Removes all inputs. More...
 
(void) - removeInputs:
 Removes some inputs. More...
 
(void) - removeOnDisabledChange:
 Removes a handler that is raised when the Disabled property changes state. More...
 
(void) - removeOnPausedChange:
 Removes a handler that is raised when the Paused property changes state. More...
 
(void) - removeOnProcessControlFrameResponses:
 Removes a handler that is raised when control frame responses are processed. More...
 
(void) - removeOnProcessedControlFrameResponses:
 Removes a handler that is raised when control frame responses have been processed. More...
 
(void) - removeOnProcessedFrame:
 Removes a handler that is raised when a frame has been processed. More...
 
(void) - removeOnProcessFrame:
 Removes a handler that is raised when a frame is being processed. More...
 
(void) - removeOnProcessFrameException:
 Removes a handler that is raised when an exception is thrown while processing a frame. More...
 
(void) - removeOnRaiseControlFrames:
 Removes a handler that is raised when control frames are raised. More...
 
(void) - removeOnRaisedControlFrames:
 Removes a handler that is raised when control frames have been raised. More...
 
(void) - removeOnStateChange:
 Removes a handler that is raised when the state changes. More...
 
(void) - setDeactivated:
 Sets a value indicating whether this sink is deactivated. More...
 
(void) - setDisabled:
 Sets a value indicating whether this sink is disabled. More...
 
(void) - setInput:
 Sets the input. More...
 
(void) - setInputDeactivated:
 Sets whether input is deactivated. More...
 
(void) - setInputMuted:
 Sets whether input is muted. More...
 
(void) - setInputRtpStreamId:
 Sets the input RTP stream identifier. More...
 
(void) - setInputs:
 Sets the inputs. More...
 
(void) - setInputSynchronizationSource:
 Sets the input synchronization source. More...
 
(void) - setMaxInputBitrate:
 Sets the maximum allowed input bitrate, in kbps. More...
 
(void) - setMaxInputEncoding:
 Sets the maximum allowed input encoding. More...
 
(void) - setMinInputBitrate:
 Sets the minimum allowed input bitrate, in kbps. More...
 
(void) - setMinInputEncoding:
 Sets the minimum allowed input encoding. More...
 
(void) - setMuted:
 Sets whether input is muted. More...
 
(void) - setOutput:
 Sets the current output. More...
 
(void) - setPersistent:
 Sets a value indicating whether this instance is persistent. More...
 
(void) - setProcessFramePolicy:
 Sets the ProcessFramePolicy for this media input. More...
 
(void) - setSystemDelay:
 Sets the system delay in ticks. More...
 
(FMLiveSwitchMediaSinkState) - state
 Gets the state. More...
 
(long long) - systemDelay
 Gets the system delay in ticks. More...
 
(bool) - trySetInputFormatWithFrame:
 Sets the input format, if not set, using the frame's last buffer format. More...
 
(bool) - updateDisabled
 Updates the disabled property. More...
 

Class Methods

(FMLiveSwitchMediaSink *) + mediaSink
 Initializes a new instance of the FMLiveSwitchMediaSink`8 class. More...
 
(FMLiveSwitchMediaSink *) + mediaSinkWithInputFormat:
 Initializes a new instance of the FMLiveSwitchMediaSink`8 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchMediaSinkBase<FMLiveSwitchIMediaInput
 
 FMLiveSwitchIInput
 
 FMLiveSwitchIMediaElement
 

Detailed Description

A media sink.

Method Documentation

◆ addInput:

- (void) addInput: (TIOutput)  input

Adds an input.

Parameters
inputThe input.

◆ addInputs:

- (void) addInputs: (NSMutableArray *)  inputs

Adds some inputs.

Parameters
inputsThe inputs.

◆ addOnDisabledChange:

- (void) addOnDisabledChange: (FMLiveSwitchAction0 *)  value

Adds a handler that is raised when the Disabled property changes state.

◆ addOnPausedChange:

- (void) addOnPausedChange: (FMLiveSwitchAction0 *)  value

Adds a handler that is raised when the Paused property changes state.

◆ addOnProcessControlFrameResponses:

- (void) addOnProcessControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Adds a handler that is raised when control frame responses are processed.

◆ addOnProcessControlFrameResponsesWithBlock

- (NSMutableArray*) addOnProcessControlFrameResponsesWithBlock

Adds a handler that is raised when control frame responses are processed.

◆ addOnProcessControlFrameResponsesWithBlock:

- (void) addOnProcessControlFrameResponsesWithBlock: (void(^)(NSMutableArray *))  valueBlock

Adds a handler that is raised when control frame responses are processed.

◆ addOnProcessedControlFrameResponses:

- (void) addOnProcessedControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Adds a handler that is raised when control frame responses have been processed.

◆ addOnProcessedControlFrameResponsesWithBlock

- (NSMutableArray*) addOnProcessedControlFrameResponsesWithBlock

Adds a handler that is raised when control frame responses have been processed.

◆ addOnProcessedControlFrameResponsesWithBlock:

- (void) addOnProcessedControlFrameResponsesWithBlock: (void(^)(NSMutableArray *))  valueBlock

Adds a handler that is raised when control frame responses have been processed.

◆ addOnProcessedFrame:

- (void) addOnProcessedFrame: (FMLiveSwitchAction1< TFrame > *)  value

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

◆ addOnProcessedFrameWithBlock

- (TFrame) addOnProcessedFrameWithBlock

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

◆ addOnProcessedFrameWithBlock:

- (void) addOnProcessedFrameWithBlock: (void(^)(TFrame))  valueBlock

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

◆ addOnProcessFrame:

- (void) addOnProcessFrame: (FMLiveSwitchAction1< TFrame > *)  value

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

◆ addOnProcessFrameException:

- (void) addOnProcessFrameException: (FMLiveSwitchAction2< TFrame, NSException * > *)  value

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

◆ addOnProcessFrameExceptionWithBlock

- (TFrame, NSException*) addOnProcessFrameExceptionWithBlock

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

◆ addOnProcessFrameExceptionWithBlock:

- (void) addOnProcessFrameExceptionWithBlock: (void(^)(TFrame, NSException *))  valueBlock

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

◆ addOnProcessFrameWithBlock

- (TFrame) addOnProcessFrameWithBlock

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

◆ addOnProcessFrameWithBlock:

- (void) addOnProcessFrameWithBlock: (void(^)(TFrame))  valueBlock

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

◆ addOnRaiseControlFrames:

- (void) addOnRaiseControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

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

◆ addOnRaiseControlFramesWithBlock

- (NSMutableArray*) addOnRaiseControlFramesWithBlock

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

◆ addOnRaiseControlFramesWithBlock:

- (void) addOnRaiseControlFramesWithBlock: (void(^)(NSMutableArray *))  valueBlock

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

◆ addOnRaisedControlFrames:

- (void) addOnRaisedControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Adds a handler that is raised when control frames have been raised.

◆ addOnRaisedControlFramesWithBlock

- (NSMutableArray*) addOnRaisedControlFramesWithBlock

Adds a handler that is raised when control frames have been raised.

◆ addOnRaisedControlFramesWithBlock:

- (void) addOnRaisedControlFramesWithBlock: (void(^)(NSMutableArray *))  valueBlock

Adds a handler that is raised when control frames have been raised.

◆ addOnStateChange:

- (void) addOnStateChange: (FMLiveSwitchAction1< TSink > *)  value

Adds a handler that is raised when the state changes.

◆ addOnStateChangeWithBlock

- (TSink) addOnStateChangeWithBlock

Adds a handler that is raised when the state changes.

◆ addOnStateChangeWithBlock:

- (void) addOnStateChangeWithBlock: (void(^)(TSink))  valueBlock

Adds a handler that is raised when the state changes.

◆ allowDiagnosticTimer

- (bool) allowDiagnosticTimer

Gets whether this media sink is allowed to be timed.

◆ allowInputRateTimer

- (bool) allowInputRateTimer

Gets whether this media pipe input rate is allowed to be timed.

◆ changeOutput:

- (FMLiveSwitchFuture<id>*) changeOutput: (FMLiveSwitchSinkOutput *)  output

Changes the current output.

Parameters
outputThe output.

◆ content

- (NSString*) content

Gets the content descriptor.

Implemented in FMLiveSwitchVideoSink.

◆ createOutputCollectionWithInput:

- (TIOutputCollection) createOutputCollectionWithInput: (TIInput)  input

Creates an output collection.

Parameters
inputThe input.

◆ deactivated

- (bool) deactivated

Gets a value indicating whether this sink is deactivated.

Deactivating a sink disables it until it is activated again. A deactivated sink will not process any frames. Alias for FMLiveSwitchMediaSink`8inputDeactivated.

◆ description

- (NSString*) description

Returns a string that represents this instance.

◆ destroy

- (bool) destroy

Destroys this instance.

◆ disabled

- (bool) disabled

Gets a value indicating whether this sink is disabled.

A sink is automatically disabled if it is deactivated. A disabled sink will not accept frames raised by its inputs. Setting the value of MediaSink.Disabled is deprecated. Set MediaSink.Deactivated instead.

◆ doDestroy

◆ doPostProcessFrame:inputBuffer:

- (void) doPostProcessFrame: (TFrame)  frame
inputBuffer: (TBuffer)  inputBuffer 

Post-processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ doPreProcessFrame:inputBuffer:

- (void) doPreProcessFrame: (TFrame)  frame
inputBuffer: (TBuffer)  inputBuffer 

Pre-processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ doProcessControlFrameResponses:

- (void) doProcessControlFrameResponses: (NSMutableArray *)  controlFrameResponses

Processes control frame responses.

Parameters
controlFrameResponsesThe control frame responses.

◆ doProcessFrame:inputBuffer:

- (void) doProcessFrame: (TFrame)  frame
inputBuffer: (TBuffer)  inputBuffer 

Processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ doProcessSdpMediaDescription:isOffer:isLocalDescription:

- (FMLiveSwitchError*) doProcessSdpMediaDescription: (FMLiveSwitchSdpMediaDescription *)  mediaDescription
isOffer: (bool)  isOffer
isLocalDescription: (bool)  isLocalDescription 

Processes a remote SDP media description.

Parameters
mediaDescriptionThe media description.
isOfferif set to true [is offer].
isLocalDescriptionif set to true [is local description].

◆ doProcessSinkStatsFromInputWithSinkStats:

- (void) doProcessSinkStatsFromInputWithSinkStats: (FMLiveSwitchMediaSinkStats *)  sinkStats

Processes sink stats from an input.

Parameters
sinkStatsThe stats.

◆ doProcessTrackStatsFromInputWithTrackStats:

- (void) doProcessTrackStatsFromInputWithTrackStats: (FMLiveSwitchMediaTrackStats *)  trackStats

Processes track stats from an input.

Parameters
trackStatsThe track stats.

◆ getCcmSequenceNumber

- (int) getCcmSequenceNumber

Gets the CCM sequence number.

◆ getOutputs

- (FMLiveSwitchFuture<NSMutableArray*>*) getOutputs

Gets the available outputs.

◆ getPipelineSystemDelayWithOutputFormat:

- (long long) getPipelineSystemDelayWithOutputFormat: (TFormat)  outputFormat

Gets the total pipeline system delay in ticks for a given output format.

Parameters
outputFormatThe output format.
Returns
The total pipeline system delay in ticks.

◆ hasInput:

- (bool) hasInput: (TIOutput)  input

Determines whether this pipe has the specified input.

Parameters
inputThe input.

◆ incrementCcmSequenceNumber

- (void) incrementCcmSequenceNumber

Increments the CCM sequence number.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchMediaSink`8 class.

Implemented in FMLiveSwitchVideoSink, FMLiveSwitchNullVideoSink, FMLiveSwitchNullAudioSink, and FMLiveSwitchAudioSink.

◆ initWithInputFormat:

- (instancetype) initWithInputFormat: (TFormat)  inputFormat

Initializes a new instance of the FMLiveSwitchMediaSink`8 class.

Parameters
inputFormatThe input format.

◆ input

- (TIOutput) input

Gets the input.

◆ inputAddedWithInput:

- (void) inputAddedWithInput: (TIOutput)  input

Called when an input is added.

Parameters
inputThe input.

◆ inputDeactivated

- (bool) inputDeactivated

Gets whether input is deactivated.

◆ inputFormat

- (TFormat) inputFormat

Gets the input format.

◆ inputMuted

- (bool) inputMuted

Gets whether input is muted.

◆ inputRemovedWithInput:

- (void) inputRemovedWithInput: (TIOutput)  input

Called when an input is removed.

Parameters
inputThe input.

◆ inputRtpStreamId

- (NSString*) inputRtpStreamId

Gets the input RTP stream identifier.

If the input RTP stream identifier is null (unset), then getting this property returns the first valid output RTP stream identifier from the array of FMLiveSwitchMediaSink`8inputs, or null if they are all unset.

◆ inputs

- (NSMutableArray*) inputs

Gets the inputs.

◆ inputSynchronizationSource

- (long long) inputSynchronizationSource

Gets the input synchronization source.

If the input synchronization source is -1 (unset), then getting this property returns the first valid output synchronization source from the array of FMLiveSwitchMediaSink`8inputs, or -1 if they are all unset.

◆ isMixer

- (bool) isMixer

Gets whether this sink processes media from different sources.

◆ label

◆ maxInputBitrate

- (int) maxInputBitrate

Gets the maximum allowed input bitrate, in kbps.

A value of -1 indicates unset (no maximum). Returns -1 by default.

◆ maxInputEncoding

- (FMLiveSwitchEncodingInfo*) maxInputEncoding

Gets the maximum allowed input encoding.

Implemented in FMLiveSwitchVideoSink.

◆ mediaSink

+ (FMLiveSwitchMediaSink*) mediaSink

Initializes a new instance of the FMLiveSwitchMediaSink`8 class.

◆ mediaSinkWithInputFormat:

+ (FMLiveSwitchMediaSink*) mediaSinkWithInputFormat: (TFormat)  inputFormat

Initializes a new instance of the FMLiveSwitchMediaSink`8 class.

Parameters
inputFormatThe input format.

◆ minInputBitrate

- (int) minInputBitrate

Gets the minimum allowed input bitrate, in kbps.

A value of -1 indicates unset (no minimum). Returns -1 by default.

◆ minInputEncoding

- (FMLiveSwitchEncodingInfo*) minInputEncoding

Gets the minimum allowed input encoding.

Implemented in FMLiveSwitchVideoSink.

◆ muted

- (bool) muted

Gets whether input is muted.

Alias for FMLiveSwitchMediaSink`8inputMuted.

◆ output

Gets the current output.

◆ overConstrained

- (bool) overConstrained

Gets whether this sink is over-constrained.

A sink is over-constrained if it's input is over-constrained.

◆ overConstrainedBitrate

- (bool) overConstrainedBitrate

Gets whether the sink bitrate is over-constrained.

A sink bitrate is over-constrained if the input bitrate is over-constrained.

◆ overConstrainedInput

- (bool) overConstrainedInput

Gets whether the input is over-contrained.

An input is over-constrained if it's input bitrate is over-contrained.

Implemented in FMLiveSwitchVideoSink.

◆ overConstrainedInputBitrate

- (bool) overConstrainedInputBitrate

Gets whether the minimum allowed input bitrate exceeds the maximum allowed input bitrate.

◆ paused

- (bool) paused

Gets a value indicating whether this sink is paused.

◆ persistent

- (bool) persistent

Gets a value indicating whether this instance is persistent.

If true, this instance will not be destroyed unless FMLiveSwitchMediaSink`8destroy is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

◆ pipelineJson

- (NSString*) pipelineJson

Gets the pipeline JSON with this as the central point.

◆ pipelineJsonFromInput

- (NSString*) pipelineJsonFromInput

Gets the pipeline JSON from an input.

◆ processControlFrameResponse:

- (void) processControlFrameResponse: (FMLiveSwitchMediaControlFrame *)  controlFrameResponse

Processes a control frame response.

Parameters
controlFrameResponseThe control frame response.

◆ processControlFrameResponses:

- (void) processControlFrameResponses: (NSMutableArray *)  controlFrameResponses

Processes control frame responses.

Parameters
controlFrameResponsesThe control frame responses.

◆ processFrame:

- (bool) processFrame: (TFrame)  frame

Processes a frame.

Parameters
frameThe frame.

◆ processFramePolicy

- (FMLiveSwitchProcessFramePolicy) processFramePolicy

Gets the ProcessFramePolicy for this media input.

◆ processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:

- (FMLiveSwitchError*) processSdpMediaDescriptionFromInputWithMediaDescription: (FMLiveSwitchSdpMediaDescription *)  mediaDescription
isOffer: (bool)  isOffer
isLocalDescription: (bool)  isLocalDescription 

Processes a remote SDP media description from an output.

Parameters
mediaDescriptionThe media description.
isOfferif set to true [is offer].
isLocalDescriptionif set to true [is local description].

◆ processSinkStatsFromInputWithSinkStats:

- (void) processSinkStatsFromInputWithSinkStats: (FMLiveSwitchMediaSinkStats *)  sinkStats

Processes sink stats from an input.

Parameters
sinkStatsThe sink stats.

◆ processTrackStatsFromInputWithTrackStats:

- (void) processTrackStatsFromInputWithTrackStats: (FMLiveSwitchMediaTrackStats *)  trackStats

Processes track stats from an input.

Parameters
trackStatsThe track stats.

◆ raiseControlFrame:

- (void) raiseControlFrame: (FMLiveSwitchMediaControlFrame *)  controlFrame

Raises a control frame.

Parameters
controlFrameThe control frame.

◆ raiseControlFrame:inputs:

- (void) raiseControlFrame: (FMLiveSwitchMediaControlFrame *)  controlFrame
inputs: (NSMutableArray *)  inputs 

Raises a control frame.

Parameters
controlFrameThe control frame.
inputsThe inputs.

◆ raiseControlFrames:

- (void) raiseControlFrames: (NSMutableArray *)  controlFrames

Raises control frames.

Parameters
controlFramesThe control frames.

◆ raiseControlFrames:inputs:

- (void) raiseControlFrames: (NSMutableArray *)  controlFrames
inputs: (NSMutableArray *)  inputs 

Raises control frames.

Parameters
controlFramesThe control frames.
inputsThe inputs.

◆ raiseDisabledChange

- (void) raiseDisabledChange

Raises the OnDisabledChange event.

◆ removeInput:

- (bool) removeInput: (TIOutput)  input

Removes an input.

Parameters
inputThe input.

◆ removeInputs

- (void) removeInputs

Removes all inputs.

◆ removeInputs:

- (void) removeInputs: (NSMutableArray *)  inputs

Removes some inputs.

Parameters
inputsThe inputs.

◆ removeOnDisabledChange:

- (void) removeOnDisabledChange: (FMLiveSwitchAction0 *)  value

Removes a handler that is raised when the Disabled property changes state.

◆ removeOnPausedChange:

- (void) removeOnPausedChange: (FMLiveSwitchAction0 *)  value

Removes a handler that is raised when the Paused property changes state.

◆ removeOnProcessControlFrameResponses:

- (void) removeOnProcessControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Removes a handler that is raised when control frame responses are processed.

◆ removeOnProcessedControlFrameResponses:

- (void) removeOnProcessedControlFrameResponses: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Removes a handler that is raised when control frame responses have been processed.

◆ removeOnProcessedFrame:

- (void) removeOnProcessedFrame: (FMLiveSwitchAction1< TFrame > *)  value

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

◆ removeOnProcessFrame:

- (void) removeOnProcessFrame: (FMLiveSwitchAction1< TFrame > *)  value

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

◆ removeOnProcessFrameException:

- (void) removeOnProcessFrameException: (FMLiveSwitchAction2< TFrame, NSException * > *)  value

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

◆ removeOnRaiseControlFrames:

- (void) removeOnRaiseControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

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

◆ removeOnRaisedControlFrames:

- (void) removeOnRaisedControlFrames: (FMLiveSwitchAction1< NSMutableArray * > *)  value

Removes a handler that is raised when control frames have been raised.

◆ removeOnStateChange:

- (void) removeOnStateChange: (FMLiveSwitchAction1< TSink > *)  value

Removes a handler that is raised when the state changes.

◆ setDeactivated:

- (void) setDeactivated: (bool)  value

Sets a value indicating whether this sink is deactivated.

Deactivating a sink disables it until it is activated again. A deactivated sink will not process any frames. Alias for FMLiveSwitchMediaSink`8inputDeactivated.

◆ setDisabled:

- (void) setDisabled: (bool)  value

Sets a value indicating whether this sink is disabled.

A sink is automatically disabled if it is deactivated. A disabled sink will not accept frames raised by its inputs. Setting the value of MediaSink.Disabled is deprecated. Set MediaSink.Deactivated instead.

◆ setInput:

- (void) setInput: (TIOutput)  value

Sets the input.

◆ setInputDeactivated:

- (void) setInputDeactivated: (bool)  value

Sets whether input is deactivated.

◆ setInputMuted:

- (void) setInputMuted: (bool)  value

Sets whether input is muted.

◆ setInputRtpStreamId:

- (void) setInputRtpStreamId: (NSString *)  value

Sets the input RTP stream identifier.

If the input RTP stream identifier is null (unset), then getting this property returns the first valid output RTP stream identifier from the array of FMLiveSwitchMediaSink`8inputs, or null if they are all unset.

◆ setInputs:

- (void) setInputs: (NSMutableArray *)  value

Sets the inputs.

◆ setInputSynchronizationSource:

- (void) setInputSynchronizationSource: (long long)  value

Sets the input synchronization source.

If the input synchronization source is -1 (unset), then getting this property returns the first valid output synchronization source from the array of FMLiveSwitchMediaSink`8inputs, or -1 if they are all unset.

◆ setMaxInputBitrate:

- (void) setMaxInputBitrate: (int)  value

Sets the maximum allowed input bitrate, in kbps.

A value of -1 indicates unset (no maximum). Returns -1 by default.

◆ setMaxInputEncoding:

- (void) setMaxInputEncoding: (FMLiveSwitchEncodingInfo *)  value

Sets the maximum allowed input encoding.

Implemented in FMLiveSwitchVideoSink.

◆ setMinInputBitrate:

- (void) setMinInputBitrate: (int)  value

Sets the minimum allowed input bitrate, in kbps.

A value of -1 indicates unset (no minimum). Returns -1 by default.

◆ setMinInputEncoding:

- (void) setMinInputEncoding: (FMLiveSwitchEncodingInfo *)  value

Sets the minimum allowed input encoding.

Implemented in FMLiveSwitchVideoSink.

◆ setMuted:

- (void) setMuted: (bool)  value

Sets whether input is muted.

Alias for FMLiveSwitchMediaSink`8inputMuted.

◆ setOutput:

- (void) setOutput: (FMLiveSwitchSinkOutput *)  value

Sets the current output.

◆ setPersistent:

- (void) setPersistent: (bool)  value

Sets a value indicating whether this instance is persistent.

If true, this instance will not be destroyed unless FMLiveSwitchMediaSink`8destroy is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

◆ setProcessFramePolicy:

- (void) setProcessFramePolicy: (FMLiveSwitchProcessFramePolicy)  value

Sets the ProcessFramePolicy for this media input.

◆ setSystemDelay:

- (void) setSystemDelay: (long long)  value

Sets the system delay in ticks.

◆ state

- (FMLiveSwitchMediaSinkState) state

Gets the state.

◆ systemDelay

- (long long) systemDelay

Gets the system delay in ticks.

◆ trySetInputFormatWithFrame:

- (bool) trySetInputFormatWithFrame: (TFrame)  frame

Sets the input format, if not set, using the frame's last buffer format.

Parameters
frameThe frame.
Returns
true if the input format was set.

◆ updateDisabled

- (bool) updateDisabled

Updates the disabled property.

Member Data Documentation

◆ __pad0__

- __pad0__
protected

◆ FMLiveSwitchIInput

- FMLiveSwitchIInput
protected

◆ FMLiveSwitchIMediaElement