FMLiveSwitchMediaTrackBase Class Reference

Media track base properties/methods. More...

Instance Methods

(void) - addOnDestroyed:
 Adds a handler that is raised when the track is destroyed. More...
 
(void) - addOnMuted:
 Adds a handler that is raised when the track is muted. More...
 
(void) - addOnStarted:
 Adds a handler that is raised when the track is started. More...
 
(void) - addOnStopped:
 Adds a handler that is raised when the track is stopped. More...
 
(void) - addOnUnmuted:
 Adds a handler that is raised when the track is unmuted. More...
 
(FMLiveSwitchFuture< id > *) - changeSinkOutput:
 Changes the sink output while the media track is active. More...
 
(FMLiveSwitchFuture< id > *) - changeSourceInput:
 Changes the source input while the media track is active. More...
 
(bool) - destroy
 Destroys this media track. More...
 
(FMLiveSwitchFuture< NSMutableArray * > *) - getSinkOutputs
 Gets the available sink outputs. More...
 
(FMLiveSwitchFuture< NSMutableArray * > *) - getSourceInputs
 Gets the available source inputs. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 
(bool) - muted
 Gets a value indicating whether this track is muted. More...
 
(void) - removeOnDestroyed:
 Removes a handler that is raised when the track is destroyed. More...
 
(void) - removeOnMuted:
 Removes a handler that is raised when the track is muted. More...
 
(void) - removeOnStarted:
 Removes a handler that is raised when the track is started. More...
 
(void) - removeOnStopped:
 Removes a handler that is raised when the track is stopped. More...
 
(void) - removeOnUnmuted:
 Removes a handler that is raised when the track is unmuted. More...
 
(void) - setMuted:
 Sets a value indicating whether this track is muted. More...
 
(void) - setSinkOutput:
 Sets the current sink output. More...
 
(void) - setSourceInput:
 Sets the current source input. More...
 
(FMLiveSwitchSinkOutput *) - sinkOutput
 Gets the current sink output. More...
 
(FMLiveSwitchSourceInput *) - sourceInput
 Gets the current source input. More...
 
- Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString *, id > *) - dynamicProperties
 Gets all dynamic properties on this instance. More...
 
(id- getDynamicValueWithKey:
 Gets a property value from the local cache. More...
 
(void) - setDynamicValueWithKey:value:
 Sets a property value in the local cache. More...
 
(bool) - unsetDynamicValueWithKey:
 Removes a property value from the local cache. More...
 

Class Methods

(FMLiveSwitchMediaTrackBase *) + mediaTrackBase
 
- Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *) + dynamic
 
- Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *) + serializable
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 

Detailed Description

Media track base properties/methods.

Method Documentation

◆ addOnDestroyed:

- (void) addOnDestroyed: (FMLiveSwitchAction0 *)  value

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

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ addOnMuted:

- (void) addOnMuted: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ addOnStarted:

- (void) addOnStarted: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ addOnStopped:

- (void) addOnStopped: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ addOnUnmuted:

- (void) addOnUnmuted: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ changeSinkOutput:

- (FMLiveSwitchFuture<id>*) changeSinkOutput: (FMLiveSwitchSinkOutput *)  sinkOutput

Changes the sink output while the media track is active.

Parameters
sinkOutputThe sink output.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ changeSourceInput:

- (FMLiveSwitchFuture<id>*) changeSourceInput: (FMLiveSwitchSourceInput *)  sourceInput

Changes the source input while the media track is active.

Parameters
sourceInputThe source input.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ destroy

- (bool) destroy

Destroys this media track.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ getSinkOutputs

- (FMLiveSwitchFuture<NSMutableArray*>*) getSinkOutputs

Gets the available sink outputs.

Returns
A future with an array of sink outputs.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ getSourceInputs

- (FMLiveSwitchFuture<NSMutableArray*>*) getSourceInputs

Gets the available source inputs.

Returns
A future with an array of source inputs.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchSerializable class.

Implements FMLiveSwitchDynamic.

◆ mediaTrackBase

+ (FMLiveSwitchMediaTrackBase*) mediaTrackBase

◆ muted

- (bool) muted

Gets a value indicating whether this track is muted.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ removeOnDestroyed:

- (void) removeOnDestroyed: (FMLiveSwitchAction0 *)  value

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

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ removeOnMuted:

- (void) removeOnMuted: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ removeOnStarted:

- (void) removeOnStarted: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ removeOnStopped:

- (void) removeOnStopped: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ removeOnUnmuted:

- (void) removeOnUnmuted: (FMLiveSwitchAction0 *)  value

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

Only applicable for local media tracks.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ setMuted:

- (void) setMuted: (bool)  value

Sets a value indicating whether this track is muted.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ setSinkOutput:

- (void) setSinkOutput: (FMLiveSwitchSinkOutput *)  value

Sets the current sink output.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ setSourceInput:

- (void) setSourceInput: (FMLiveSwitchSourceInput *)  value

Sets the current source input.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ sinkOutput

- (FMLiveSwitchSinkOutput*) sinkOutput

Gets the current sink output.

Reimplemented from <FMLiveSwitchIMediaTrack>.

◆ sourceInput

- (FMLiveSwitchSourceInput*) sourceInput

Gets the current source input.

Reimplemented from <FMLiveSwitchIMediaTrack>.