org.jitsi.impl.neomedia.audiolevel

Class AudioLevelEffect2

java.lang.Object

org.jitsi.impl.neomedia.control.AbstractControls

org.jitsi.impl.neomedia.control.ControlsAdapter

org.jitsi.impl.neomedia.audiolevel.AudioLevelEffect2

All Implemented Interfaces:

javax.media.Codec, javax.media.Controls, javax.media.Effect, javax.media.PlugIn

public class AudioLevelEffect2
extends ControlsAdapter
implements javax.media.Effect

An Effect implementation which calculates audio levels based on the samples in the Buffer and includes them in the buffer's headerExtension field in the SSRC audio level format specified in RFC6464. The class is based on AudioLevelEffect, but an important difference is that the actual calculation is performed in the same thread that calls process(javax.media.Buffer, javax.media.Buffer).

Author:

Boris Grozev, Damian Minkov, Emil Ivov, Lyubomir Marinov

Field Summary

Fields inherited from class org.jitsi.impl.neomedia.control.ControlsAdapter

EMPTY_CONTROLS

Fields inherited from interface javax.media.PlugIn

BUFFER_PROCESSED_FAILED, BUFFER_PROCESSED_OK, INPUT_BUFFER_NOT_CONSUMED, OUTPUT_BUFFER_NOT_FILLED, PLUGIN_TERMINATED

Constructor Summary

Constructors

Constructor and Description
AudioLevelEffect2() Initializes a new AudioLevelEffect2.

Method Summary

Modifier and Type	Method and Description
void	close()
String	getName() Gets the name of this plug-in as a human-readable string.
javax.media.Format[]	getSupportedInputFormats() Lists all of the input formats that this codec accepts.
javax.media.Format[]	getSupportedOutputFormats(javax.media.Format input) Lists the output formats that this codec can generate.
boolean	isEnabled()
void	open()
int	process(javax.media.Buffer inputBuffer, javax.media.Buffer outputBuffer) Performs the media processing defined by this codec.
void	reset()
void	setEnabled(boolean enabled) Enables or disables this AudioLevelEffect2 according to the value of enabled.
javax.media.Format	setInputFormat(javax.media.Format format) Sets the format of the data to be input to this codec.
javax.media.Format	setOutputFormat(javax.media.Format format) Sets the format for the data this codec outputs.
void	setRtpHeaderExtensionId(byte rtpHeaderExtensionId) Sets the ID of the RTP header extension which will be added.

Methods inherited from class org.jitsi.impl.neomedia.control.ControlsAdapter

getControls

Methods inherited from class org.jitsi.impl.neomedia.control.AbstractControls

getControl, getControl, queryInterface, queryInterface

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.media.Controls

getControl, getControls

Constructor Detail

AudioLevelEffect2

public AudioLevelEffect2()

Initializes a new AudioLevelEffect2.

Method Detail

getSupportedInputFormats

public javax.media.Format[] getSupportedInputFormats()

Lists all of the input formats that this codec accepts.

Specified by:

getSupportedInputFormats in interface javax.media.Codec

Returns:

An array that contains the supported input Formats.

getSupportedOutputFormats

public javax.media.Format[] getSupportedOutputFormats(javax.media.Format input)

Lists the output formats that this codec can generate.

Specified by:

getSupportedOutputFormats in interface javax.media.Codec

Parameters:

input - The Format of the data to be used as input to the plug-in.

Returns:

An array that contains the supported output Formats.

setInputFormat

public javax.media.Format setInputFormat(javax.media.Format format)

Sets the format of the data to be input to this codec.

Specified by:

setInputFormat in interface javax.media.Codec

Parameters:

format - The Format to be set.

Returns:

The Format that was set.

setOutputFormat

public javax.media.Format setOutputFormat(javax.media.Format format)

Sets the format for the data this codec outputs.

Specified by:

setOutputFormat in interface javax.media.Codec

Parameters:

format - The Format to be set.

Returns:

The Format that was set.

process

public int process(javax.media.Buffer inputBuffer,
                   javax.media.Buffer outputBuffer)

Performs the media processing defined by this codec.

Specified by:

process in interface javax.media.Codec

Parameters:

inputBuffer - The Buffer that contains the media data to be processed.

outputBuffer - The Buffer in which to store the processed media data.

Returns:

BUFFER_PROCESSED_OK if the processing is successful.

See Also:

PlugIn

getName

public String getName()

Gets the name of this plug-in as a human-readable string.

Specified by:

getName in interface javax.media.PlugIn

Returns:

A String that contains the descriptive name of the plug-in.

open

public void open()

Specified by:

open in interface javax.media.PlugIn

close

public void close()

Specified by:

close in interface javax.media.PlugIn

reset

public void reset()

Specified by:

reset in interface javax.media.PlugIn

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

Enables or disables this AudioLevelEffect2 according to the value of enabled.

Parameters:

enabled - whether to enable or disabled this Effect.

setRtpHeaderExtensionId

public void setRtpHeaderExtensionId(byte rtpHeaderExtensionId)

Sets the ID of the RTP header extension which will be added.

Parameters:

rtpHeaderExtensionId - the ID to set.