FMLiveSwitchVideoEncoder Class Reference

A video encoder. More...

Instance Methods

(void) - addOnBitrateChange:
 Adds a handler that is raised when the bitrate changes. More...
 
(void) - addOnBitrateChangeWithCaller:
 Adds a handler that is raised when the bitrate changes. More...
 
(FMLiveSwitchVideoEncoder *) - addOnBitrateChangeWithCallerWithBlock
 Adds a handler that is raised when the bitrate changes. More...
 
(void) - addOnBitrateChangeWithCallerWithBlock:
 Adds a handler that is raised when the bitrate changes. More...
 
(int) - bitrate
 Gets the current bitrate, in kbps. More...
 
(bool) - canChangeBitrate
 Gets whether this pipe can change the output bitrate. More...
 
(void) - doProcessControlFrames:
 Processes the control frames. More...
 
(void) - doProcessTrackStatsFromOutputWithTrackStats:
 Processes track stats from an output. More...
 
(bool) - forceKeyFrame
 Gets a value indicating whether a keyframe should be forced. More...
 
(int) - frameHeight
 Gets the last frame height. More...
 
(double) - frameRate
 Gets the current frame rate. More...
 
(long long) - framesEncoded
 Gets the number of encoded frames. More...
 
(int) - frameWidth
 Gets the last frame width. More...
 
(instancetype) - initWithInputFormat:outputFormat:
 Initializes a new instance of the FMLiveSwitchVideoEncoder class. More...
 
(int) - maxBitrate
 Gets the maximum bitrate, in kbps. More...
 
(int) - maxCodecBitrate
 Gets the maximum possible codec bitrate, in kbps. More...
 
(int) - maxOutputBitrate
 Gets the maximum output bitrate, in kbps. More...
 
(int) - minBitrate
 Gets the minimum bitrate, in kbps. More...
 
(int) - minCodecBitrate
 Gets the minimum possible codec bitrate, in kbps. More...
 
(int) - minOutputBitrate
 Gets the minimum output bitrate, in kbps. More...
 
(bool) - processFrame:
 Processes the frame. More...
 
(void) - raiseFrame:
 Raises the frame. More...
 
(void) - removeOnBitrateChange:
 Removes a handler that is raised when the bitrate changes. More...
 
(void) - removeOnBitrateChangeWithCaller:
 Removes a handler that is raised when the bitrate changes. More...
 
(void) - setBitrate:
 Sets the current bitrate, in kbps. More...
 
(void) - setForceKeyFrame:
 Sets a value indicating whether a keyframe should be forced. More...
 
(void) - setMaxBitrate:
 Sets the maximum bitrate, in kbps. More...
 
(void) - setMaxOutputBitrate:
 Sets the maximum output bitrate, in kbps. More...
 
(void) - setMinBitrate:
 Sets the minimum bitrate, in kbps. More...
 
(void) - setMinOutputBitrate:
 Sets the minimum output bitrate, in kbps. More...
 
(void) - setStaticOutputBitrate:
 Sets whether minOutputBitrate and maxOutputBitrate should return minCodecBitrate and maxCodecBitrate, respectively, or response to changes in minBitrate and maxBitrate. More...
 
(void) - setTargetBitrate:
 Sets the target bitrate, in kbps. More...
 
(void) - setTargetOutputBitrate:
 Sets the target output bitrate, in kbps. More...
 
(bool) - staticOutputBitrate
 Gets whether minOutputBitrate and maxOutputBitrate should return minCodecBitrate and maxCodecBitrate, respectively, or response to changes in minBitrate and maxBitrate. More...
 
(int) - targetBitrate
 Gets the target bitrate, in kbps. More...
 
(int) - targetOutputBitrate
 Gets the target output bitrate, in kbps. More...
 
- Instance Methods inherited from FMLiveSwitchVideoPipe
(void) - addOnProcessSizeChange:
 Adds a handler that is raised when a frame is about to be processed with a size that does not match the prior frame. More...
 
