File Doc Category Size Date Package
PitchControl.java API Doc phoneME MR2 API (J2ME) 4226 Wed May 02 16:47:14 BST 2007 javax.microedition.media.control

PitchControl

public interface PitchControl implements javax.microedition.media.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.

see: javax.microedition.media.Player
see: javax.microedition.media.control.RateControl
see: javax.microedition.media.control.TempoControl

Fields Summary
Constructors Summary
Methods Summary
public int getMaxPitch()
Gets the maximum playback pitch raise supported by the Player.
return
the maximum pitch raise in "milli-semitones".
public int getMinPitch()
Gets the minimum playback pitch raise supported by the Player.
return
the minimum pitch raise in "milli-semitones".
public int getPitch()
Gets the current playback pitch raise.
return
the current playback pitch raise in "milli-semitones".
see
#setPitch
public 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 {@link javax.microedition.media.Player 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.
param
millisemitones The number of semi tones to raise the playback pitch. It is specified in "milli-semitones".
return
The actual pitch raise set in "milli-semitones".
see
#getPitch