FMLiveSwitchMediaSource Class Reference

A media source. 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) - addOnProcessControlFrames:
 Adds a handler that is raised when control frames are processed. More...
 
(NSMutableArray *) - addOnProcessControlFramesWithBlock
 Adds a handler that is raised when control frames are processed. More...
 
(void) - addOnProcessControlFramesWithBlock:
 Adds a handler that is raised when control frames are processed. More...
 
(void) - addOnProcessedControlFrames:
 Adds a handler that is raised when control frames have been processed. More...
 
(NSMutableArray *) - addOnProcessedControlFramesWithBlock
 Adds a handler that is raised when control frames have been processed. More...
 
(void) - addOnProcessedControlFramesWithBlock:
 Adds a handler that is raised when control frames have been processed. More...
 
(void) - addOnRaiseControlFrameResponses:
 Adds a handler that is raised when control frame responses are raised. More...
 
(NSMutableArray *) - addOnRaiseControlFrameResponsesWithBlock
 Adds a handler that is raised when control frame responses are raised. More...
 
(void) - addOnRaiseControlFrameResponsesWithBlock:
 Adds a handler that is raised when control frame responses are raised. More...
 
(void) - addOnRaisedControlFrameResponses:
 Adds a handler that is raised when control frame responses have been raised. More...
 
(NSMutableArray *) - addOnRaisedControlFrameResponsesWithBlock
 Adds a handler that is raised when control frame responses have been raised. More...
 
(void) - addOnRaisedControlFrameResponsesWithBlock:
 Adds a handler that is raised when control frame responses have been raised. More...
 
(void) - addOnRaisedFrame:
 Adds a handler that is raised when a frame has been raised. More...
 
(TFrame) - addOnRaisedFrameWithBlock
 Adds a handler that is raised when a frame has been raised. More...
 
(void) - addOnRaisedFrameWithBlock:
 Adds a handler that is raised when a frame has been raised. More...
 
(void) - addOnRaiseFrame:
 Adds a handler that is raised when a frame is being raised. More...
 
(TFrame) - addOnRaiseFrameWithBlock
 Adds a handler that is raised when a frame is being raised. More...
 
(void) - addOnRaiseFrameWithBlock:
 Adds a handler that is raised when a frame is being raised. More...
 
(void) - addOnStateChange:
 Adds a handler that is raised when the state changes. More...
 
(TSource) - 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...
 
(void) - addOutput:
 Adds an output. More...
 
(void) - addOutputs:
 Adds some outputs. More...
 
(bool) - allowDiagnosticTimer
 Gets whether this media pipe is allowed to be timed. More...
 
(bool) - allowOutputRateTimer
 Gets whether this media pipe output rate is allowed to be timed. More...
 
(bool) - canChangeBitrate
 Gets whether this source can change the output bitrate. More...
 
(bool) - canPauseBitrate
 Gets whether this source can pause the output bitrate. More...
 
(FMLiveSwitchFuture< id > *) - changeInput:
 Changes the current input. More...
 
(NSString *) - content
 Gets the content descriptor. More...
 
(TIInputCollection) - createInputCollectionWithOutput:
 Creates an input collection. More...
 
(bool) - deactivated
 Gets a value indicating whether this source is deactivated. More...
 
(bool) - deactivatedByApplication
 Gets whether this source is deactivated because the application has requested it. More...
 
(bool) - deactivatedByServer
 Gets whether this source is deactivated because the server has requested it. 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 source is disabled. More...
 
(void) - doDestroy
 Destroys this instance. More...
 
(void) - doProcessControlFrames:
 Processes control frames. More...
 
(FMLiveSwitchError *) - doProcessSdpMediaDescription:isOffer:isLocalDescription:
 Processes a local SDP media description. More...
 
(void) - doProcessSourceStatsFromOutputWithSourceStats:
 Processes source stats from an output. More...
 
(void) - doProcessTrackStatsFromOutputWithTrackStats:
 Processes track stats from an output. More...
 