(FMLiveSwitchSize *) - addOnProcessSizeChangeWithBlock
 Adds a handler that is raised when a frame is about to be processed with a size that does not match the prior frame. More...
 
(void) - addOnProcessSizeChangeWithBlock:
 Adds a handler that is raised when a frame is about to be processed with a size that does not match the prior frame. More...
 
(void) - addOnRaiseSizeChange:
 Adds a handler that is raised when a frame is about to be raised with a size that does not match the prior frame. More...
 
(FMLiveSwitchSize *) - addOnRaiseSizeChangeWithBlock
 Adds a handler that is raised when a frame is about to be raised with a size that does not match the prior frame. More...
 
(void) - addOnRaiseSizeChangeWithBlock:
 Adds a handler that is raised when a frame is about to be raised with a size that does not match the prior frame. More...
 
(NSString *) - content
 Gets the content descriptor. More...
 
(FMLiveSwitchVideoFrame *) - createFrameWithBuffer:
 Creates a frame. More...
 
(FMLiveSwitchIVideoInputCollection *) - createInputCollectionWithOutput:
 Creates an input collection. More...
 
(FMLiveSwitchIVideoOutputCollection *) - createOutputCollectionWithInput:
 Creates an output collection. More...
 
(void) - doPreProcessFrame:inputBuffer:
 Pre-processes a frame. More...
 
(instancetype) - initWithOutputFormat:
 Initializes a new instance of the FMLiveSwitchVideoPipe class. More...
 
(FMLiveSwitchEncodingInfo *) - maxInputEncoding
 Gets the maximum allowed input encoding. More...
 
(double) - maxInputFrameRate
 Gets the maximum allowed input frame-rate, in fps. More...
 
(int) - maxInputHeight
 Gets the maximum allowed input height. More...
 
(double) - maxInputScale
 Gets the maximum allowed input scale. More...
 
(FMLiveSwitchSize *) - maxInputSize
 Gets the maximum allowed input size. More...
 
(int) - maxInputWidth
 Gets the maximum allowed input width. More...
 
(FMLiveSwitchEncodingInfo *) - maxOutputEncoding
 Gets the maximum allowed output encoding. More...
 
(double) - maxOutputFrameRate
 Gets the maximum allowed output frame-rate, in fps. More...
 
(int) - maxOutputHeight
 Gets the maximum allowed output height. More...
 
(double) - maxOutputScale
 Gets the maximum allowed output scale. More...
 
(FMLiveSwitchSize *) - maxOutputSize
 Gets the maximum allowed output size. More...
 
(int) - maxOutputWidth
 Gets the maximum allowed output width. More...
 
(FMLiveSwitchEncodingInfo *) - minInputEncoding
 Gets the minimum allowed input encoding. More...
 
(double) - minInputFrameRate
 Gets the minimum allowed input frame-rate, in fps. More...
 
(int) - minInputHeight
 Gets the minimum allowed input height. More...
 
(double) - minInputScale
 Gets the minimum allowed input scale. More...
 
(FMLiveSwitchSize *) - minInputSize
 Gets the minimum allowed input size. More...
 
(int) - minInputWidth
 Gets the minimum allowed input width. More...
 
(FMLiveSwitchEncodingInfo *) - minOutputEncoding
 Gets the minimum allowed output encoding. More...
 
(double) - minOutputFrameRate
 Gets the minimum allowed output frame-rate, in fps. More...
 
(int) - minOutputHeight
 Gets the minimum allowed output height. More...
 
(double) - minOutputScale
 Gets the minimum allowed output scale. More...
 
(FMLiveSwitchSize *) - minOutputSize
 Gets the minimum allowed output size. More...
 
(int) - minOutputWidth
 Gets the minimum allowed output width. More...
 
(bool) - outputCanProcessFrameWithOutput:
 Determines whether an output can process a frame from this pipe. More...
 
