fm.liveswitch.JitterAudioPipe Class Reference

An audio pipe that wraps a jitter buffer. More...

Public Member Functions

String getLabel ()
 Gets the label of the pipe. More...
 
 JitterAudioPipe (fm.liveswitch.AudioFormat format)
 Initializes a new instance of the fm.liveswitch.JitterAudioPipe class with a 100ms length. More...
 
 JitterAudioPipe (fm.liveswitch.AudioFormat format, int length)
 Initializes a new instance of the fm.liveswitch.JitterAudioPipe class. More...
 
- Public Member Functions inherited from fm.liveswitch.AudioPipe
 AudioPipe (fm.liveswitch.AudioFormat inputFormat, fm.liveswitch.AudioFormat outputFormat)
 Initializes a new instance of the fm.liveswitch.AudioPipe class. More...
 
 AudioPipe (fm.liveswitch.AudioFormat outputFormat)
 Initializes a new instance of the fm.liveswitch.AudioPipe class. More...
 
fm.liveswitch.AudioConfig getConfig ()
 Gets the output configuration. More...
 
double getGain ()
 Gets a value indicating the gain (input amplification) of this sink. More...
 
fm.liveswitch.AudioConfig getInputConfig ()
 Gets the input configuration. More...
 
fm.liveswitch.AudioConfig getOutputConfig ()
 Gets the output configuration. More...
 
double getVolume ()
 Gets a value indicating the volume (output resistance) of this source. More...
 
boolean processFrame (fm.liveswitch.AudioFrame frame)
 Processes a frame. More...
 
void setGain (double value)
 Sets a value indicating the gain (input amplification) of this sink. More...
 
void setVolume (double value)
 Sets a value indicating the volume (output resistance) of this source. More...
 
- Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object > getDynamicProperties ()
 Gets all dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Removes a property value from the local cache. 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 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...
 

Protected Member Functions

void doDestroy ()
 Destroys this instance. More...
 
void doProcessFrame (fm.liveswitch.AudioFrame frame, fm.liveswitch.AudioBuffer inputBuffer)
 Pushes the frame to the jitter buffer and raises any frames that are ready. More...
 
- Protected Member Functions inherited from fm.liveswitch.AudioPipe
fm.liveswitch.AudioFrame createFrame (fm.liveswitch.AudioBuffer buffer)
 Creates a frame. More...
 
fm.liveswitch.IAudioInputCollection createInputCollection (fm.liveswitch.IAudioOutput output)
 Creates an input collection. More...
 
fm.liveswitch.IAudioOutputCollection createOutputCollection (fm.liveswitch.IAudioInput input)
 Creates an output collection. More...
 
void raiseFrame (fm.liveswitch.AudioFrame frame)
 Raises a frame. More...
 
- Protected Member Functions inherited from fm.liveswitch.Dynamic
 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

An audio pipe that wraps a jitter buffer.

Constructor & Destructor Documentation

◆ JitterAudioPipe() [1/2]

fm.liveswitch.JitterAudioPipe.JitterAudioPipe ( fm.liveswitch.AudioFormat  format)

Initializes a new instance of the fm.liveswitch.JitterAudioPipe class with a 100ms length.

Parameters
formatThe input/output format.

◆ JitterAudioPipe() [2/2]

fm.liveswitch.JitterAudioPipe.JitterAudioPipe ( fm.liveswitch.AudioFormat  format,
int  length 
)

Initializes a new instance of the fm.liveswitch.JitterAudioPipe class.

Parameters
formatThe input/output format.
lengthThe length of the jitter buffer, in milliseconds.

Member Function Documentation

◆ doDestroy()

void fm.liveswitch.JitterAudioPipe.doDestroy ( )
protected

Destroys this instance.

◆ doProcessFrame()

void fm.liveswitch.JitterAudioPipe.doProcessFrame ( fm.liveswitch.AudioFrame  frame,
fm.liveswitch.AudioBuffer  inputBuffer 
)
protected

Pushes the frame to the jitter buffer and raises any frames that are ready.

Parameters
frameThe frame.
inputBufferThe buffer.

◆ getLabel()

String fm.liveswitch.JitterAudioPipe.getLabel ( )

Gets the label of the pipe.

Implements fm.liveswitch.IMediaElement.