 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
A video source. More...
Instance Methods | |
| (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... | |
| (int) | - averageFrameRate |
| Gets the average frame rate. More... | |
| (NSString *) | - content |
| Gets the content descriptor. More... | |
| (FMLiveSwitchIVideoInputCollection *) | - createInputCollectionWithOutput: |
| Creates an input collection. More... | |
| (long long) | - frameCount |
| Gets the frame count. More... | |
| (double) | - getFrameRateDistanceWithFrameRate1:frameRate2: |
| Gets the distance between two frame rates. More... | |
| (int) | - getSizeDistanceWithWidth1:height1:width2:height2: |
| Gets the distance between two sizes. More... | |
| (instancetype) | - initWithOutputFormat: |
| Initializes a new instance of the FMLiveSwitchVideoSource class. 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 *) | - 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 source frame-rate is over-constrained. More... | |
| (bool) | - overConstrainedHeight |
| Gets whether the source height is over-constrained. 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 source scale is over-constrained. More... | |
| (bool) | - overConstrainedSize |
| Gets whether the source size is over-constrained. More... | |
| (bool) | - overConstrainedWidth |
| Gets whether the source width is over-constrained. More... | |
| (void) | - raiseFrame: |
| Raises a 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) | - 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) | - 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 FMLiveSwitchMediaSource | |
| (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) | - addOnMuted: |
| Adds a handler that is raised when the source is muted. 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) | - addOnUnmuted: |
| Adds a handler that is raised when the source is unmuted. 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... | |
| (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... | |
| (int) | - minOutputBitrate |
| 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 source is over-constrained. More... | |
| (bool) | - overConstrainedBitrate |
| Gets whether the source bitrate 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) | - removeOnDisabledChangeWithCaller: |
| Removes a handler that is raised when the Disabled property changes state. More... | |
| (void) | - removeOnMuted: |
| Removes a handler that is raised when the source is muted. 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... | |
| (void) | - removeOnUnmuted: |
| Removes a handler that is raised when the source is unmuted. 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) | - setMinOutputBitrate: |
| 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) | - 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... | |
| (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... | |
| (bool) | - updateDisabled |
| Updates the disabled property. 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... | |
| (int) | - maxOutputBitrate |
| Gets the maximum allowed output bitrate, in kbps. More... | |
| (int) | - minOutputBitrate |
| Gets the minimum allowed output bitrate, in kbps. 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... | |
| (int) | - targetOutputBitrate |
| Gets the target output bitrate, in kbps. 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 | |
| (FMLiveSwitchVideoSource *) | + videoSourceWithOutputFormat: |
| Initializes a new instance of the FMLiveSwitchVideoSource class. More... | |
| Class Methods inherited from FMLiveSwitchMediaSource | |
| (FMLiveSwitchMediaSource *) | + mediaSourceWithOutputFormat: |
| Initializes a new instance of the FMLiveSwitchMediaSource`8 class. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from FMLiveSwitchMediaSource | |
| __pad0__: FMLiveSwitchMediaSourceBase<FMLiveSwitchIMediaOutput | |
| FMLiveSwitchIOutput | |
| FMLiveSwitchIMediaElement | |
A video source.
| - (void) addOnRaiseSizeChange: | (FMLiveSwitchAction1< FMLiveSwitchSize * > *) | value |
Adds a handler that is raised when a frame is about to be raised with a size that does not match the prior frame.
| - (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.
| - (void) addOnRaiseSizeChangeWithBlock: | (void(^)(FMLiveSwitchSize *)) | valueBlock |
Adds a handler that is raised when a frame is about to be raised with a size that does not match the prior frame.
| - (int) averageFrameRate |
Gets the average frame rate.
| - (NSString*) content |
Gets the content descriptor.
Implements FMLiveSwitchMediaSource.
| - (FMLiveSwitchIVideoInputCollection*) createInputCollectionWithOutput: | (NSObject< FMLiveSwitchIVideoOutput > *) | output |
Creates an input collection.
| output | The source. |
| - (long long) frameCount |
Gets the frame count.
| - (double) getFrameRateDistanceWithFrameRate1: | (double) | frameRate1 | |
| frameRate2: | (double) | frameRate2 | |
Gets the distance between two frame rates.
| frameRate1 | The first frame rate. |
| frameRate2 | The second frame rate. |
| - (int) getSizeDistanceWithWidth1: | (int) | width1 | |
| height1: | (int) | height1 | |
| width2: | (int) | width2 | |
| height2: | (int) | height2 | |
Gets the distance between two sizes.
| width1 | The first width. |
| height1 | The first height. |
| width2 | The second width. |
| height2 | The second height. |
| - (instancetype) initWithOutputFormat: | (FMLiveSwitchVideoFormat *) | outputFormat |
Initializes a new instance of the FMLiveSwitchVideoSource class.
| outputFormat | The output format. |
Implemented in FMLiveSwitchNullVideoSource.
| - (FMLiveSwitchEncodingInfo*) maxOutputEncoding |
Gets the maximum allowed output encoding.
Implements FMLiveSwitchMediaSource.
| - (double) maxOutputFrameRate |
Gets the maximum allowed output frame-rate, in fps.
A value of -1 indicates unset (no maximum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (int) maxOutputHeight |
Gets the maximum allowed output height.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (double) maxOutputScale |
Gets the maximum allowed output scale.
A value of -1 indicates unset (no maximum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (FMLiveSwitchSize*) maxOutputSize |
Gets the maximum allowed output size.
A value of null indicates unset (no maximum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (int) maxOutputWidth |
Gets the maximum allowed output width.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (FMLiveSwitchEncodingInfo*) minOutputEncoding |
Gets the minimum allowed output encoding.
Implements FMLiveSwitchMediaSource.
| - (double) minOutputFrameRate |
Gets the minimum allowed output frame-rate, in fps.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (int) minOutputHeight |
Gets the minimum allowed output height.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (double) minOutputScale |
Gets the minimum allowed output scale.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (FMLiveSwitchSize*) minOutputSize |
Gets the minimum allowed output size.
A value of null indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (int) minOutputWidth |
Gets the minimum allowed output width.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (bool) outputCanProcessFrameWithOutput: | (NSObject< FMLiveSwitchIVideoInput > *) | output |
Determines whether an output can process a frame from this pipe.
| output | The output. |
| - (bool) overConstrainedFrameRate |
Gets whether the source frame-rate is over-constrained.
A source frame-rate is over-constrained if the output frame-rate is over-constrained.
| - (bool) overConstrainedHeight |
Gets whether the source height is over-constrained.
A source height is over-constrained if the output height is over-constrained.
| - (bool) overConstrainedOutput |
Gets whether the output is over-contrained.
An output is over-constrained if it's output bitrate, output scale, output frame-rate, output size is over-contrained.
Implements FMLiveSwitchMediaSource.
| - (bool) overConstrainedOutputFrameRate |
Gets whether the minimum allowed output frame-rate exceeds the maximum allowed output frame-rate.
| - (bool) overConstrainedOutputHeight |
Gets whether the minimum allowed output height exceeds the maximum allowed output height.
| - (bool) overConstrainedOutputScale |
Gets whether the minimum allowed output scale exceeds the maximum allowed output scale.
| - (bool) overConstrainedOutputSize |
Gets whether the minimum allowed output size exceeds the maximum allowed output size.
| - (bool) overConstrainedOutputWidth |
Gets whether the minimum allowed output width exceeds the maximum allowed output width.
| - (bool) overConstrainedScale |
Gets whether the source scale is over-constrained.
A source scale is over-constrained if the output scale is over-constrained.
| - (bool) overConstrainedSize |
Gets whether the source size is over-constrained.
A source size is over-constrained if the output size is over-constrained.
| - (bool) overConstrainedWidth |
Gets whether the source width is over-constrained.
A source width is over-constrained if the output width is over-constrained.
| - (void) raiseFrame: | (FMLiveSwitchVideoFrame *) | frame |
Raises a frame.
| frame | The frame. |
| - (void) removeOnRaiseSizeChange: | (FMLiveSwitchAction1< FMLiveSwitchSize * > *) | value |
Removes a handler that is raised when a frame is about to be raised with a size that does not match the prior frame.
| - (void) setMaxOutputEncoding: | (FMLiveSwitchEncodingInfo *) | value |
Sets the maximum allowed output encoding.
Implements FMLiveSwitchMediaSource.
| - (void) setMaxOutputFrameRate: | (double) | value |
Sets the maximum allowed output frame-rate, in fps.
A value of -1 indicates unset (no maximum).
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (void) setMaxOutputScale: | (double) | value |
Sets the maximum allowed output scale.
A value of -1 indicates unset (no maximum).
| - (void) setMaxOutputSize: | (FMLiveSwitchSize *) | value |
Sets the maximum allowed output size.
A value of null indicates unset (no maximum).
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (void) setMinOutputEncoding: | (FMLiveSwitchEncodingInfo *) | value |
Sets the minimum allowed output encoding.
Implements FMLiveSwitchMediaSource.
| - (void) setMinOutputFrameRate: | (double) | value |
Sets the minimum allowed output frame-rate, in fps.
A value of -1 indicates unset (no minimum).
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (void) setMinOutputScale: | (double) | value |
Sets the minimum allowed output scale.
A value of -1 indicates unset (no minimum).
| - (void) setMinOutputSize: | (FMLiveSwitchSize *) | value |
Sets the minimum allowed output size.
A value of null indicates unset (no minimum).
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (void) setTargetOutputEncoding: | (FMLiveSwitchEncodingInfo *) | value |
Sets the target output encoding.
Implements FMLiveSwitchMediaSource.
| - (void) setTargetOutputFrameRate: | (double) | value |
Sets the target output frame-rate, in fps.
A value of -1 indicates unset (no target).
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (void) setTargetOutputScale: | (double) | value |
Sets the target output scale.
A value of -1 indicates unset (no target).
| - (void) setTargetOutputSize: | (FMLiveSwitchSize *) | value |
Sets the target output size.
A value of null indicates unset (no target).
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (void) setVideoType: | (FMLiveSwitchVideoType) | value |
Sets the video type.
| - (FMLiveSwitchEncodingInfo*) targetOutputEncoding |
Gets the target output encoding.
Implements FMLiveSwitchMediaSource.
| - (double) targetOutputFrameRate |
Gets the target output frame-rate, in fps.
A value of -1 indicates unset (no target).
Reimplemented from <FMLiveSwitchIVideoOutput>.
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (int) targetOutputHeight |
Gets the target output height.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (double) targetOutputScale |
Gets the target output scale.
A value of -1 indicates unset (no target).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| - (FMLiveSwitchSize*) targetOutputSize |
Gets the target output size.
A value of null indicates unset (no target).
Reimplemented from <FMLiveSwitchIVideoOutput>.
Implemented in FMLiveSwitchScreenSourceBase, FMLiveSwitchNullVideoSource, and FMLiveSwitchCameraSourceBase.
| - (int) targetOutputWidth |
Gets the target output width.
A value of -1 indicates unset (no minimum).
Reimplemented from <FMLiveSwitchIVideoOutput>.
| + (FMLiveSwitchVideoSource*) videoSourceWithOutputFormat: | (FMLiveSwitchVideoFormat *) | outputFormat |
Initializes a new instance of the FMLiveSwitchVideoSource class.
| outputFormat | The output format. |
| - (FMLiveSwitchVideoType) videoType |
Gets the video type.
Reimplemented from <FMLiveSwitchIVideoOutput>.