(bool) - overConstrainedFrameRate
 Gets whether the pipe frame-rate is over-constrained. More...
 
(bool) - overConstrainedHeight
 Gets whether the pipe height is over-constrained. More...
 
(bool) - overConstrainedInput
 Gets whether the input is over-contrained. More...
 
(bool) - overConstrainedInputFrameRate
 Gets whether the minimum allowed input frame-rate exceeds the maximum allowed input frame-rate. More...
 
(bool) - overConstrainedInputHeight
 Gets whether the minimum allowed input height exceeds the maximum allowed input height. More...
 
(bool) - overConstrainedInputScale
 Gets whether the minimum allowed input scale exceeds the maximum allowed input scale. More...
 
(bool) - overConstrainedInputSize
 Gets whether the minimum allowed input size exceeds the maximum allowed input size. More...
 
(bool) - overConstrainedInputWidth
 Gets whether the minimum allowed input width exceeds the maximum allowed input width. More...
 
(bool) - overConstrainedOutput
 Gets whether the output is over-contrained. More...
 
(bool) - overConstrainedOutputFrameRate
 Gets whether the minimum allowed output frame-rate exceeds the maximum allowed output frame-rate. More...
 
(bool) - overConstrainedOutputHeight
 Gets whether the minimum allowed output height exceeds the maximum allowed output height. More...
 
(bool) - overConstrainedOutputScale
 Gets whether the minimum allowed output scale exceeds the maximum allowed output scale. More...
 
(bool) - overConstrainedOutputSize
 Gets whether the minimum allowed output size exceeds the maximum allowed output size. More...
 
(bool) - overConstrainedOutputWidth
 Gets whether the minimum allowed output width exceeds the maximum allowed output width. More...
 
(bool) - overConstrainedScale
 Gets whether the pipe scale is over-constrained. More...
 
(bool) - overConstrainedSize
 Gets whether the pipe size is over-constrained. More...
 
(bool) - overConstrainedWidth
 Gets whether the pipe width is over-constrained. More...
 
(void) - removeOnProcessSizeChange:
 Removes a handler that is raised when a frame is about to be processed with a size that does not match the prior frame. More...
 
(void) - removeOnRaiseSizeChange:
 Removes a handler that is raised when a frame is about to be raised with a size that does not match the prior frame. More...
 
(void) - setMaxInputEncoding:
 Sets the maximum allowed input encoding. More...
 
(void) - setMaxInputFrameRate:
 Sets the maximum allowed input frame-rate, in fps. More...
 
(void) - setMaxInputScale:
 Sets the maximum allowed input scale. More...
 
(void) - setMaxInputSize:
 Sets the maximum allowed input size. More...
 
(void) - setMaxOutputEncoding:
 Sets the maximum allowed output encoding. More...
 
(void) - setMaxOutputFrameRate:
 Sets the maximum allowed output frame-rate, in fps. More...
 
(void) - setMaxOutputScale:
 Sets the maximum allowed output scale. More...
 
(void) - setMaxOutputSize:
 Sets the maximum allowed output size. More...
 
(void) - setMinInputEncoding:
 Sets the minimum allowed input encoding. More...
 
(void) - setMinInputFrameRate:
 Sets the minimum allowed input frame-rate, in fps. More...
 
(void) - setMinInputScale:
 Sets the minimum allowed input scale. More...
 
(void) - setMinInputSize:
 Sets the minimum allowed input size. More...
 
(void) - setMinOutputEncoding:
 Sets the minimum allowed output encoding. More...
 
(void) - setMinOutputFrameRate:
 Sets the minimum allowed output frame-rate, in fps. More...
 
(void) - setMinOutputScale:
 Sets the minimum allowed output scale. More...
 
(void) - setMinOutputSize:
 Sets the minimum allowed output size. More...
 
(void) - setTargetOutputEncoding:
 Sets the target output encoding. More...
 
