FMIceLinkMediaTrack Class Reference

Inherits from FMIceLinkMediaTrackBase : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to TBranch
TBuffer
TBufferCollection
TFormat
TFrame
TIElement
TIInput
TIInputCollection
TIOutput
TIOutputCollection
TPipe
TSink
TSource
TTrack
__covariant
Declared in FMIceLinkMediaTrack.h
FMIceLinkMediaTrack.m

Overview

A media track.

The type of the output interface.The type of the source collection.The type of the input interface.The type of the sink collection.The type of the element interfaceThe type of the source.The type of the sink.The type of the pipe.The type of the track.The type of the branch.The type of the frame.The type of the buffer.The type of the buffer collection.The type of the format.

– activeSink

Gets the active [sink](#//api/name/sink). This will return FMIceLinkMediaTrack`14#[`sink`](#//api/name/sink) if FMIceLinkMediaTrack`14#[sink](#//api/name/sink) is not null and not [disabled](#//api/name/disabled). Otherwise, if this track branches, it will iterate recursively over the active tracks until it finds an FMIceLinkMediaTrack`14#activeSink. Otherwise, it will return null.
- (FMIceLinkMediaSink *)activeSink

Discussion

Gets the active [sink](#//api/name/sink). This will return FMIceLinkMediaTrack`14#[`sink`](#//api/name/sink) if FMIceLinkMediaTrack`14#[sink](#//api/name/sink) is not null and not [disabled](#//api/name/disabled). Otherwise, if this track branches, it will iterate recursively over the active tracks until it finds an FMIceLinkMediaTrack`14#activeSink. Otherwise, it will return null.

Declared In

FMIceLinkMediaTrack.h

– addElement:

Adds an element.
- (void)addElement:(NSObject<FMIceLinkIMediaElement> *)element

Discussion

Adds an element.

Declared In

FMIceLinkMediaTrack.h

– addOnDestroyed:

Adds a handler that is raised when the track is destroyed.
- (void)addOnDestroyed:(FMIceLinkAction0 *)value

Discussion

Adds a handler that is raised when the track is destroyed.

Declared In

FMIceLinkMediaTrack.h

– addOnStarted:

Adds a handler that is raised when the track is started. Only applicable for local media tracks.
- (void)addOnStarted:(FMIceLinkAction0 *)value

Discussion

Adds a handler that is raised when the track is started. Only applicable for local media tracks.

Declared In

FMIceLinkMediaTrack.h

– addOnStopped:

Adds a handler that is raised when the track is stopped. Only applicable for local media tracks.
- (void)addOnStopped:(FMIceLinkAction0 *)value

Discussion

Adds a handler that is raised when the track is stopped. Only applicable for local media tracks.

Declared In

FMIceLinkMediaTrack.h

– arrayFromInputs:

Creates an array of [inputs](#//api/name/inputs) from a list of [inputs](#//api/name/inputs).
- (NSMutableArray *)arrayFromInputs:(NSMutableArray *)inputs

Parameters

inputs

The list of inputs.

Discussion

Creates an array of [inputs](#//api/name/inputs) from a list of [inputs](#//api/name/inputs).

Declared In

FMIceLinkMediaTrack.h

– arrayFromOutputs:

Creates an array of [outputs](#//api/name/outputs) from a list of [outputs](#//api/name/outputs).
- (NSMutableArray *)arrayFromOutputs:(NSMutableArray *)outputs

Parameters

outputs

The list of outputs.

Discussion

Creates an array of [outputs](#//api/name/outputs) from a list of [outputs](#//api/name/outputs).

Declared In

FMIceLinkMediaTrack.h

– arrayFromSinks:

Creates an array of [sinks](#//api/name/sinks) from a list of [sinks](#//api/name/sinks).
- (NSMutableArray *)arrayFromSinks:(NSMutableArray *)sinks

Parameters

sinks

The list of sinks.

Discussion

Creates an array of [sinks](#//api/name/sinks) from a list of [sinks](#//api/name/sinks).

Declared In

FMIceLinkMediaTrack.h

– branchFromTracks:

Creates a branch from an array of tracks.
- (FMIceLinkMediaBranch *)branchFromTracks:(NSMutableArray *)tracks

Parameters

tracks

The tracks.

Discussion

Creates a branch from an array of tracks.

Declared In

FMIceLinkMediaTrack.h

– changeSinkOutput:

Changes the [sink](#//api/name/sink) [output](#//api/name/output) while the media track is active.
- (FMIceLinkFuture *)changeSinkOutput:(FMIceLinkSinkOutput *)sinkOutput

Parameters

sinkOutput

The sink output. @return

Discussion

Changes the [sink](#//api/name/sink) [output](#//api/name/output) while the media track is active.

Declared In

FMIceLinkMediaTrack.h

– changeSourceInput:

Changes the [source](#//api/name/source) [input](#//api/name/input) while the media track is active.
- (FMIceLinkFuture *)changeSourceInput:(FMIceLinkSourceInput *)sourceInput

Parameters

sourceInput

The source input. @return

Discussion

Changes the [source](#//api/name/source) [input](#//api/name/input) while the media track is active.

Declared In

FMIceLinkMediaTrack.h

– destroy

Destroys this media track.
- (bool)destroy

Discussion

Destroys this media track.

Declared In

FMIceLinkMediaTrack.h

– disabled

Gets a value indicating whether this instance is disabled.
- (bool)disabled

Discussion

Gets a value indicating whether this instance is disabled.

Declared In

FMIceLinkMediaTrack.h

– elements

Gets the elements.
- (NSMutableArray *)elements

Discussion

Gets the elements.

Declared In

FMIceLinkMediaTrack.h

– findElementsWithWhere:

Finds [elements](#//api/name/elements) in the track. This method will recursively call into any branched tracks.
- (NSMutableArray *)findElementsWithWhere:(FMIceLinkFunction1 *)where

Return Value

A list of elements found matching the given type, or null if no elements exist for that type.

Discussion

Finds [elements](#//api/name/elements) in the track. This method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementsWithWhere:recurse:

Finds [elements](#//api/name/elements) in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.
- (NSMutableArray *)findElementsWithWhere:(FMIceLinkFunction1 *)where recurse:(bool)recurse

Return Value

A list of elements found matching the given type, or null if no elements exist for that type.

Discussion

Finds [elements](#//api/name/elements) in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementsWithWhereBlock

Finds [elements](#//api/name/elements) in the track. This method will recursively call into any branched tracks.
- (NSMutableArray *( ^ ) ( bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *) ))findElementsWithWhereBlock

Return Value

A list of elements found matching the given type, or null if no elements exist for that type.

Discussion

Finds [elements](#//api/name/elements) in the track. This method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementsWithWhereBlock:

Finds [elements](#//api/name/elements) in the track. This method will recursively call into any branched tracks.
- (NSMutableArray *)findElementsWithWhereBlock:(bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *))whereBlock

Return Value

A list of elements found matching the given type, or null if no elements exist for that type.

Discussion

Finds [elements](#//api/name/elements) in the track. This method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementsWithWhereBlock:recurse:

Finds [elements](#//api/name/elements) in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.
- (NSMutableArray *)findElementsWithWhereBlock:(bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *))whereBlock recurse:(bool)recurse

Return Value

A list of elements found matching the given type, or null if no elements exist for that type.

Discussion

Finds [elements](#//api/name/elements) in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementsWithWhereBlockAndRecurse

Finds [elements](#//api/name/elements) in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.
- (NSMutableArray *( ^ ) ( bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *) , bool ))findElementsWithWhereBlockAndRecurse

Return Value

A list of elements found matching the given type, or null if no elements exist for that type.

Discussion

Finds [elements](#//api/name/elements) in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementWithWhere:

Finds an element in the track. This method will recursively call into any branched tracks.
- (NSObject<FMIceLinkIMediaElement> *)findElementWithWhere:(FMIceLinkFunction1 *)where

Return Value

The first element found matching the given type, or null if no elements exist for that type.

Discussion

Finds an element in the track. This method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementWithWhere:recurse:

Finds an element in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.
- (NSObject<FMIceLinkIMediaElement> *)findElementWithWhere:(FMIceLinkFunction1 *)where recurse:(bool)recurse

Return Value

The first element found matching the given type, or null if no elements exist for that type.

Discussion

Finds an element in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementWithWhereBlock

Finds an element in the track. This method will recursively call into any branched tracks.
- (NSObject<FMIceLinkIMediaElement> *( ^ ) ( bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *) ))findElementWithWhereBlock

Return Value

The first element found matching the given type, or null if no elements exist for that type.

Discussion

Finds an element in the track. This method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementWithWhereBlock:

Finds an element in the track. This method will recursively call into any branched tracks.
- (NSObject<FMIceLinkIMediaElement> *)findElementWithWhereBlock:(bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *))whereBlock

Return Value

The first element found matching the given type, or null if no elements exist for that type.

Discussion

Finds an element in the track. This method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementWithWhereBlock:recurse:

Finds an element in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.
- (NSObject<FMIceLinkIMediaElement> *)findElementWithWhereBlock:(bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *))whereBlock recurse:(bool)recurse

Return Value

The first element found matching the given type, or null if no elements exist for that type.

Discussion

Finds an element in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– findElementWithWhereBlockAndRecurse

Finds an element in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.
- (NSObject<FMIceLinkIMediaElement> *( ^ ) ( bool ( ^ ) ( NSObject<FMIceLinkIMediaElement> *) , bool ))findElementWithWhereBlockAndRecurse

Return Value

The first element found matching the given type, or null if no elements exist for that type.

Discussion

Finds an element in this track. If the recurse flag is set, then this method will recursively call into any branched tracks.

Declared In

FMIceLinkMediaTrack.h

– firstElement

Gets the first element.
- (NSObject<FMIceLinkIMediaElement> *)firstElement

Discussion

Gets the first element.

Declared In

FMIceLinkMediaTrack.h

– getSinkOutputs

Gets the available [sink](#//api/name/sink) [outputs](#//api/name/outputs).

@return A future with an array of sink outputs.

- (FMIceLinkFuture *)getSinkOutputs

Discussion

Gets the available [sink](#//api/name/sink) [outputs](#//api/name/outputs).

@return A future with an array of sink outputs.

Declared In

FMIceLinkMediaTrack.h

– getSourceInputs

Gets the available [source](#//api/name/source) [inputs](#//api/name/inputs).

@return A future with an array of source inputs.

- (FMIceLinkFuture *)getSourceInputs

Discussion

Gets the available [source](#//api/name/source) [inputs](#//api/name/inputs).

@return A future with an array of source inputs.

Declared In

FMIceLinkMediaTrack.h

– id

Gets the identifier.
- (NSString *)id

Discussion

Gets the identifier.

Declared In

FMIceLinkMediaTrack.h

– init

Initializes a new instance of the FMIceLinkMediaTrack`14 class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkMediaTrack`14 class.

Declared In

FMIceLinkMediaTrack.h

– input

Gets the first input, if this track has [inputs](#//api/name/inputs). Otherwise, returns null.
- (NSObject<FMIceLinkIMediaInput> *)input

Discussion

Gets the first input, if this track has [inputs](#//api/name/inputs). Otherwise, returns null.

Declared In

FMIceLinkMediaTrack.h

– inputFormat

Gets the [input](#//api/name/input) format.
- (FMIceLinkMediaFormat *)inputFormat

Discussion

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

Declared In

FMIceLinkMediaTrack.h

– inputs

Gets the track inputs.
- (NSMutableArray *)inputs

Discussion

Gets the track inputs.

Declared In

FMIceLinkMediaTrack.h

– isBranched

Gets a value indicating whether this track's last element is a branch.
- (bool)isBranched

Discussion

Gets a value indicating whether this track's last element is a branch.

Declared In

FMIceLinkMediaTrack.h

– isBranchWithElement:

Determines whether the specified element is a branch.
- (bool)isBranchWithElement:(NSObject<FMIceLinkIMediaElement> *)element

Parameters

element

The element.

Discussion

Determines whether the specified element is a branch.

Declared In

FMIceLinkMediaTrack.h

– isEmpty

Gets a value indicating whether this instance is empty.
- (bool)isEmpty

Discussion

Gets a value indicating whether this instance is empty.

Declared In

FMIceLinkMediaTrack.h

– isInputWithElement:

Determines whether the specified element is an [input](#//api/name/input).
- (bool)isInputWithElement:(NSObject<FMIceLinkIMediaElement> *)element

Parameters

element

The element. @return

Discussion

Determines whether the specified element is an [input](#//api/name/input).

Declared In

FMIceLinkMediaTrack.h

– isOutputWithElement:

Determines whether the specified element is an [output](#//api/name/output).
- (bool)isOutputWithElement:(NSObject<FMIceLinkIMediaElement> *)element

Parameters

element

The element. @return

Discussion

Determines whether the specified element is an [output](#//api/name/output).

Declared In

FMIceLinkMediaTrack.h

– isPipeWithElement:

Determines whether the specified element is a pipe.
- (bool)isPipeWithElement:(NSObject<FMIceLinkIMediaElement> *)element

Parameters

element

The element.

Discussion

Determines whether the specified element is a pipe.

Declared In

FMIceLinkMediaTrack.h

– isSinkWithElement:

Determines whether the specified element is a [sink](#//api/name/sink).
- (bool)isSinkWithElement:(NSObject<FMIceLinkIMediaElement> *)element

Parameters

element

The element.

Discussion

Determines whether the specified element is a [sink](#//api/name/sink).

Declared In

FMIceLinkMediaTrack.h

– isSourceWithElement:

Determines whether the specified element is a [source](#//api/name/source).
- (bool)isSourceWithElement:(NSObject<FMIceLinkIMediaElement> *)element

Parameters

element

The element.

Discussion

Determines whether the specified element is a [source](#//api/name/source).

Declared In

FMIceLinkMediaTrack.h

– isStreamWithElement:

Determines whether the specified element is a stream.
- (bool)isStreamWithElement:(NSObject<FMIceLinkIMediaElement> *)element

Parameters

element

The element.

Discussion

Determines whether the specified element is a stream.

Declared In

FMIceLinkMediaTrack.h

– isTerminated

Gets a value indicating whether this track's last element is a [sink](#//api/name/sink).
- (bool)isTerminated

Discussion

Gets a value indicating whether this track's last element is a [sink](#//api/name/sink).

Declared In

FMIceLinkMediaTrack.h

– label

Gets a label that identifies this class.
- (NSString *)label

Discussion

Gets a label that identifies this class.

Declared In

FMIceLinkMediaTrack.h

– lastElement

Gets the last element.
- (NSObject<FMIceLinkIMediaElement> *)lastElement

Discussion

Gets the last element.

Declared In

FMIceLinkMediaTrack.h

+ mediaTrack

Initializes a new instance of the FMIceLinkMediaTrack`14 class.
+ (FMIceLinkMediaTrack *)mediaTrack

Discussion

Initializes a new instance of the FMIceLinkMediaTrack`14 class.

Declared In

FMIceLinkMediaTrack.h

– muted

Gets a value indicating whether any of the [elements](#//api/name/elements) in this track are muted. Setting a value will apply to all [elements](#//api/name/elements).
- (bool)muted

Discussion

Gets a value indicating whether any of the [elements](#//api/name/elements) in this track are muted. Setting a value will apply to all [elements](#//api/name/elements).

Declared In

FMIceLinkMediaTrack.h

– next:

Adds an element to this track.
- (FMIceLinkMediaTrack *)next:(NSObject<FMIceLinkIMediaInput> *)next

Parameters

next

The next element.

Discussion

Adds an element to this track.

Declared In

FMIceLinkMediaTrack.h

– nextWithBranch:

Branches out to several tracks.
- (FMIceLinkMediaTrack *)nextWithBranch:(FMIceLinkMediaBranch *)branch

Parameters

branch

The tracks.

Discussion

Branches out to several tracks.

Declared In

FMIceLinkMediaTrack.h

– nextWithTracks:

Branches out to several tracks.
- (FMIceLinkMediaTrack *)nextWithTracks:(NSMutableArray *)tracks

Parameters

tracks

The tracks.

Discussion

Branches out to several tracks.

Declared In

FMIceLinkMediaTrack.h

– output

Gets the first output, if this track has [outputs](#//api/name/outputs). Otherwise, returns null.
- (NSObject<FMIceLinkIMediaOutput> *)output

Discussion

Gets the first output, if this track has [outputs](#//api/name/outputs). Otherwise, returns null.

Declared In

FMIceLinkMediaTrack.h

– outputFormat

Gets the [output](#//api/name/output) format.
- (FMIceLinkMediaFormat *)outputFormat

Discussion

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

Declared In

FMIceLinkMediaTrack.h

– outputs

Gets the track outputs.
- (NSMutableArray *)outputs

Discussion

Gets the track outputs.

Declared In

FMIceLinkMediaTrack.h

– persistent

Gets a value indicating whether this instance is persistent. If true, this instance will not be destroyed unless FMIceLinkMediaTrack`14#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent [elements](#//api/name/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 FMIceLinkMediaTrack`14#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent [elements](#//api/name/elements) that are being destroyed.

Declared In

FMIceLinkMediaTrack.h

– pipelineJson

Gets the pipeline JSON using the first element as a starting point.
- (NSString *)pipelineJson

Discussion

Gets the pipeline JSON using the first element as a starting point.

Declared In

FMIceLinkMediaTrack.h

– raiseOnStarted

Raises the FMIceLinkMediaTrack`14#[addOnStarted:](#//api/name/addOnStarted:) event.
- (void)raiseOnStarted

Discussion

Raises the FMIceLinkMediaTrack`14#[addOnStarted:](#//api/name/addOnStarted:) event.

Declared In

FMIceLinkMediaTrack.h

– raiseOnStopped

Raises the FMIceLinkMediaTrack`14#[addOnStopped:](#//api/name/addOnStopped:) event.
- (void)raiseOnStopped

Discussion

Raises the FMIceLinkMediaTrack`14#[addOnStopped:](#//api/name/addOnStopped:) event.

Declared In

FMIceLinkMediaTrack.h

– removeOnDestroyed:

Removes a handler that is raised when the track is destroyed.
- (void)removeOnDestroyed:(FMIceLinkAction0 *)value

Discussion

Removes a handler that is raised when the track is destroyed.

Declared In

FMIceLinkMediaTrack.h

– removeOnStarted:

Removes a handler that is raised when the track is started. Only applicable for local media tracks.
- (void)removeOnStarted:(FMIceLinkAction0 *)value

Discussion

Removes a handler that is raised when the track is started. Only applicable for local media tracks.

Declared In

FMIceLinkMediaTrack.h

– removeOnStopped:

Removes a handler that is raised when the track is stopped. Only applicable for local media tracks.
- (void)removeOnStopped:(FMIceLinkAction0 *)value

Discussion

Removes a handler that is raised when the track is stopped. Only applicable for local media tracks.

Declared In

FMIceLinkMediaTrack.h

– setId:

Sets the identifier.
- (void)setId:(NSString *)value

Discussion

Sets the identifier.

Declared In

FMIceLinkMediaTrack.h

– setMuted:

Sets a value indicating whether any of the [elements](#//api/name/elements) in this track are [muted](#//api/name/muted). Setting a value will apply to all [elements](#//api/name/elements).
- (void)setMuted:(bool)value

Discussion

Sets a value indicating whether any of the [elements](#//api/name/elements) in this track are [muted](#//api/name/muted). Setting a value will apply to all [elements](#//api/name/elements).

Declared In

FMIceLinkMediaTrack.h

– setPersistent:

Sets a value indicating whether this instance is [persistent](#//api/name/persistent). If true, this instance will not be destroyed unless FMIceLinkMediaTrack`14#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent [elements](#//api/name/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 FMIceLinkMediaTrack`14#[destroy](#//api/name/destroy) is called explicitly on this instance. It will survive destruction of any parent [elements](#//api/name/elements) that are being destroyed.

Declared In

FMIceLinkMediaTrack.h

– setSinkOutput:

Sets the current [sink](#//api/name/sink) [output](#//api/name/output).
- (void)setSinkOutput:(FMIceLinkSinkOutput *)value

Discussion

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

Declared In

FMIceLinkMediaTrack.h

– setSourceInput:

Sets the current [source](#//api/name/source) [input](#//api/name/input).
- (void)setSourceInput:(FMIceLinkSourceInput *)value

Discussion

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

Declared In

FMIceLinkMediaTrack.h

– sink

Gets the sink, if the last element is a sink. Otherwise, returns null.
- (FMIceLinkMediaSink *)sink

Discussion

Gets the sink, if the last element is a sink. Otherwise, returns null.

Declared In

FMIceLinkMediaTrack.h

– sinkOutput

Gets the current [sink](#//api/name/sink) [output](#//api/name/output).
- (FMIceLinkSinkOutput *)sinkOutput

Discussion

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

Declared In

FMIceLinkMediaTrack.h

– sinks

Gets the sinks.
- (NSMutableArray *)sinks

Discussion

Gets the sinks.

Declared In

FMIceLinkMediaTrack.h

– source

Gets the source, if the first element is a source. Otherwise, returns null.
- (FMIceLinkMediaSource *)source

Discussion

Gets the source, if the first element is a source. Otherwise, returns null.

Declared In

FMIceLinkMediaTrack.h

– sourceInput

Gets the current [source](#//api/name/source) [input](#//api/name/input).
- (FMIceLinkSourceInput *)sourceInput

Discussion

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

Declared In

FMIceLinkMediaTrack.h