A media input. More...

Instance Methods
(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)	- addOnProcessFrame:
	Adds a handler that is raised when a frame is processed. More...

(FMLiveSwitchMediaFrame *)	- addOnProcessFrameWithBlock
	Adds a handler that is raised when a frame is processed. More...

(void)	- addOnProcessFrameWithBlock:
	Adds a handler that is raised when a frame is 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...

(long long)	- getPipelineSystemDelayWithOutputFormat:
	Gets the total pipeline system delay in ticks for a given media format. More...

(bool)	- inputDeactivated
	Gets whether input is deactivated. More...

(bool)	- inputMuted
	Gets whether input is muted. More...

(NSString *)	- inputRtpStreamId
	Gets the input RTP stream identifier. More...

(long long)	- inputSynchronizationSource
	Gets the input synchronization source. 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...

(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 local SDP media description from an input. More...

(void)	- processSinkStatsFromInputWithSinkStats:
	Processes sink stats from an input. More...

(void)	- processTrackStatsFromInputWithTrackStats:
	Processes track stats from an input. 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)	- removeOnProcessFrame:
	Removes a handler that is raised when a frame is processed. More...

(void)	- removeOnRaiseControlFrames:
	Removes a handler that is raised when control frames are raised. More...

(void)	- setInputRtpStreamId:
	Sets the input RTP stream identifier. More...

(void)	- setInputSynchronizationSource:
	Sets the input synchronization source. More...

(void)	- setProcessFramePolicy:
	Sets the ProcessFramePolicy for this media input. More...

(long long)	- systemDelay
	Gets the system delay in ticks. More...

Instance Methods inherited from <FMLiveSwitchIInput>
(void)	- addInput:
	Adds an input. More...

(void)	- addInputs:
	Adds some inputs. More...

(NSObject< FMLiveSwitchIOutput > *)	- input
	Gets the input. More...

(FMLiveSwitchMediaFormat *)	- inputFormat
	Gets the input format. More...

(NSMutableArray *)	- inputs
	Gets the inputs. More...

(NSString *)	- pipelineJsonFromInput
	Gets the pipeline JSON from an input. More...

(bool)	- removeInput:
	Removes an input. More...

(void)	- removeInputs
	Removes all inputs. More...

(void)	- removeInputs:
	Removes some inputs. More...

Instance Methods inherited from <FMLiveSwitchIElement>
(NSString *)	- externalId
	Gets the external identifier. More...

(NSString *)	- id
	Gets the identifier. More...

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

(void)	- setExternalId:
	Sets the external identifier. More...

Instance Methods inherited from <FMLiveSwitchIMediaElement>
(bool)	- deactivated
	Gets a value indicating whether this instance is deactivated. More...

(bool)	- destroy
	Destroys this instance. More...

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

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

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

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

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

(void)	- setDeactivated:
	Sets a value indicating whether this instance is deactivated. More...

(void)	- setMuted:
	Sets a value indicating whether this instance is muted. More...

Detailed Description

A media input.

Method Documentation

◆ 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 *) 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.

◆ addOnProcessFrame:

- (void) addOnProcessFrame: (FMLiveSwitchAction1 *) value

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

◆ addOnProcessFrameWithBlock

- (FMLiveSwitchMediaFrame*) addOnProcessFrameWithBlock

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

◆ addOnProcessFrameWithBlock:

- (void) addOnProcessFrameWithBlock: (void(^)(FMLiveSwitchMediaFrame *)) valueBlock

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

◆ addOnRaiseControlFrames:

- (void) addOnRaiseControlFrames: (FMLiveSwitchAction1 *) 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.

◆ getPipelineSystemDelayWithOutputFormat:

- (long long) getPipelineSystemDelayWithOutputFormat: (FMLiveSwitchMediaFormat *) outputFormat

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

Parameters

outputFormat The output format.

Returns: The total pipeline system delay in ticks.

◆ inputDeactivated

- (bool) inputDeactivated

Gets whether input is deactivated.

◆ inputMuted

- (bool) inputMuted