(void) - setTargetOutputFrameRate:
 Sets the target output frame-rate, in fps. More...
 
(void) - setTargetOutputScale:
 Sets the target output scale. More...
 
(void) - setTargetOutputSize:
 Sets the target output size. More...
 
(void) - setVideoType:
 Sets the video type. More...
 
(FMLiveSwitchEncodingInfo *) - targetOutputEncoding
 Gets the target output encoding. More...
 
(double) - targetOutputFrameRate
 Gets the target output frame-rate, in fps. More...
 
(int) - targetOutputHeight
 Gets the target output height. More...
 
(double) - targetOutputScale
 Gets the target output scale. More...
 
(FMLiveSwitchSize *) - targetOutputSize
 Gets the target output size. More...
 
(int) - targetOutputWidth
 Gets the target output width. More...
 
(FMLiveSwitchVideoType) - videoType
 Gets the video type. More...
 
- Instance Methods inherited from FMLiveSwitchMediaPipe
(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) - addOnDisabledChangeWithCaller:
 Adds a handler that is raised when the Disabled property changes state. More...
 
(id- addOnDisabledChangeWithCallerWithBlock
 Adds a handler that is raised when the Disabled property changes state. More...
 
(void) - addOnDisabledChangeWithCallerWithBlock:
 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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) - 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...
 
(TPipe) - 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) - allowDurationTimer
 Gets whether this media pipe duration is allowed to be timed. More...
 
(bool) - allowInputRateTimer
 Gets whether this media pipe input rate is allowed to be timed. More...
 
(bool) - allowOutputRateTimer
 Gets whether this media pipe output rate is allowed to be timed. More...
 
(bool) - canPauseBitrate
 Gets whether this pipe can pause the output bitrate. More...
 
(TFrame) - createFrameWithBuffer:
 Creates a frame. More...
 
(TIInputCollection) - createInputCollectionWithOutput:
 Creates an input collection. More...
 
(TIOutputCollection) - createOutputCollectionWithInput:
 Creates an output collection. More...
 
(bool) - deactivated
 Gets a value indicating whether this pipe is deactivated. More...
 
(bool) - deactivatedByApplication
 Gets whether this pipe is deactivated because the application has requested it. More...
 
(bool) - deactivatedByServer
 Gets whether this pipe 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 pipe 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 an SDP media description. More...
 
(void) - doProcessSinkStatsFromInputWithSinkStats:
 Processes sink stats from an input. More...
 
(void) - doProcessSourceStatsFromOutputWithSourceStats:
 Processes source stats from an output. More...
 
(void) - doProcessTrackStatsFromInputWithTrackStats:
 Processes track stats from an input. More...
 
(NSString *) - externalId
 Gets the external identifier. More...
 
(int) - getCcmSequenceNumber
 Gets the CCM sequence number. 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...
 
(bool) - hasOutput:
 Determines whether this pipe has the specified output. More...
 
(NSString *) - id
 Gets the identifier. More...
 
(void) - incrementCcmSequenceNumber
 Increments the CCM sequence number. More...
 
(instancetype) - initWithInputFormat:outputFormat:
 Initializes a new instance of the FMLiveSwitchMediaPipe`9 class. More...
 
(instancetype) - initWithOutputFormat:
 Initializes a new instance of the FMLiveSwitchMediaPipe`9 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 pipe 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...
 
(int) - minInputBitrate
 Gets the minimum allowed output bitrate, in kbps. 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 pipe is over-constrained. More...
 
(bool) - overConstrainedBitrate
 Gets whether the pipe bitrate is over-constrained. More...
 
(bool) - overConstrainedInputBitrate
 Gets whether the minimum allowed input bitrate exceeds the maximum allowed input bitrate. 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 pipe 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 *) - pipelineJsonBase
 Gets the pipeline JSON base. More...
 
