javax.microedition.media.control
Interface PitchControl

All Superinterfaces:
Control

public interface PitchControl
extends Control

PitchControl raises or lowers the playback pitch of audio without changing the playback speed.

PitchControl can be implemented in Players for MIDI media or sampled audio. It is not possible to set audible output to an absolute pitch value. This control raises or lowers pitch relative to the original.

The pitch change is specified in number of "milli-semitones" to raise the pitch. As an example, specifying a pitch of 12'000 results in playback one octave higher. For MIDI that means that all MIDI notes are raised by 12 (semitones). For sampled audio playback, it means doubling the frequency of perceived sounds (i.e. a 440Hz sound will become a 880Hz sound.). Negative values are used to lower the pitch.

All Players by default support 0, or no pitch change. A Player which supports only 0 pitch change must not implement PitchControl.

PitchControl does not influence playback volume in any way.

Since:
BlackBerry API 4.0.0

Method Summary
 int getMaxPitch()
          Gets the maximum playback pitch raise supported by the Player
 int getMinPitch()
          Gets the minimum playback pitch raise supported by the Player
 int getPitch()
          Gets the current playback pitch raise.
 int setPitch(int millisemitones)
          Sets the relative pitch raise.
 



Method Detail

setPitch

int setPitch(int millisemitones)
Sets the relative pitch raise. The pitch change is specified in "milli-semitones", i.e. 1000 times the number of semitones to raise the pitch. Negative values lower the pitch by the number of milli-semitones.

The setPitch method returns the actual pitch change set by the Player. Players should set their pitch raise as close to the requested value as possible, but are not required to set it to the exact value of any argument other than 0. A Player is only guaranteed to set its pitch change exactly to 0. If the given pitch raise is less than the value returned by getMinPitch or greater than the value returned by getMaxPitch, it will be adjusted to the minimum or maximum supported pitch raise respectively.

Parameters:
millisemitones - The number of semi tones to raise the playback pitch. It is specified in "millisemitones".
Returns:
The actual pitch raise set in "milli-semitones".
See Also:
PitchControl.getPitch()
Since:
BlackBerry API 4.0.0

getPitch

int getPitch()
Gets the current playback pitch raise.

Returns:
the current playback pitch raise in "milli-semitones".
Since:
BlackBerry API 4.0.0

getMaxPitch

int getMaxPitch()
Gets the maximum playback pitch raise supported by the Player

Returns:
the maximum pitch raise in "milli-semitones".
Since:
BlackBerry API 4.0.0

getMinPitch

int getMinPitch()
Gets the minimum playback pitch raise supported by the Player

Returns:
the minimum pitch raise in "milli-semitones".
Since:
BlackBerry API 4.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.