FMLiveSwitchMediaBranch Class Reference

A media branch. More...

Instance Methods

(TTrack) - activeTrack
 Gets the first active track. More...
 
(NSMutableArray *) - activeTracks
 Gets the active tracks. More...
 
(NSMutableArray *) - arrayFromTracks:
 Creates an array of tracks from a list of tracks. More...
 
(bool) - deactivated
 Gets a value indicating whether this branch is deactivated. More...
 
(NSString *) - description
 Returns a string that represents this instance. More...
 
(bool) - destroy
 Destroys this instance. More...
 
(bool) - disabled
 Gets a value indicating whether this branch is disabled. More...
 
(NSString *) - externalId
 Gets the external identifier. More...
 
(NSString *) - id
 Gets the identifier. More...
 
(instancetype) - initWithTracks:
 Initializes a new instance of the FMLiveSwitchMediaBranch`14 class. More...
 
(NSString *) - label
 Gets a label that identifies this class. More...
 
(bool) - muted
 Gets a value indicating whether any of the tracks in this branch are muted. More...
 
(bool) - paused
 Gets a value indicating whether this branch is paused. More...
 
(bool) - persistent
 Gets a value indicating whether this instance is persistent. More...
 
(NSString *) - pipelineJson
 Gets the pipeline JSON with this as the central point. More...
 
(void) - setDeactivated:
 Sets a value indicating whether this branch is deactivated. More...
 
(void) - setExternalId:
 Sets the external identifier. More...
 
(void) - setMuted:
 Sets a value indicating whether any of the tracks in this branch are muted. More...
 
(void) - setPersistent:
 Sets a value indicating whether this instance is persistent. More...
 
(TTrack) - track
 Gets the first track. More...
 
(NSMutableArray *) - tracks
 Gets the tracks. More...
 

Class Methods

(FMLiveSwitchMediaBranch *) + mediaBranchWithTracks:
 Initializes a new instance of the FMLiveSwitchMediaBranch`14 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchDynamic<FMLiveSwitchIMediaElement
 

Detailed Description

A media branch.

Method Documentation

◆ activeTrack

- (TTrack) activeTrack

Gets the first active track.

◆ activeTracks

- (NSMutableArray*) activeTracks

Gets the active tracks.

◆ arrayFromTracks:

- (NSMutableArray*) arrayFromTracks: (NSMutableArray< TTrack > *)  tracks

Creates an array of tracks from a list of tracks.

Parameters
tracksThe list of tracks.

◆ deactivated

- (bool) deactivated

Gets a value indicating whether this branch is deactivated.

A branch is deactivated if its active tracks are deactivated.

◆ description

- (NSString*) description

Returns a string that represents this instance.

◆ destroy

- (bool) destroy

Destroys this instance.

◆ disabled

- (bool) disabled

Gets a value indicating whether this branch is disabled.

A branch is disabled if its active tracks are disabled.

◆ externalId

- (NSString*) externalId

Gets the external identifier.

◆ id

- (NSString*) id

Gets the identifier.

◆ initWithTracks:

- (instancetype) initWithTracks: (NSMutableArray *)  tracks

Initializes a new instance of the FMLiveSwitchMediaBranch`14 class.

Implemented in FMLiveSwitchVideoBranch, and FMLiveSwitchAudioBranch.

◆ label

- (NSString*) label

Gets a label that identifies this class.

Implemented in FMLiveSwitchVideoBranch, and FMLiveSwitchAudioBranch.

◆ mediaBranchWithTracks:

+ (FMLiveSwitchMediaBranch*) mediaBranchWithTracks: (NSMutableArray *)  tracks

Initializes a new instance of the FMLiveSwitchMediaBranch`14 class.

◆ muted

- (bool) muted

Gets a value indicating whether any of the tracks in this branch are muted.

Setting a value will apply to all elements.

◆ paused

- (bool) paused

Gets a value indicating whether this branch is paused.

A branch is paused if its active tracks are paused.

◆ persistent

- (bool) persistent

Gets a value indicating whether this instance is persistent.

If true, this instance will not be destroyed unless FMLiveSwitchMediaBranch`14destroy is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

◆ pipelineJson

- (NSString*) pipelineJson

Gets the pipeline JSON with this as the central point.

◆ setDeactivated:

- (void) setDeactivated: (bool)  value

Sets a value indicating whether this branch is deactivated.

A branch is deactivated if its active tracks are deactivated.

◆ setExternalId:

- (void) setExternalId: (NSString *)  value

Sets the external identifier.

◆ setMuted:

- (void) setMuted: (bool)  value

Sets a value indicating whether any of the tracks in this branch are muted.

Setting a value will apply to all elements.

◆ setPersistent:

- (void) setPersistent: (bool)  value

Sets a value indicating whether this instance is persistent.

If true, this instance will not be destroyed unless FMLiveSwitchMediaBranch`14destroy is called explicitly on this instance. It will survive destruction of any parent elements that are being destroyed.

◆ track

- (TTrack) track

Gets the first track.

◆ tracks

- (NSMutableArray*) tracks

Gets the tracks.

Member Data Documentation

◆ __pad0__

- __pad0__
protected