IceLink

"Frozen Mountain Software"

FMIceLinkMediaSource Class Reference

Inherits from	FMIceLinkMediaSourceBase : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to	TBuffer TBufferCollection TFormat TFrame TIInput TIInputCollection TIOutput TSource __covariant
Declared in	FMIceLinkMediaSource.h FMIceLinkMediaSource.m

Overview

A media source.

The type of the output interface.The type of the input interface.The type of the input interface collection.The type of the source.The type of the frame.The type of the buffer.The type of the buffer collection.The type of the format.

`– addOnDisabledChange:`

Adds a handler that is raised when the Disabled property changes [state](#//api/name/state).

- (void)addOnDisabledChange:(FMIceLinkAction0 *)value

Discussion

Adds a handler that is raised when the Disabled property changes [state](#//api/name/state).

Declared In

FMIceLinkMediaSource.h

`– addOnProcessControlFrames:`

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

- (void)addOnProcessControlFrames:(FMIceLinkAction1 *)value

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– addOnProcessControlFramesWithBlock`

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

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

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– addOnProcessControlFramesWithBlock:`

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

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

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– addOnRaiseFrame:`

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

- (void)addOnRaiseFrame:(FMIceLinkAction1 *)value

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– addOnRaiseFrameWithBlock`

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

- (void ( ^ ) ( void ( ^ ) ( FMIceLinkMediaFrame *) ))addOnRaiseFrameWithBlock

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– addOnRaiseFrameWithBlock:`

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

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

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– addOnStateChange:`

Adds a handler that is raised when the [state](#//api/name/state) changes.

- (void)addOnStateChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSource.h

`– addOnStateChangeWithBlock`

Adds a handler that is raised when the [state](#//api/name/state) changes.

- (void ( ^ ) ( void ( ^ ) ( FMIceLinkMediaSource *) ))addOnStateChangeWithBlock

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSource.h

`– addOnStateChangeWithBlock:`

Adds a handler that is raised when the [state](#//api/name/state) changes.

- (void)addOnStateChangeWithBlock:(void ( ^ ) ( FMIceLinkMediaSource *))valueBlock

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSource.h

`– addOutput:`

Adds an [output](#//api/name/output).

- (void)addOutput:(NSObject<FMIceLinkIMediaInput> *)output

Parameters

`output`	The output.

Discussion

Adds an [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– addOutputs:`

Adds some [outputs](#//api/name/outputs).

- (void)addOutputs:(NSMutableArray *)outputs

Parameters

`outputs`	The outputs.

Discussion

Adds some [outputs](#//api/name/outputs).

Declared In

FMIceLinkMediaSource.h

`– changeInput:`

Changes the current [input](#//api/name/input).

- (FMIceLinkFuture *)changeInput:(FMIceLinkSourceInput *)input

Parameters

`input`	The input.

Discussion

Changes the current [input](#//api/name/input).

Declared In

FMIceLinkMediaSource.h

`– createInputCollectionWithOutput:`

Creates an [input](#//api/name/input) collection.

- (FMIceLinkIMediaInputCollection *)createInputCollectionWithOutput:(NSObject<FMIceLinkIMediaOutput> *)output

Parameters

`output`	The output.

Discussion

Creates an [input](#//api/name/input) collection.

Declared In

FMIceLinkMediaSource.h

`– description`

Returns a string that represents this instance.

- (NSString *)description

Discussion

Returns a string that represents this instance.

Declared In

FMIceLinkMediaSource.h

`– destroy`

Destroys this instance.

- (bool)destroy

Discussion

Destroys this instance.

Declared In

FMIceLinkMediaSource.h

`– disabled`

Gets a value indicating whether this source is disabled.

- (bool)disabled

Discussion

Gets a value indicating whether this source is disabled.

Declared In

FMIceLinkMediaSource.h

`– doDestroy`

Destroys this instance.

- (void)doDestroy

Discussion

Destroys this instance.

Declared In

FMIceLinkMediaSource.h

`– doProcessControlFrames:`

Processes the control frames.

- (void)doProcessControlFrames:(NSMutableArray *)controlFrames

Parameters

`controlFrames`	The control frames.

Discussion

Processes the control frames.

Declared In

FMIceLinkMediaSource.h

`– doProcessSdpMediaDescription:isOffer:isLocalDescription:`

Processes a local SDP media [description](#//api/name/description).

- (FMIceLinkError *)doProcessSdpMediaDescription:(FMIceLinkSdpMediaDescription *)mediaDescription isOffer:(bool)isOffer isLocalDescription:(bool)isLocalDescription

Parameters

`mediaDescription`	The media description.
`isOffer`	if set to true [is offer].
`isLocalDescription`	if set to true [is local description].

Discussion

Processes a local SDP media [description](#//api/name/description).

Declared In

FMIceLinkMediaSource.h

`– doProcessStatsFromOutputWithStats:`

Processes stats from an [output](#//api/name/output).

- (void)doProcessStatsFromOutputWithStats:(FMIceLinkMediaTrackStats *)stats

Parameters

`stats`	The stats.

Discussion

Processes stats from an [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– doStart`

Starts this instance.

- (FMIceLinkFuture *)doStart

Discussion

Starts this instance.

Declared In

FMIceLinkMediaSource.h

`– doStop`

Stops this instance.

- (FMIceLinkFuture *)doStop

Discussion

Stops this instance.

Declared In

FMIceLinkMediaSource.h

`– getFirSequenceNumber`

Gets the FIR sequence number.

@return

- (int)getFirSequenceNumber

Discussion

Gets the FIR sequence number.

@return

Declared In

FMIceLinkMediaSource.h

`– getInputs`

Gets the available inputs.

- (FMIceLinkFuture *)getInputs

Discussion

Gets the available inputs.

Declared In

FMIceLinkMediaSource.h

`– hasOutput:`

Determines whether this source has the specified [output](#//api/name/output).

- (bool)hasOutput:(NSObject<FMIceLinkIMediaInput> *)output

Parameters

`output`	The output.

Discussion

Determines whether this source has the specified [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– incrementFirSequenceNumber`

Increments the FIR sequence number.

- (void)incrementFirSequenceNumber

Discussion

Increments the FIR sequence number.

Declared In

FMIceLinkMediaSource.h

`– initWithOutputFormat:`

Initializes a new instance of the FMIceLinkMediaSource`8 class.

- (instancetype)initWithOutputFormat:(FMIceLinkMediaFormat *)outputFormat

Parameters

`outputFormat`	The output format.

Discussion

Initializes a new instance of the FMIceLinkMediaSource`8 class.

Declared In

FMIceLinkMediaSource.h

`– input`

Gets the current input.

- (FMIceLinkSourceInput *)input

Discussion

Gets the current input.

Declared In

FMIceLinkMediaSource.h

`– label`

Gets a label that identifies this class.

- (NSString *)label

Discussion

Gets a label that identifies this class.

Declared In

FMIceLinkMediaSource.h

`– maxOutputBitrate`

Gets the maximum supported [output](#//api/name/output) bitrate. -1 means infinite.

- (int)maxOutputBitrate

Discussion

Gets the maximum supported [output](#//api/name/output) bitrate. -1 means infinite.

Declared In

FMIceLinkMediaSource.h

`+ mediaSourceWithOutputFormat:`

Initializes a new instance of the FMIceLinkMediaSource`8 class.

+ (FMIceLinkMediaSource *)mediaSourceWithOutputFormat:(FMIceLinkMediaFormat *)outputFormat

Parameters

`outputFormat`	The output format.

Discussion

Initializes a new instance of the FMIceLinkMediaSource`8 class.

Declared In

FMIceLinkMediaSource.h

`– muted`

Gets a value indicating whether this instance is muted.

- (bool)muted

Discussion

Gets a value indicating whether this instance is muted.

Declared In

FMIceLinkMediaSource.h

`– output`

Gets the output.

- (NSObject<FMIceLinkIMediaInput> *)output

Discussion

Gets the output.

Declared In

FMIceLinkMediaSource.h

`– outputFormat`

Gets the [output](#//api/name/output) format.

- (FMIceLinkMediaFormat *)outputFormat

Discussion

Gets the [output](#//api/name/output) format.

Declared In

FMIceLinkMediaSource.h

`– outputs`

Gets the outputs.

- (NSMutableArray *)outputs

Discussion

Gets the outputs.

Declared In

FMIceLinkMediaSource.h

`– persistent`

Gets a value indicating whether this instance is persistent. If true, this instance will not be destroyed unless FMIceLinkMediaSource`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

- (bool)persistent

Discussion

Gets a value indicating whether this instance is persistent. If true, this instance will not be destroyed unless FMIceLinkMediaSource`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

Declared In

FMIceLinkMediaSource.h

`– pipelineJson`

Gets the pipeline JSON with this as the central point.

- (NSString *)pipelineJson

Discussion

Gets the pipeline JSON with this as the central point.

Declared In

FMIceLinkMediaSource.h

`– pipelineJsonFromOutput`

Gets the pipeline JSON from an [output](#//api/name/output).

- (NSString *)pipelineJsonFromOutput

Discussion

Gets the pipeline JSON from an [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– processControlFrames:`

Processes the control frames.

- (void)processControlFrames:(NSMutableArray *)controlFrames

Parameters

`controlFrames`	The control frames.

Discussion

Processes the control frames.

Declared In

FMIceLinkMediaSource.h

`– processGetMuteFromStream`

Gets whether the stream is [muted](#//api/name/muted) or not.

- (bool)processGetMuteFromStream

Discussion

Gets whether the stream is [muted](#//api/name/muted) or not.

Declared In

FMIceLinkMediaSource.h

`– processSdpMediaDescriptionFromOutputWithMediaDescription:isOffer:isLocalDescription:`

Processes a local SDP media [description](#//api/name/description) from an [output](#//api/name/output).

- (FMIceLinkError *)processSdpMediaDescriptionFromOutputWithMediaDescription:(FMIceLinkSdpMediaDescription *)mediaDescription isOffer:(bool)isOffer isLocalDescription:(bool)isLocalDescription

Parameters

`mediaDescription`	The media description.
`isOffer`	if set to true [is offer].
`isLocalDescription`	if set to true [is local description].

Discussion

Processes a local SDP media [description](#//api/name/description) from an [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– processSetMuteFromStreamWithMute:`

Process a set mute call from a stream.

- (void)processSetMuteFromStreamWithMute:(bool)mute

Parameters

`mute`	Whether to mute or not.

Discussion

Process a set mute call from a stream.

Declared In

FMIceLinkMediaSource.h

`– processStatsFromOutputWithStats:`

Processes stats from an [output](#//api/name/output).

- (void)processStatsFromOutputWithStats:(FMIceLinkMediaTrackStats *)stats

Parameters

`stats`	The stats.

Discussion

Processes stats from an [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– raiseFrame:`

Raises a frame.

- (void)raiseFrame:(FMIceLinkMediaFrame *)frame

Parameters

`frame`	The frame.

Discussion

Raises a frame.

Declared In

FMIceLinkMediaSource.h

`– removeOnDisabledChange:`

Removes a handler that is raised when the Disabled property changes [state](#//api/name/state).

- (void)removeOnDisabledChange:(FMIceLinkAction0 *)value

Discussion

Removes a handler that is raised when the Disabled property changes [state](#//api/name/state).

Declared In

FMIceLinkMediaSource.h

`– removeOnProcessControlFrames:`

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

- (void)removeOnProcessControlFrames:(FMIceLinkAction1 *)value

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– removeOnRaiseFrame:`

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

- (void)removeOnRaiseFrame:(FMIceLinkAction1 *)value

Discussion

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

Declared In

FMIceLinkMediaSource.h

`– removeOnStateChange:`

Removes a handler that is raised when the [state](#//api/name/state) changes.

- (void)removeOnStateChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkMediaSource.h

`– removeOutput:`

Removes an [output](#//api/name/output).

- (bool)removeOutput:(NSObject<FMIceLinkIMediaInput> *)output

Parameters

`output`	The output.

Discussion

Removes an [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– removeOutputs`

Removes all [outputs](#//api/name/outputs).

- (void)removeOutputs

Discussion

Removes all [outputs](#//api/name/outputs).

Declared In

FMIceLinkMediaSource.h

`– removeOutputs:`

Removes some [outputs](#//api/name/outputs).

- (bool)removeOutputs:(NSMutableArray *)outputs

Parameters

`outputs`	The outputs.

Discussion

Removes some [outputs](#//api/name/outputs).

Declared In

FMIceLinkMediaSource.h

`– setInput:`

Sets the current [input](#//api/name/input).

- (void)setInput:(FMIceLinkSourceInput *)value

Discussion

Sets the current [input](#//api/name/input).

Declared In

FMIceLinkMediaSource.h

`– setMuted:`

Sets a value indicating whether this instance is [muted](#//api/name/muted).

- (void)setMuted:(bool)value

Discussion

Sets a value indicating whether this instance is [muted](#//api/name/muted).

Declared In

FMIceLinkMediaSource.h

`– setOutput:`

Sets the [output](#//api/name/output).

- (void)setOutput:(NSObject<FMIceLinkIMediaInput> *)value

Discussion

Sets the [output](#//api/name/output).

Declared In

FMIceLinkMediaSource.h

`– setOutputs:`

Sets the [outputs](#//api/name/outputs).

- (void)setOutputs:(NSMutableArray *)value

Discussion

Sets the [outputs](#//api/name/outputs).

Declared In

FMIceLinkMediaSource.h

`– setPersistent:`

Sets a value indicating whether this instance is [persistent](#//api/name/persistent). If true, this instance will not be destroyed unless FMIceLinkMediaSource`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

- (void)setPersistent:(bool)value

Discussion

Sets a value indicating whether this instance is [persistent](#//api/name/persistent). If true, this instance will not be destroyed unless FMIceLinkMediaSource`8#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

Declared In

FMIceLinkMediaSource.h

`– setSynchronizationSource:`

Sets the synchronization source.

- (void)setSynchronizationSource:(long long)value

Discussion

Sets the synchronization source.

Declared In

FMIceLinkMediaSource.h

`– start`

Starts this instance.

- (FMIceLinkFuture *)start

Discussion

Starts this instance.

Declared In

FMIceLinkMediaSource.h

`– state`

Gets the state.

- (FMIceLinkMediaSourceState)state

Discussion

Gets the state.

Declared In

FMIceLinkMediaSource.h

`– stop`

Stops this instance.

- (FMIceLinkFuture *)stop

Discussion

Stops this instance.

Declared In

FMIceLinkMediaSource.h

`– synchronizationSource`

Gets the synchronization source.

- (long long)synchronizationSource

Discussion

Gets the synchronization source.

Declared In

FMIceLinkMediaSource.h