Gets whether input is muted.

◆ inputRtpStreamId

- (NSString*) inputRtpStreamId

Gets the input RTP stream identifier.

◆ inputSynchronizationSource

- (long long) inputSynchronizationSource

Gets the input synchronization source.

◆ maxInputBitrate

- (int) maxInputBitrate

Gets the maximum allowed input bitrate, in kbps.

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

◆ maxInputEncoding

- (FMLiveSwitchEncodingInfo*) maxInputEncoding

Gets the maximum allowed input encoding.

◆ minInputBitrate

- (int) minInputBitrate

Gets the minimum allowed input bitrate, in kbps.

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

◆ minInputEncoding

- (FMLiveSwitchEncodingInfo*) minInputEncoding

Gets the minimum allowed input encoding.

◆ processControlFrameResponses:

- (void) processControlFrameResponses: (NSMutableArray *) controlFrameResponses

Processes control frame responses.

Parameters

controlFrameResponses The control frame responses.

◆ processFrame:

- (bool) processFrame: (FMLiveSwitchMediaFrame *) frame

Processes a frame.

Parameters

frame The 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 local SDP media description from an input.

Parameters

mediaDescription	The media description.
isOffer	if set to `true` [is offer].
isLocalDescription	if set to `true` [is local description].

◆ processSinkStatsFromInputWithSinkStats:

- (void) processSinkStatsFromInputWithSinkStats: (FMLiveSwitchMediaSinkStats *) sinkStats

Processes sink stats from an input.

Parameters

sinkStats The stats.

◆ processTrackStatsFromInputWithTrackStats:

- (void) processTrackStatsFromInputWithTrackStats: (FMLiveSwitchMediaTrackStats *) trackStats

Processes track stats from an input.

Parameters

trackStats The stats.

◆ 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 *) value

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

◆ removeOnProcessFrame:

- (void) removeOnProcessFrame: (FMLiveSwitchAction1 *) value

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

◆ removeOnRaiseControlFrames:

- (void) removeOnRaiseControlFrames: (FMLiveSwitchAction1 *) value

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

◆ setInputRtpStreamId:

- (void) setInputRtpStreamId: (NSString *) value

Sets the input RTP stream identifier.

◆ setInputSynchronizationSource:

- (void) setInputSynchronizationSource: (long long) value

Sets the input synchronization source.

◆ setProcessFramePolicy:

- (void) setProcessFramePolicy: (FMLiveSwitchProcessFramePolicy) value

Sets the ProcessFramePolicy for this media input.

◆ systemDelay

- (long long) systemDelay

Gets the system delay in ticks.

Instance Methods

Detailed Description

Method Documentation

◆ addOnDisabledChange:

◆ addOnPausedChange:

◆ addOnProcessControlFrameResponses:

◆ addOnProcessControlFrameResponsesWithBlock

◆ addOnProcessControlFrameResponsesWithBlock:

◆ addOnProcessFrame:

◆ addOnProcessFrameWithBlock

◆ addOnProcessFrameWithBlock:

◆ addOnRaiseControlFrames:

◆ addOnRaiseControlFramesWithBlock

◆ addOnRaiseControlFramesWithBlock:

◆ getPipelineSystemDelayWithOutputFormat:

◆ inputDeactivated

◆ inputMuted

◆ inputRtpStreamId

◆ inputSynchronizationSource

◆ maxInputBitrate

◆ maxInputEncoding

◆ minInputBitrate

◆ minInputEncoding

◆ processControlFrameResponses:

◆ processFrame:

◆ processFramePolicy

◆ processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:

◆ processSinkStatsFromInputWithSinkStats:

◆ processTrackStatsFromInputWithTrackStats:

◆ removeOnDisabledChange:

◆ removeOnPausedChange:

◆ removeOnProcessControlFrameResponses:

◆ removeOnProcessFrame:

◆ removeOnRaiseControlFrames:

◆ setInputRtpStreamId:

◆ setInputSynchronizationSource:

◆ setProcessFramePolicy:

◆ systemDelay