(FMLiveSwitchFuture< id > *) - doStart
 Starts this instance. More...
 
(FMLiveSwitchFuture< id > *) - doStop
 Stops this instance. More...
 
(int) - getCcmSequenceNumber
 Gets the CCM sequence number. More...
 
(FMLiveSwitchFuture< NSMutableArray * > *) - getInputs
 Gets the available inputs. More...
 
(long long) - getPipelineSystemDelayWithOutputFormat:
 Gets the total pipeline system delay in ticks for a given output format. More...
 
(bool) - hasOutput:
 Determines whether this source has the specified output. More...
 
(void) - incrementCcmSequenceNumber
 Increments the CCM sequence number. More...
 
(instancetype) - initWithOutputFormat:
 Initializes a new instance of the FMLiveSwitchMediaSource`8 class. More...
 
(FMLiveSwitchSourceInput *) - input
 Gets the current input. More...
 
(bool) - isDestroyed
 Gets whether the current state is Destroyed. More...
 
(bool) - isStarted
 Gets whether the current state is Started. More...
 
(bool) - isStopped
 Gets whether the current state is Stopped. More...
 
(NSString *) - label
 Gets a label that identifies this class. More...
 
(int) - maxOutputBitrate
 Gets the maximum allowed output bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - maxOutputEncoding
 Gets the maximum allowed output encoding. More...
 
(int) - minOutputBitrate
 Gets the minimum allowed output bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - minOutputEncoding
 Gets the minimum allowed output encoding. More...
 
(bool) - muted
 Gets whether output is muted. More...
 
(TIInput) - output
 Gets the output. More...
 
(void) - outputAddedWithOutput:
 Called when an output is added. More...
 
(bool) - outputCanProcessFrameWithOutput:
 Determines whether an output can process a frame from this pipe. More...
 
(bool) - outputDeactivated
 Gets whether output is deactivated. More...
 
(TFormat) - outputFormat
 Gets the output format. More...
 
(bool) - outputMuted
 Gets whether output is muted. More...
 
(void) - outputRemovedWithOutput:
 Called when an output is removed. More...
 
(NSString *) - outputRtpStreamId
 Gets the output RTP stream identifier. More...
 
(NSMutableArray *) - outputs
 Gets the outputs. More...
 
(bool) - outputSynchronizable
 Gets whether output is synchronizable. More...
 
(long long) - outputSynchronizationSource
 Gets the output synchronization source. More...
 
(bool) - overConstrained
 Gets whether this source is over-constrained. More...
 
(bool) - overConstrainedBitrate
 Gets whether the source bitrate is over-constrained. More...
 
(bool) - overConstrainedOutput
 Gets whether the output is over-constrained. More...
 
(bool) - overConstrainedOutputBitrate
 Gets whether the minimum allowed output bitrate exceeds the maximum allowed output bitrate. More...
 
(bool) - paused
 Gets a value indicating whether this source 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 *) - pipelineJsonFromOutput
 Gets the pipeline JSON from an output. More...
 
(void) - processControlFrame:
 Processes a control frame. More...
 
(void) - processControlFrames:
 Processes control frames. More...
 
(FMLiveSwitchError *) - processSdpMediaDescriptionFromOutputWithMediaDescription:isOffer:isLocalDescription:
 Processes a local SDP media description from an output. More...
 
(void) - processSourceStatsFromOutputWithSourceStats:
 Processes source stats from an output. More...
 
(void) - processTrackStatsFromOutputWithTrackStats:
 Processes track stats from an output. More...
 
(void) - raiseControlFrameResponse:
 Raises a control frame response. More...
 
(void) - raiseControlFrameResponse:outputs:
 Raises a control frame response. More...
 
(void) - raiseControlFrameResponses:
 Raises control frame responses. More...
 
(void) - raiseControlFrameResponses:outputs:
 Raises control frame responses. More...
 
(void) - raiseDisabledChange
 Raises the OnDisabledChange event. More...
 
(void) - raiseFrame:
 Raises a frame. 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) - removeOnProcessControlFrames:
 Removes a handler that is raised when control frames are processed. More...
 
(void) - removeOnProcessedControlFrames:
 Removes a handler that is raised when control frames have been processed. More...
 
(void) - removeOnRaiseControlFrameResponses:
 Removes a handler that is raised when control frame responses are raised. More...
 
(void) - removeOnRaisedControlFrameResponses:
 Removes a handler that is raised when control frame responses have been raised. More...
 
(void) - removeOnRaisedFrame:
 Removes a handler that is raised when a frame has been raised. More...
 
(void) - removeOnRaiseFrame:
 Removes a handler that is raised when a frame is being raised. More...
 
(void) - removeOnStateChange:
 Removes a handler that is raised when the state changes. More...
 
(bool) - removeOutput:
 Removes an output. More...
 
(void) - removeOutputs
 Removes all outputs. More...
 
(void) - removeOutputs:
 Removes some outputs. More...
 
(void) - setDeactivated:
 Sets a value indicating whether this source is deactivated. More...
 
(void) - setInput:
 Sets the current input. More...
 
(void) - setMaxOutputBitrate:
 Sets the maximum allowed output bitrate, in kbps. More...
 
(void) - setMaxOutputEncoding:
 Sets the maximum allowed output encoding. More...
 
(void) - setMinOutputBitrate:
 Sets the minimum allowed output bitrate, in kbps. More...
 
(void) - setMinOutputEncoding:
 Sets the minimum allowed output encoding. More...
 
(void) - setMuted:
 Sets whether output is muted. More...
 
(void) - setOutput:
 Sets the output. More...
 
(void) - setOutputDeactivated:
 Sets whether output is deactivated. More...
 
(void) - setOutputMuted:
 Sets whether output is muted. More...
 
(void) - setOutputRtpStreamId:
 Sets the output RTP stream identifier. More...
 
(void) - setOutputs:
 Sets the outputs. More...
 
(void) - setOutputSynchronizable:
 Sets whether output is synchronizable. More...
 
(void) - setOutputSynchronizationSource:
 Sets the output synchronization source. More...
 
(void) - setPersistent:
 Sets a value indicating whether this instance is persistent. More...
 
(void) - setSynchronizationSource:
 Sets the output synchronization source. More...
 
(void) - setSystemDelay:
 Sets the system delay in ticks. More...
 
(void) - setTargetOutputBitrate:
 Sets the target output bitrate, in kbps. More...
 
(void) - setTargetOutputEncoding:
 Sets the target output encoding. More...
 
(FMLiveSwitchFuture< id > *) - start
 Starts this instance. More...
 
(FMLiveSwitchMediaSourceState) - state
 Gets the state. More...
 
(FMLiveSwitchFuture< id > *) - stop
 Stops this instance. More...
 
(long long) - synchronizationSource
 Gets the output synchronization source. More...
 
(long long) - systemDelay
 Gets the system delay in ticks. More...
 
(int) - targetOutputBitrate
 Gets the target output bitrate, in kbps. More...
 
(FMLiveSwitchEncodingInfo *) - targetOutputEncoding
 Gets the target output encoding. More...
 
(bool) - updateDisabled
 Updates the disabled property. More...
 

Class Methods

(FMLiveSwitchMediaSource *) + mediaSourceWithOutputFormat:
 Initializes a new instance of the FMLiveSwitchMediaSource`8 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchMediaSourceBase<FMLiveSwitchIMediaOutput
 
 FMLiveSwitchIOutput
 
 FMLiveSwitchIMediaElement
 

