FMIceLinkMediaBranch Class Reference

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

Overview

A media branch.

The type of the output interface.The type of the output interface collection.The type of the input interface.The type of the input interface 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.

– activeTrack

Gets the first active [track](#//api/name/track).
- (FMIceLinkMediaTrack *)activeTrack

Discussion

Gets the first active [track](#//api/name/track).

Declared In

FMIceLinkMediaBranch.h

– activeTracks

Gets the active [tracks](#//api/name/tracks).
- (NSMutableArray *)activeTracks

Discussion

Gets the active [tracks](#//api/name/tracks).

Declared In

FMIceLinkMediaBranch.h

– arrayFromTracks:

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

Parameters

tracks

The list of tracks.

Discussion

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

Declared In

FMIceLinkMediaBranch.h

– description

Returns a string that represents this instance.
- (NSString *)description

Discussion

Returns a string that represents this instance.

Declared In

FMIceLinkMediaBranch.h

– destroy

Destroys this instance.
- (bool)destroy

Discussion

Destroys this instance.

Declared In

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

FMIceLinkMediaBranch.h

– id

Gets the identifier.
- (NSString *)id

Discussion

Gets the identifier.

Declared In

FMIceLinkMediaBranch.h

– initWithTracks:

Initializes a new instance of the FMIceLinkMediaBranch`14 class.
- (instancetype)initWithTracks:(NSMutableArray *)tracks

Discussion

Initializes a new instance of the FMIceLinkMediaBranch`14 class.

Declared In

FMIceLinkMediaBranch.h

– label

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

Discussion

Gets a label that identifies this class.

Declared In

FMIceLinkMediaBranch.h

+ mediaBranchWithTracks:

Initializes a new instance of the FMIceLinkMediaBranch`14 class.
+ (FMIceLinkMediaBranch *)mediaBranchWithTracks:(NSMutableArray *)tracks

Discussion

Initializes a new instance of the FMIceLinkMediaBranch`14 class.

Declared In

FMIceLinkMediaBranch.h

– muted

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

Discussion

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

Declared In

FMIceLinkMediaBranch.h

– persistent

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

Declared In

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

FMIceLinkMediaBranch.h

– setId:

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

Discussion

Sets the identifier.

Declared In

FMIceLinkMediaBranch.h

– setMuted:

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

Discussion

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

Declared In

FMIceLinkMediaBranch.h

– setPersistent:

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

Declared In

FMIceLinkMediaBranch.h

– track

Gets the first track.
- (FMIceLinkMediaTrack *)track

Discussion

Gets the first track.

Declared In

FMIceLinkMediaBranch.h

– tracks

Gets the tracks.
- (NSMutableArray *)tracks

Discussion

Gets the tracks.

Declared In

FMIceLinkMediaBranch.h