(NSString *) - pipelineJsonFromInput
 Gets the pipeline JSON from an input. More...
 
(NSString *) - pipelineJsonFromOutput
 Gets the pipeline JSON from an output. More...
 
(NSString *) - pipelineJsonInputs
 Gets the pipeline JSON inputs. More...
 
(NSString *) - pipelineJsonOutputs
 Gets the pipeline JSON outputs. More...
 
(FMLiveSwitchFuture< TBuffer > *) - processBuffer:
 Processes a buffer, returning a future that is resolved when processing is complete. More...
 
(void) - processControlFrame:
 Processes a control frame. More...
 
(void) - processControlFrameResponse:
 Processes a control frame response. More...
 
(void) - processControlFrameResponses:
 Processes control frame responses. More...
 
(void) - processControlFrames:
 Processes control frames. More...
 
(bool) - processFrame:
 Processes a frame. More...
 
(FMLiveSwitchProcessFramePolicy) - processFramePolicy
 Gets the ProcessFramePolicy for this media input. More...
 
(FMLiveSwitchError *) - processSdpMediaDescriptionFromInputWithMediaDescription:isOffer:isLocalDescription:
 Processes an SDP media description from an input. More...
 
(FMLiveSwitchError *) - processSdpMediaDescriptionFromOutputWithMediaDescription:isOffer:isLocalDescription:
 Processes an SDP media description from an output. More...
 
(void) - processSinkStatsFromInputWithSinkStats:
 Processes sink stats from an input. More...
 
(void) - processSourceStatsFromOutputWithSourceStats:
 Processes source stats from an output. More...
 
(void) - processTrackStatsFromInputWithTrackStats:
 Processes track stats from an input. More...
 
(void) - processTrackStatsFromOutputWithTrackStats:
 Processes track stats from an output. More...
 
(void) - raiseControlFrame:
 Raises a control frame. More...
 
(void) - raiseControlFrame:inputs:
 Raises a control frame. 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) - raiseControlFrames:
 Raises control frames. More...
 
(void) - raiseControlFrames:inputs:
 Raises control frames. More...
 
(void) - raiseDisabledChange
 Raises the OnDisabledChange event. More...
 
(void) - raiseFrame:
 Raises a frame. 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) - removeOnDisabledChangeWithCaller:
 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) - removeOnProcessControlFrames:
 Removes a handler that is raised when control frames are processed. More...
 
(void) - removeOnProcessedControlFrameResponses:
 Removes a handler that is raised when control frame responses have been processed. More...
 
(void) - removeOnProcessedControlFrames:
 Removes a handler that is raised when control frames 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) - removeOnRaiseControlFrameResponses:
 Removes a handler that is raised when control frame responses are raised. More...
 
(void) - removeOnRaiseControlFrames:
 Removes a handler that is raised when control frames are raised. More...
 
(void) - removeOnRaisedControlFrameResponses:
 Removes a handler that is raised when control frame responses have been raised. More...
 
(void) - removeOnRaisedControlFrames:
 Removes a handler that is raised when control frames 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 pipe is deactivated. More...
 
(void) - setExternalId:
 Sets the external identifier. 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) - setMinInputBitrate:
 Sets the minimum allowed output bitrate, in kbps. 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) - setProcessFramePolicy:
 Sets the ProcessFramePolicy for this media input. More...
 
(void) - setSynchronizationSource:
 Sets the output synchronization source. More...
 
(void) - setSystemDelay:
 Sets the system delay in ticks. More...
 
(void) - setTag:
 Sets optional data to associate with this instance. More...
 
(FMLiveSwitchMediaPipeState) - state
 Gets the state. More...
 
(long long) - synchronizationSource
 Gets the output synchronization source. More...
 
(long long) - systemDelay
 Gets the system delay in ticks. More...
 
(NSString *) - tag
 Gets optional data to associate with this instance. More...
 
