danger.audio
Class Tone

java.lang.Object
  |
  +--danger.audio.Tone

public class Tone

extends java.lang.Object

This is an abstraction of what a Tone can be. It is one of two types of audio or Tones. 1) a Sequence (Midi, RMF, RTX (ringtone)) 2) a Sound (WAV, AIF) By keeping it abstracted there's one object that is format agnostic, but has all the generic control features (start, stop, etc)

Inner Class Summary

static interface	Tone.Errors Most methods return and error code
static interface	Tone.Origin

Field Summary

static int

USE_DEFAULT_VOLUME In all Play methods: Use USE_DEFAULT_VOLUME to force use of class volume levels.

Constructor Summary

Tone(boolean isRtxString, int id, java.lang.String s, boolean preload, boolean loop, int pri, int volume, int filters, int klass, java.lang.String name, java.lang.String group)

Tone(boolean isRtxString, java.lang.String s, boolean preload, boolean loop, int pri, int volume, int filters, int klass, java.lang.String name, java.lang.String group)
If isRtxString is true, then create a Tone with a RTX (Nokia Ringtone) formatted String into a Sequence RTX is backward compatibile with RTTTL.

Tone(byte[] data, int id, boolean preload, boolean loop, int pri, int volume, int filters, int klass, java.lang.String name, java.lang.String group)
Create a Tone with custom formated byte data.

Tone(int resourceID, boolean preload, boolean loop, int pri, int volume, int filters, int klass, int route, java.lang.String name, java.lang.String group)
Create a Tone with a resource ID

Method Summary

ToneRecordStore	createToneRecordStore() Convert this Tone into a ToneRecordStore.
void	destroy() destroy and unload all assoicated data.
void	displayState()
boolean	getDefaultLoop()
int	getDefaultVolume()
java.lang.String	getGroupName()
int	getInitialFilter()
boolean	getLoop()
java.lang.String	getName()
int	getOrigin()
int	getPlaybackFilter()
int	getPriority()
java.lang.String	getProductID() return private Product ID
int	getResourceID() return private resource ID
int	getRoute()
int	getRuntimeID()
int	getTempo()
int	getToneClass()
int	getTranspose()
int	getVolume()
boolean	hasBuzzer()
boolean	hasFlasher()
boolean	hasSound() return object sound/buzz/flash status
boolean	isDone()
boolean	isLoaded()
void	load(boolean autoDelete)
void	play(int volume)
void	play(int volume, int filter) load if not loaded, and start playing the tone
void	setDefaultVolume(int volume)
void	setLoop(boolean on)
void	setName(java.lang.String name)
void	setOrigin(int origin)
void	setPriority(int level)
void	setProductID(java.lang.String productID) set private resource ID
void	SetResourceID(int id) set private resource ID
void	setRoute(int route)
void	setTempo(int tempo)
void	setToneClass(int klass)
void	setTranspose(int transpose)
void	setVolume(int volume)
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

USE_DEFAULT_VOLUME

public static final int USE_DEFAULT_VOLUME

In all Play methods: Use USE_DEFAULT_VOLUME to force use of class volume levels.

Constructor Detail

Tone

public Tone(int resourceID,
            boolean preload,
            boolean loop,
            int pri,
            int volume,
            int filters,
            int klass,
            int route,
            java.lang.String name,
            java.lang.String group)

Create a Tone with a resource ID

Tone

public Tone(boolean isRtxString,
            java.lang.String s,
            boolean preload,
            boolean loop,
            int pri,
            int volume,
            int filters,
            int klass,
            java.lang.String name,
            java.lang.String group)

If isRtxString is true, then create a Tone with a RTX (Nokia Ringtone) formatted String into a Sequence RTX is backward compatibile with RTTTL. This is a text based format. It looks like: "peanuts:d=4,o=5,b=160:f,8g,a,8a,8g,f,2g,f,p,f,8g,a,1a,2p,f,8g,a,8a,8g,f,2g,2f,2f,8g,1g" If IsRtxString is false, then create a Tone with a Nokia SMS formatted String that is encoded as ascii hex into a Sequence. This format comes from an SMS message right after the 1581h port identifier. It looks like: "024A3A5D19B1B9D1CDD1B804005124650490418A24849B6194124106194 1761661661761961241441621021941241062892126D86504904186505D 85985985D865849051048800" NOTE: This is a String as hex values. If you have binary, you must convert to hex strings prior to calling this function.

Tone

public Tone(boolean isRtxString,
            int id,
            java.lang.String s,
            boolean preload,
            boolean loop,
            int pri,
            int volume,
            int filters,
            int klass,
            java.lang.String name,
            java.lang.String group)

Tone

public Tone(byte[] data,
            int id,
            boolean preload,
            boolean loop,
            int pri,
            int volume,
            int filters,
            int klass,
            java.lang.String name,
            java.lang.String group)

Create a Tone with custom formated byte data. This is a valid formatted file that is one of the following formats: Midi, RMF, WAV, AIF

Method Detail

destroy

public void destroy()

destroy and unload all assoicated data. Must call this. If you don't you'll get memory leaks.

createToneRecordStore

public ToneRecordStore createToneRecordStore()

Convert this Tone into a ToneRecordStore. Can only create a ToneRecordStore from custom data, not system resources

getOrigin

public int getOrigin()

setOrigin

public void setOrigin(int origin)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getGroupName

public java.lang.String getGroupName()

getPlaybackFilter

public int getPlaybackFilter()

getInitialFilter

public int getInitialFilter()

getToneClass

public int getToneClass()

setToneClass

public void setToneClass(int klass)

getRuntimeID

public int getRuntimeID()

getProductID

public java.lang.String getProductID()

return private Product ID

setProductID

public void setProductID(java.lang.String productID)

set private resource ID

getResourceID

public int getResourceID()

return private resource ID

SetResourceID

public void SetResourceID(int id)

set private resource ID

play

public void play(int volume)

play

public void play(int volume,
                 int filter)

load if not loaded, and start playing the tone

setTranspose

public void setTranspose(int transpose)

getTranspose

public int getTranspose()

setTempo

public void setTempo(int tempo)

getTempo

public int getTempo()

setPriority

public void setPriority(int level)

getPriority

public int getPriority()

getDefaultVolume

public int getDefaultVolume()

setDefaultVolume

public void setDefaultVolume(int volume)

setVolume

public void setVolume(int volume)

getVolume

public int getVolume()

getDefaultLoop

public boolean getDefaultLoop()

getLoop

public boolean getLoop()

setRoute

public void setRoute(int route)

getRoute

public int getRoute()

setLoop

public void setLoop(boolean on)

isDone

public boolean isDone()

hasSound

public boolean hasSound()

return object sound/buzz/flash status

hasBuzzer

public boolean hasBuzzer()

hasFlasher

public boolean hasFlasher()

stop

public void stop()

isLoaded

public boolean isLoaded()

load

public void load(boolean autoDelete)

displayState

public void displayState()