Detailed Description

A media source.

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.

◆ addOnProcessControlFrames:

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

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

◆ addOnProcessControlFramesWithBlock

- (NSMutableArray*) addOnProcessControlFramesWithBlock

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

◆ addOnProcessControlFramesWithBlock:

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

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

◆ addOnProcessedControlFrames:

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

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

◆ addOnProcessedControlFramesWithBlock

- (NSMutableArray*) addOnProcessedControlFramesWithBlock

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

◆ addOnProcessedControlFramesWithBlock:

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

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

◆ addOnRaiseControlFrameResponses:

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

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

◆ addOnRaiseControlFrameResponsesWithBlock

- (NSMutableArray*) addOnRaiseControlFrameResponsesWithBlock

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

◆ addOnRaiseControlFrameResponsesWithBlock:

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

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

◆ addOnRaisedControlFrameResponses:

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

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

◆ addOnRaisedControlFrameResponsesWithBlock

- (NSMutableArray*) addOnRaisedControlFrameResponsesWithBlock

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

◆ addOnRaisedControlFrameResponsesWithBlock:

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

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

◆ addOnRaisedFrame:

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

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

◆ addOnRaisedFrameWithBlock

- (TFrame) addOnRaisedFrameWithBlock

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

◆ addOnRaisedFrameWithBlock:

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

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