(bool) - trySetInputFormatWithFrame:
 Sets the input format, if not set, using the frame's last buffer format. More...
 
- Instance Methods inherited from <FMLiveSwitchIMediaOutput>
(void) - addOnDisabledChange:
 Adds a handler that is raised when the Disabled property changes state. More...
 
(void) - addOnDisabledChangeWithCaller:
 Adds a handler that is raised when the Disabled property changes state. More...
 
(id- addOnDisabledChangeWithCallerWithBlock
 Adds a handler that is raised when the Disabled property changes state. More...
 
(void) - addOnDisabledChangeWithCallerWithBlock:
 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) - addOnRaiseControlFrameResponses:
 Adds a handler that is raised when a control frame response is raised. More...
 
(NSMutableArray *) - addOnRaiseControlFrameResponsesWithBlock
 Adds a handler that is raised when a control frame response is raised. More...
 
(void) - addOnRaiseControlFrameResponsesWithBlock:
 Adds a handler that is raised when a control frame response is raised. More...
 
(void) - addOnRaiseFrame:
 Adds a handler that is raised when a frame is raised. More...
 
(FMLiveSwitchMediaFrame *) - addOnRaiseFrameWithBlock
 Adds a handler that is raised when a frame is raised. More...
 
(void) - addOnRaiseFrameWithBlock:
 Adds a handler that is raised when a frame is raised. More...
 
(int) - getCcmSequenceNumber
 Gets the CCM sequence number. More...
 
(long long) - getPipelineSystemDelayWithOutputFormat:
 Gets the total pipeline system delay in ticks for a given media format. More...
 
(void) - incrementCcmSequenceNumber
 Increments the CCM sequence number. More...
 
(bool) - outputDeactivated
 Gets whether output is deactivated. More...
 
(bool) - outputMuted
 Gets whether output is muted. More...
 
(NSString *) - outputRtpStreamId
 Gets the output RTP stream identifier. More...
 
(bool) - outputSynchronizable
 Gets whether output is synchronizable. More...
 
(long long) - outputSynchronizationSource
 Gets the output synchronization source. 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) - removeOnDisabledChange:
 Removes a handler that is raised when the Disabled property changes state. More...
 
(void) - removeOnDisabledChangeWithCaller:
 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) - removeOnRaiseControlFrameResponses:
 Removes a handler that is raised when a control frame response is raised. More...
 
(void) - removeOnRaiseFrame:
 Removes a handler that is raised when a frame is raised. More...
 
(long long) - systemDelay
 Gets the system delay in ticks. More...
 
- Instance Methods inherited from <FMLiveSwitchIOutput>
(void) - addOutput:
 Adds an output. More...
 
(void) - addOutputs:
 Adds some outputs. More...
 
(NSObject< FMLiveSwitchIInput > *) - output
 Gets the output. More...
 
(FMLiveSwitchMediaFormat *) - outputFormat
 Gets the output format. More...
 
(NSMutableArray *) - outputs
 Gets the outputs. More...
 
(NSString *) - pipelineJsonFromOutput
 Gets the pipeline JSON from an output. More...
 
(bool) - removeOutput:
 Removes an output. More...
 
(void) - removeOutputs
 Removes all outputs. More...
 
(void) - removeOutputs:
 Removes some outputs. 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...
 

Class Methods

(FMLiveSwitchVideoEncoder *) + videoEncoderWithInputFormat:outputFormat:
 Initializes a new instance of the FMLiveSwitchVideoEncoder class. More...
 
- Class Methods inherited from FMLiveSwitchVideoPipe
(FMLiveSwitchVideoPipe *) + videoPipeWithInputFormat:outputFormat:
 Initializes a new instance of the FMLiveSwitchVideoPipe class. More...
 
(FMLiveSwitchVideoPipe *) + videoPipeWithOutputFormat:
 Initializes a new instance of the FMLiveSwitchVideoPipe class. More...
 
