fm.liveswitch.IAudioOutput Interface Reference

An audio output. More...

Public Member Functions

abstract fm.liveswitch.AudioConfig getConfig ()
 Gets the configuration. More...
 
abstract double getVolume ()
 Gets a value indicating the volume (output resistance) of this source. More...
 
abstract void setVolume (double value)
 Sets a value indicating the volume (output resistance) of this source. More...
 
- Public Member Functions inherited from fm.liveswitch.IElement
abstract String getExternalId ()
 Gets the external identifier. More...
 
abstract String getId ()
 Gets the identifier. More...
 
abstract String getPipelineJson ()
 Gets the pipeline JSON with this as the central point. More...
 
abstract void setExternalId (String value)
 Sets the external identifier. More...
 
- Public Member Functions inherited from fm.liveswitch.IMediaElement
abstract boolean destroy ()
 Destroys this instance. More...
 
abstract boolean getDeactivated ()
 Gets a value indicating whether this instance is deactivated. More...
 
abstract boolean getDisabled ()
 Gets a value indicating whether this instance is disabled. More...
 
abstract String getLabel ()
 Gets a label that identifies this instance. More...
 
abstract boolean getMuted ()
 Gets a value indicating whether this instance is muted. More...
 
abstract boolean getPaused ()
 Gets a value indicating whether this instance is paused. More...
 
abstract boolean getPersistent ()
 Gets a value indicating whether this instance is persistent. More...
 
abstract void setDeactivated (boolean value)
 Sets a value indicating whether this instance is deactivated. More...
 
abstract void setMuted (boolean value)
 Sets a value indicating whether this instance is muted. More...
 

Detailed Description

An audio output.

Member Function Documentation

◆ getConfig()

abstract fm.liveswitch.AudioConfig fm.liveswitch.IAudioOutput.getConfig ( )
abstract

Gets the configuration.

Implemented in fm.liveswitch.AudioStream, fm.liveswitch.AudioSource, and fm.liveswitch.AudioPipe.

◆ getVolume()

abstract double fm.liveswitch.IAudioOutput.getVolume ( )
abstract

Gets a value indicating the volume (output resistance) of this source.

Valid value range is 0.0 to 1.0, inclusive.

Implemented in fm.liveswitch.AudioStream, fm.liveswitch.AudioSource, and fm.liveswitch.AudioPipe.

◆ setVolume()

abstract void fm.liveswitch.IAudioOutput.setVolume ( double  value)
abstract

Sets a value indicating the volume (output resistance) of this source.

Valid value range is 0.0 to 1.0, inclusive.

Implemented in fm.liveswitch.AudioStream, fm.liveswitch.AudioSource, and fm.liveswitch.AudioPipe.