<FMLiveSwitchIMediaOutput> Protocol Reference

A media output. 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) - 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...
 
(NSString *) - content
 Gets the content descriptor. 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...
 
(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) - 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) - 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...
 
(FMLiveSwitchEncodingInfo *) - targetOutputEncoding
 Gets the target output encoding. 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...
 

Detailed Description

A media output.

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

◆ addOnRaiseControlFrameResponses:

- (void) addOnRaiseControlFrameResponses: (FMLiveSwitchAction1 *)  value

Adds a handler that is raised when a control frame response is raised.

◆ addOnRaiseControlFrameResponsesWithBlock

- (NSMutableArray*) addOnRaiseControlFrameResponsesWithBlock

Adds a handler that is raised when a control frame response is raised.

◆ addOnRaiseControlFrameResponsesWithBlock:

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

Adds a handler that is raised when a control frame response is raised.

◆ addOnRaiseFrame:

- (void) addOnRaiseFrame: (FMLiveSwitchAction1 *)  value

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

◆ addOnRaiseFrameWithBlock

- (FMLiveSwitchMediaFrame*) addOnRaiseFrameWithBlock

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

◆ addOnRaiseFrameWithBlock:

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

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

◆ content

- (NSString*) content

Gets the content descriptor.

Reimplemented in FMLiveSwitchVideoSource, FMLiveSwitchVideoSink, and FMLiveSwitchVideoPipe.

◆ getCcmSequenceNumber

- (int) getCcmSequenceNumber

Gets the CCM sequence number.

◆ getPipelineSystemDelayWithOutputFormat:

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

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

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

◆ incrementCcmSequenceNumber

- (void) incrementCcmSequenceNumber

Increments the CCM sequence number.

◆ maxOutputBitrate

- (int) maxOutputBitrate

Gets the maximum allowed output bitrate, in kbps.

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

Reimplemented in FMLiveSwitchVideoEncoder, FMLiveSwitchVideoDecoder, FMLiveSwitchAudioEncoder, and FMLiveSwitchAudioDecoder.

◆ maxOutputEncoding

- (FMLiveSwitchEncodingInfo*) maxOutputEncoding

Gets the maximum allowed output encoding.

Reimplemented in FMLiveSwitchVideoStream, FMLiveSwitchVideoSource, and FMLiveSwitchVideoPipe.

◆ minOutputBitrate

- (int) minOutputBitrate

Gets the minimum allowed output bitrate, in kbps.

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

Reimplemented in FMLiveSwitchVideoEncoder, FMLiveSwitchVideoDecoder, FMLiveSwitchAudioEncoder, and FMLiveSwitchAudioDecoder.

◆ minOutputEncoding

- (FMLiveSwitchEncodingInfo*) minOutputEncoding

Gets the minimum allowed output encoding.

Reimplemented in FMLiveSwitchVideoStream, FMLiveSwitchVideoSource, and FMLiveSwitchVideoPipe.

◆ outputDeactivated

- (bool) outputDeactivated

Gets whether output is deactivated.

◆ outputMuted

- (bool) outputMuted

Gets whether output is muted.

◆ outputRtpStreamId

- (NSString*) outputRtpStreamId

Gets the output RTP stream identifier.

Reimplemented in FMLiveSwitchNullVideoSink, and FMLiveSwitchNullAudioSink.

◆ outputSynchronizable

- (bool) outputSynchronizable

Gets whether output is synchronizable.

◆ outputSynchronizationSource

- (long long) outputSynchronizationSource

Gets the output synchronization source.

Reimplemented in FMLiveSwitchNullVideoSink, and FMLiveSwitchNullAudioSink.

◆ processControlFrames:

- (void) processControlFrames: (NSMutableArray *)  controlFrames

Processes control frames.

Parameters
controlFramesThe control frames.

Reimplemented in FMLiveSwitchNullVideoSink, and FMLiveSwitchNullAudioSink.

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

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

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

◆ removeOnRaiseControlFrameResponses:

- (void) removeOnRaiseControlFrameResponses: (FMLiveSwitchAction1 *)  value

Removes a handler that is raised when a control frame response is raised.

◆ removeOnRaiseFrame:

- (void) removeOnRaiseFrame: (FMLiveSwitchAction1 *)  value

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

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

Reimplemented in FMLiveSwitchVideoEncoder, and FMLiveSwitchAudioEncoder.

◆ targetOutputEncoding

- (FMLiveSwitchEncodingInfo*) targetOutputEncoding

Gets the target output encoding.

Reimplemented in FMLiveSwitchVideoStream, FMLiveSwitchVideoSource, and FMLiveSwitchVideoPipe.