- Class Methods inherited from FMLiveSwitchMediaPipe
(FMLiveSwitchMediaPipe *) + mediaPipeWithInputFormat:outputFormat:
 Initializes a new instance of the FMLiveSwitchMediaPipe`9 class. More...
 
(FMLiveSwitchMediaPipe *) + mediaPipeWithOutputFormat:
 Initializes a new instance of the FMLiveSwitchMediaPipe`9 class. More...
 

Additional Inherited Members

- Protected Attributes inherited from FMLiveSwitchMediaPipe
 __pad0__: FMLiveSwitchDynamic<FMLiveSwitchIMediaOutput
 
 FMLiveSwitchIOutput
 
 FMLiveSwitchIMediaInput
 
 FMLiveSwitchIInput
 
 FMLiveSwitchIMediaElement
 

Detailed Description

A video encoder.

Method Documentation

◆ addOnBitrateChange:

- (void) addOnBitrateChange: (FMLiveSwitchAction0 *)  value

Adds a handler that is raised when the bitrate changes.

◆ addOnBitrateChangeWithCaller:

- (void) addOnBitrateChangeWithCaller: (FMLiveSwitchAction1< FMLiveSwitchVideoEncoder * > *)  value

Adds a handler that is raised when the bitrate changes.

◆ addOnBitrateChangeWithCallerWithBlock

- (FMLiveSwitchVideoEncoder*) addOnBitrateChangeWithCallerWithBlock

Adds a handler that is raised when the bitrate changes.

◆ addOnBitrateChangeWithCallerWithBlock:

- (void) addOnBitrateChangeWithCallerWithBlock: (void(^)(FMLiveSwitchVideoEncoder *))  valueBlock

Adds a handler that is raised when the bitrate changes.

◆ bitrate

- (int) bitrate

Gets the current bitrate, in kbps.

A value of -1 indicates unset.

◆ canChangeBitrate

- (bool) canChangeBitrate

Gets whether this pipe can change the output bitrate.

Implements FMLiveSwitchMediaPipe.

◆ doProcessControlFrames:

- (void) doProcessControlFrames: (NSMutableArray *)  controlFrames

Processes the control frames.

Parameters
controlFramesThe control frames.

Implements FMLiveSwitchMediaPipe.

◆ doProcessTrackStatsFromOutputWithTrackStats:

- (void) doProcessTrackStatsFromOutputWithTrackStats: (FMLiveSwitchMediaTrackStats *)  trackStats

Processes track stats from an output.

Parameters
trackStatsThe track stats.

Implements FMLiveSwitchMediaPipe.

◆ forceKeyFrame

- (bool) forceKeyFrame

Gets a value indicating whether a keyframe should be forced.

Implemented in FMLiveSwitchVpxEncoder, and FMLiveSwitchCocoaVideoToolboxBaseEncoder.

◆ frameHeight

- (int) frameHeight

Gets the last frame height.

◆ frameRate

- (double) frameRate

Gets the current frame rate.

◆ framesEncoded

- (long long) framesEncoded

Gets the number of encoded frames.

◆ frameWidth

- (int) frameWidth

Gets the last frame width.

◆ initWithInputFormat:outputFormat:

- (instancetype) initWithInputFormat: (FMLiveSwitchVideoFormat *)  inputFormat
outputFormat: (FMLiveSwitchVideoFormat *)  outputFormat 

Initializes a new instance of the FMLiveSwitchVideoEncoder class.

Parameters
inputFormatThe input format.
outputFormatThe output format.

Implements FMLiveSwitchVideoPipe.

Implemented in FMLiveSwitchCocoaVideoToolboxBaseEncoder.

◆ maxBitrate

- (int) maxBitrate

Gets the maximum bitrate, in kbps.

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

◆ maxCodecBitrate

- (int) maxCodecBitrate

Gets the maximum possible codec bitrate, in kbps.

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

◆ maxOutputBitrate

- (int) maxOutputBitrate