◆ addOnRaiseFrame:

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

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

◆ addOnRaiseFrameWithBlock

- (TFrame) addOnRaiseFrameWithBlock

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

◆ addOnRaiseFrameWithBlock:

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

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

◆ addOnStateChange:

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

Adds a handler that is raised when the state changes.

◆ addOnStateChangeWithBlock

- (TSource) addOnStateChangeWithBlock

Adds a handler that is raised when the state changes.

◆ addOnStateChangeWithBlock:

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

Adds a handler that is raised when the state changes.

◆ addOutput:

- (void) addOutput: (TIInput)  output

Adds an output.

Parameters
outputThe output.

◆ addOutputs:

- (void) addOutputs: (NSMutableArray *)  outputs

Adds some outputs.

Parameters
outputsThe outputs.

◆ allowDiagnosticTimer

- (bool) allowDiagnosticTimer

Gets whether this media pipe is allowed to be timed.

◆ allowOutputRateTimer

- (bool) allowOutputRateTimer

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

◆ canChangeBitrate

- (bool) canChangeBitrate

Gets whether this source can change the output bitrate.

Implemented in FMLiveSwitchNullVideoSource, and FMLiveSwitchNullAudioSource.

◆ canPauseBitrate

- (bool) canPauseBitrate

Gets whether this source can pause the output bitrate.

Implemented in FMLiveSwitchNullVideoSource, and FMLiveSwitchNullAudioSource.

◆ changeInput:

- (FMLiveSwitchFuture<id>*) changeInput: (FMLiveSwitchSourceInput *)  input

Changes the current input.

Parameters
inputThe input.

◆ content

- (NSString*) content

Gets the content descriptor.

Implemented in FMLiveSwitchVideoSource.

◆ createInputCollectionWithOutput:

- (TIInputCollection) createInputCollectionWithOutput: (TIOutput)  output

Creates an input collection.

Parameters
outputThe output.

◆ deactivated

- (bool) deactivated

Gets a value indicating whether this source is deactivated.

