javax.microedition.amms.control.audioeffect
Interface ReverbSourceControl

All Superinterfaces:
Control

public interface ReverbSourceControl
extends Control

ReverbSourceControl is an interface for manipulating the feeding from an object to the audio effect called reverb. A ReverbSourceControl can only be fetched from an EffectModule or a SoundSource3D (the terminal nodes of the effects network) (if ReverbSourceControl is supported at all).

Default Values

The default value for all reverb source controls (whether the application has obtained them or not) is: level = 0 mB (natural room gain)

See Also:
ReverbControl
Since:
BlackBerry API 5.0.0

Field Summary
static int DISCONNECT
          The application can use this for setRoomLevel when it does not intend to connect this object (typically EffectModule or SoundSource3D) to the reverb.
 
Method Summary
 int getRoomLevel()
          Gets the object specific level for the reverberant sound.
 void setRoomLevel(int level)
          Sets the object specific level for the reverberant sound.
 



Field Detail

DISCONNECT

static final int DISCONNECT
The application can use this for setRoomLevel when it does not intend to connect this object (typically EffectModule or SoundSource3D) to the reverb. Setting this value will disconnect the object from the global reverb. Also, the implementation can use this to optimize the performance and totally remove feeds into the reverb that never will be used. The method setRoomLevel can throw a MediaException if the application tries to changed this in a non-supported state. Typically, it may be supported to use the DISCONNECT in the REALIZED state but not in any other state of the involved Players.

See Also:
Constant Field Values
Since:
BlackBerry API 5.0.0


Method Detail

setRoomLevel

void setRoomLevel(int level)
                  throws MediaException
Sets the object specific level for the reverberant sound.

Parameters:
level - the level of the reflected sound compared to the natural room gain in millibels (mB, 1 mB = 1/100 dB); must be a non-positive value. The default value is 0 meaning the natural room gain (set by ReverbControl's presets). Setting this value as Integer.MIN_VALUE disables the reflected sound for the given object. With the value DISCONNECT, the object can be disconnected from the reverb.
Throws:
IllegalArgumentException - if the factor is not DISCONNECT, and factor > 0
MediaException - @see DISCONNECT if the value (typically for DISCONNECTing or connecting) has been attempted to be set in a wrong state of the associated Player(s). (Typically, DISCONNECTing or connecting is possible only in the REALIZED state of the associated Players.)
Since:
BlackBerry API 5.0.0

getRoomLevel

int getRoomLevel()
Gets the object specific level for the reverberant sound.

Returns:
the current level of the reflected sound compared to the natural room level in millibels or DISCONNECT
Since:
BlackBerry API 5.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.