Gets the maximum output bitrate, in kbps.

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

Implements FMLiveSwitchMediaPipe.

◆ minBitrate

- (int) minBitrate

Gets the minimum bitrate, in kbps.

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

◆ minCodecBitrate

- (int) minCodecBitrate

Gets the minimum possible codec bitrate, in kbps.

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

◆ minOutputBitrate

- (int) minOutputBitrate

Gets the minimum output bitrate, in kbps.

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

Implements FMLiveSwitchMediaPipe.

◆ processFrame:

- (bool) processFrame: (FMLiveSwitchVideoFrame *)  frame

Processes the frame.

Parameters
frameThe frame.

◆ raiseFrame:

- (void) raiseFrame: (FMLiveSwitchVideoFrame *)  frame

Raises the frame.

Parameters
frameThe frame.

Implements FMLiveSwitchVideoPipe.

◆ removeOnBitrateChange:

- (void) removeOnBitrateChange: (FMLiveSwitchAction0 *)  value

Removes a handler that is raised when the bitrate changes.

◆ removeOnBitrateChangeWithCaller:

- (void) removeOnBitrateChangeWithCaller: (FMLiveSwitchAction1< FMLiveSwitchVideoEncoder * > *)  value

Removes a handler that is raised when the bitrate changes.

◆ setBitrate:

- (void) setBitrate: (int)  value

Sets the current bitrate, in kbps.

A value of -1 indicates unset.

◆ setForceKeyFrame:

- (void) setForceKeyFrame: (bool)  value

Sets a value indicating whether a keyframe should be forced.

Implemented in FMLiveSwitchVpxEncoder, and FMLiveSwitchCocoaVideoToolboxBaseEncoder.

◆ setMaxBitrate:

- (void) setMaxBitrate: (int)  value

Sets the maximum bitrate, in kbps.

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

◆ setMaxOutputBitrate:

- (void) setMaxOutputBitrate: (int)  value

Sets the maximum output bitrate, in kbps.

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

Implements FMLiveSwitchMediaPipe.

◆ setMinBitrate:

- (void) setMinBitrate: (int)  value

Sets the minimum bitrate, in kbps.

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

◆ setMinOutputBitrate:

- (void) setMinOutputBitrate: (int)  value

Sets the minimum output bitrate, in kbps.

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

Implements FMLiveSwitchMediaPipe.

◆ setStaticOutputBitrate:

- (void) setStaticOutputBitrate: (bool)  value

Sets whether minOutputBitrate and maxOutputBitrate should return minCodecBitrate and maxCodecBitrate, respectively, or response to changes in minBitrate and maxBitrate.

◆ setTargetBitrate:

- (void) setTargetBitrate: (int)  value

Sets the target bitrate, in kbps.

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

◆ setTargetOutputBitrate:

- (void) setTargetOutputBitrate: (int)  value

Sets the target output bitrate, in kbps.

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

Implements FMLiveSwitchMediaPipe.

◆ staticOutputBitrate

- (bool) staticOutputBitrate

Gets whether minOutputBitrate and maxOutputBitrate should return minCodecBitrate and maxCodecBitrate, respectively, or response to changes in minBitrate and maxBitrate.

◆ targetBitrate

- (int) targetBitrate

Gets the target bitrate, in kbps.

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

◆ targetOutputBitrate

- (int) targetOutputBitrate

Gets the target output bitrate, in kbps.

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

Implements FMLiveSwitchMediaPipe.

◆ videoEncoderWithInputFormat:outputFormat:

+ (FMLiveSwitchVideoEncoder*) videoEncoderWithInputFormat: (FMLiveSwitchVideoFormat *)  inputFormat
outputFormat: (FMLiveSwitchVideoFormat *)  outputFormat 

Initializes a new instance of the FMLiveSwitchVideoEncoder class.

Parameters
inputFormatThe input format.
outputFormatThe output format.