Deactivating a source disables it until it is activated again. Upon reactivation, a pipe may remain disabled if its outputs are disabled. A deactivated source will not raise any frames. Alias for FMLiveSwitchMediaSource`8outputDeactivated.

◆ deactivatedByApplication

- (bool) deactivatedByApplication

Gets whether this source is deactivated because the application has requested it.

◆ deactivatedByServer

- (bool) deactivatedByServer

Gets whether this source is deactivated because the server has requested it.

◆ 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 source is disabled.

A source is automatically disabled if it is deactivated or if all of its outputs are disabled.

◆ doDestroy

◆ doProcessControlFrames:

- (void) doProcessControlFrames: (NSMutableArray *)  controlFrames

Processes control frames.

Parameters
controlFramesThe control frames.

◆ doProcessSdpMediaDescription:isOffer:isLocalDescription:

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

Processes a local SDP media description.

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

◆ doProcessSourceStatsFromOutputWithSourceStats:

- (void) doProcessSourceStatsFromOutputWithSourceStats: (FMLiveSwitchMediaSourceStats *)  sourceStats

Processes source stats from an output.

Parameters
sourceStatsThe source stats.

◆ doProcessTrackStatsFromOutputWithTrackStats:

- (void) doProcessTrackStatsFromOutputWithTrackStats: (FMLiveSwitchMediaTrackStats *)  trackStats

Processes track stats from an output.

Parameters
trackStatsThe track stats.

◆ doStart

◆ doStop

◆ getCcmSequenceNumber

- (int) getCcmSequenceNumber

Gets the CCM sequence number.

◆ getInputs

- (FMLiveSwitchFuture<NSMutableArray*>*) getInputs

Gets the available inputs.

Implemented in FMLiveSwitchMatroskaVideoSource, and FMLiveSwitchMatroskaAudioSource.

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

◆ hasOutput:

- (bool) hasOutput: (TIInput)  output

Determines whether this source has the specified output.

Parameters
outputThe output.

◆ incrementCcmSequenceNumber

- (void) incrementCcmSequenceNumber

Increments the CCM sequence number.

◆ initWithOutputFormat:

- (instancetype) initWithOutputFormat: (TFormat)  outputFormat

Initializes a new instance of the FMLiveSwitchMediaSource`8 class.

Parameters
outputFormatThe output format.

◆ input

Gets the current input.

◆ isDestroyed

- (bool) isDestroyed

Gets whether the current state is Destroyed.

◆ isStarted

- (bool) isStarted

Gets whether the current state is Started.

◆ isStopped

- (bool) isStopped

Gets whether the current state is Stopped.

◆ label

◆ maxOutputBitrate

- (int) maxOutputBitrate

Gets the maximum allowed output bitrate, in kbps.

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

◆ maxOutputEncoding

- (FMLiveSwitchEncodingInfo*) maxOutputEncoding

Gets the maximum allowed output encoding.

Implemented in FMLiveSwitchVideoSource.

◆ mediaSourceWithOutputFormat:

+ (FMLiveSwitchMediaSource*) mediaSourceWithOutputFormat: (TFormat)  outputFormat

Initializes a new instance of the FMLiveSwitchMediaSource`8 class.

Parameters
outputFormatThe output format.

◆ minOutputBitrate

- (int) minOutputBitrate

Gets the minimum allowed output bitrate, in kbps.

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

◆ minOutputEncoding

- (FMLiveSwitchEncodingInfo*) minOutputEncoding

Gets the minimum allowed output encoding.

Implemented in FMLiveSwitchVideoSource.

◆ muted

- (bool) muted

Gets whether output is muted.

Alias for FMLiveSwitchMediaSource`8outputMuted.

◆ output

- (TIInput) output

Gets the output.

◆ outputAddedWithOutput:

- (void) outputAddedWithOutput: (TIInput)  output

Called when an output is added.

Parameters
outputThe output.

◆ outputCanProcessFrameWithOutput:

- (bool) outputCanProcessFrameWithOutput: (TIInput)  output

Determines whether an output can process a frame from this pipe.

Parameters
outputThe output.

◆ outputDeactivated

- (bool) outputDeactivated

Gets whether output is deactivated.

◆ outputFormat

- (TFormat) outputFormat

Gets the output format.

◆ outputMuted

- (bool) outputMuted

Gets whether output is muted.

◆ outputRemovedWithOutput:

- (void) outputRemovedWithOutput: (TIInput)  output

Called when an output is removed.

Parameters
outputThe output.

◆ outputRtpStreamId

- (NSString*) outputRtpStreamId

Gets the output RTP stream identifier.

◆ outputs

- (NSMutableArray*) outputs

Gets the outputs.

◆ outputSynchronizable

- (bool) outputSynchronizable

Gets whether output is synchronizable.

◆ outputSynchronizationSource

- (long long) outputSynchronizationSource

Gets the output synchronization source.

◆ overConstrained

- (bool) overConstrained

Gets whether this source is over-constrained.

