FMLiveSwitchIVideoOutputCollection Class Reference

A collection of video outputs. More...

Instance Methods

(NSMutableArray *) - arrayFromList:
 Creates an array from a list. More...
 
(FMLiveSwitchIVideoOutputCollection *) - createCollection
 Creates a collection. More...
 
(instancetype) - initWithInput:
 Initializes a new instance of the FMLiveSwitchIVideoOutputCollection class. More...
 
- Instance Methods inherited from FMLiveSwitchIMediaOutputCollection
(void) - addSuccess:
 Invoked after an element is added to the collection. More...
 
(void) - addSuccessNoLock:
 Invoked after an element is added to the collection. More...
 
(void) - destroy
 Removes all items and sets the FMLiveSwitchIMediaOutputCollection`7input to null. More...
 
(instancetype) - initWithInput:
 Initializes a new instance of the FMLiveSwitchIMediaInputCollection`7 class. More...
 
(TIInput) - input
 Gets the input. More...
 
(void) - removeSuccess:
 Invoked after an element is removed from the collection. More...
 
(void) - removeSuccessNoLock:
 Invoked after an element is removed from the collection. More...
 
(void) - setInput:
 Sets the input. More...
 
- Instance Methods inherited from <FMLiveSwitchIVideoOutput>
(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...
 
(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...
 
(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 <FMLiveSwitchIMediaOutput>
(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...
 

Class Methods

(FMLiveSwitchIVideoOutputCollection *) + iVideoOutputCollectionWithInput:
 Initializes a new instance of the FMLiveSwitchIVideoOutputCollection class. More...
 
- Class Methods inherited from FMLiveSwitchIMediaOutputCollection
(FMLiveSwitchIMediaOutputCollection *) + iMediaOutputCollectionWithInput:
 Initializes a new instance of the FMLiveSwitchIMediaInputCollection`7 class. More...
 

Additional Inherited Members

- Protected Attributes inherited from FMLiveSwitchIMediaOutputCollection
 __pad0__: FMLiveSwitchCollection<TIOutput
 

Detailed Description

A collection of video outputs.

Method Documentation

◆ arrayFromList:

- (NSMutableArray*) arrayFromList: (NSMutableArray< NSObject< FMLiveSwitchIVideoOutput > * > *)  list

Creates an array from a list.

Parameters
listThe list.

◆ createCollection

- (FMLiveSwitchIVideoOutputCollection*) createCollection

Creates a collection.

◆ initWithInput:

- (instancetype) initWithInput: (NSObject< FMLiveSwitchIVideoInput > *)  input

Initializes a new instance of the FMLiveSwitchIVideoOutputCollection class.

Parameters
inputThe input.

◆ iVideoOutputCollectionWithInput:

+ (FMLiveSwitchIVideoOutputCollection*) iVideoOutputCollectionWithInput: (NSObject< FMLiveSwitchIVideoInput > *)  input

Initializes a new instance of the FMLiveSwitchIVideoOutputCollection class.

Parameters
inputThe input.