A source is over-constrained if it's output is over-constrained.

◆ overConstrainedBitrate

- (bool) overConstrainedBitrate

Gets whether the source bitrate is over-constrained.

A source bitrate is over-constrained if the output bitrate is over-constrained.

◆ overConstrainedOutput

- (bool) overConstrainedOutput

Gets whether the output is over-constrained.

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

Implemented in FMLiveSwitchVideoSource.

◆ overConstrainedOutputBitrate

- (bool) overConstrainedOutputBitrate

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

◆ paused

- (bool) paused

Gets a value indicating whether this source is paused.

◆ persistent

- (bool) persistent

Gets a value indicating whether this instance is persistent.

If true, this instance will not be destroyed unless FMLiveSwitchMediaSource`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.

◆ pipelineJsonFromOutput

- (NSString*) pipelineJsonFromOutput

Gets the pipeline JSON from an output.

◆ processControlFrame:

- (void) processControlFrame: (FMLiveSwitchMediaControlFrame *)  controlFrame

Processes a control frame.

Parameters
controlFrameThe control frame.

◆ processControlFrames:

- (void) processControlFrames: (NSMutableArray *)  controlFrames

Processes control frames.

Parameters
controlFramesThe control frames.

◆ processSdpMediaDescriptionFromOutputWithMediaDescription:isOffer:isLocalDescription:

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

Processes a local SDP media description from an output.

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

◆ processSourceStatsFromOutputWithSourceStats:

- (void) processSourceStatsFromOutputWithSourceStats: (FMLiveSwitchMediaSourceStats *)  sourceStats

Processes source stats from an output.

Parameters
sourceStatsThe source stats.

◆ processTrackStatsFromOutputWithTrackStats:

- (void) processTrackStatsFromOutputWithTrackStats: (FMLiveSwitchMediaTrackStats *)  trackStats

Processes track stats from an output.

Parameters
trackStatsThe track stats.

◆ raiseControlFrameResponse:

- (void) raiseControlFrameResponse: (FMLiveSwitchMediaControlFrame *)  controlFrameResponse

Raises a control frame response.

Parameters
controlFrameResponseThe control frame response.

◆ raiseControlFrameResponse:outputs:

- (void) raiseControlFrameResponse: (FMLiveSwitchMediaControlFrame *)  controlFrameResponse
outputs: (NSMutableArray *)  outputs 

Raises a control frame response.

Parameters
controlFrameResponseThe control frame response.
outputsThe outputs.

◆ raiseControlFrameResponses:

- (void) raiseControlFrameResponses: (NSMutableArray *)  controlFrameResponses

Raises control frame responses.

Parameters
controlFrameResponsesThe control frame responses.

◆ raiseControlFrameResponses:outputs:

- (void) raiseControlFrameResponses: (NSMutableArray *)  controlFrameResponses
outputs: (NSMutableArray *)  outputs 

Raises control frame responses.

Parameters
controlFrameResponsesThe control frame responses.
outputsThe outputs.

◆ raiseDisabledChange

- (void) raiseDisabledChange

Raises the OnDisabledChange event.

◆ raiseFrame:

- (void) raiseFrame: (TFrame)  frame

Raises a frame.

Parameters
frameThe frame.

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

◆ removeOnProcessControlFrames:

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

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

◆ removeOnProcessedControlFrames:

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

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

◆ removeOnRaiseControlFrameResponses:

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

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

◆ removeOnRaisedControlFrameResponses:

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

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

◆ removeOnRaisedFrame:

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

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

◆ removeOnRaiseFrame:

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

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

◆ removeOnStateChange:

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

Removes a handler that is raised when the state changes.

◆ removeOutput:

- (bool) removeOutput: (TIInput)  output

Removes an output.

Parameters
outputThe output.

◆ removeOutputs

- (void) removeOutputs

Removes all outputs.

◆ removeOutputs:

- (void) removeOutputs: (NSMutableArray *)  outputs

Removes some outputs.

Parameters
outputsThe outputs.

◆ setDeactivated:

- (void) setDeactivated: (bool)  value

Sets a value indicating whether this source is deactivated.

Deactivating a source disables it until it is activated again. Upon reactivation, a pipe may remain disabled if its outputs are disabled. A deactivated source will not raise any frames. Alias for FMLiveSwitchMediaSource`8outputDeactivated.

◆ setInput:

- (void) setInput: (FMLiveSwitchSourceInput *)  value

Sets the current input.

◆ setMaxOutputBitrate:

- (void) setMaxOutputBitrate: (int)  value

Sets the maximum allowed output bitrate, in kbps.

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

◆ setMaxOutputEncoding:

- (void) setMaxOutputEncoding: (FMLiveSwitchEncodingInfo *)  value

Sets the maximum allowed output encoding.

Implemented in FMLiveSwitchVideoSource.

◆ setMinOutputBitrate:

- (void) setMinOutputBitrate: (int)  value

Sets the minimum allowed output bitrate, in kbps.

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

◆ setMinOutputEncoding:

- (void) setMinOutputEncoding: (FMLiveSwitchEncodingInfo *)  value

Sets the minimum allowed output encoding.

Implemented in FMLiveSwitchVideoSource.

◆ setMuted:

- (void) setMuted: (bool)  value

Sets whether output is muted.

Alias for FMLiveSwitchMediaSource`8outputMuted.

◆ setOutput:

- (void) setOutput: (TIInput)  value

Sets the output.

◆ setOutputDeactivated:

- (void) setOutputDeactivated: (bool)  value

Sets whether output is deactivated.

◆ setOutputMuted:

- (void) setOutputMuted: (bool)  value

Sets whether output is muted.

◆ setOutputRtpStreamId:

- (void) setOutputRtpStreamId: (NSString *)  value

Sets the output RTP stream identifier.

◆ setOutputs:

- (void) setOutputs: (NSMutableArray *)  value

Sets the outputs.

◆ setOutputSynchronizable:

- (void) setOutputSynchronizable: (bool)  value

Sets whether output is synchronizable.

◆ setOutputSynchronizationSource:

- (void) setOutputSynchronizationSource: (long long)  value

Sets the output synchronization source.

◆ setPersistent:

- (void) setPersistent: (bool)  value

Sets a value indicating whether this instance is persistent.

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

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the output synchronization source.

Alias for FMLiveSwitchMediaSource`8outputSynchronizationSource.

◆ setSystemDelay:

- (void) setSystemDelay: (long long)  value

Sets the system delay in ticks.

◆ setTargetOutputBitrate:

- (void) setTargetOutputBitrate: (int)  value

Sets the target output bitrate, in kbps.

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

◆ setTargetOutputEncoding:

- (void) setTargetOutputEncoding: (FMLiveSwitchEncodingInfo *)  value

Sets the target output encoding.

Implemented in FMLiveSwitchVideoSource.

◆ start

- (FMLiveSwitchFuture<id>*) start

Starts this instance.

◆ state

- (FMLiveSwitchMediaSourceState) state

Gets the state.

◆ stop

- (FMLiveSwitchFuture<id>*) stop

Stops this instance.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the output synchronization source.

Alias for FMLiveSwitchMediaSource`8outputSynchronizationSource.

◆ systemDelay

- (long long) systemDelay

Gets the system delay in ticks.

◆ targetOutputBitrate

- (int) targetOutputBitrate

Gets the target output bitrate, in kbps.

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

◆ targetOutputEncoding

- (FMLiveSwitchEncodingInfo*) targetOutputEncoding

Gets the target output encoding.

Implemented in FMLiveSwitchVideoSource.

◆ updateDisabled

- (bool) updateDisabled

Updates the disabled property.

Member Data Documentation

◆ __pad0__

- __pad0__
protected

◆ FMLiveSwitchIMediaElement

◆ FMLiveSwitchIOutput

- FMLiveSwitchIOutput
protected