amber.server.component
Class AudioHandler

java.lang.Object
  |
  +--java.awt.Component
        |
        +--amber.server.component.ComponentHandler
              |
              +--amber.server.component.AudioHandler

All Implemented Interfaces:

ApplicationInterface, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable

public class AudioHandler

extends ComponentHandler

implements java.io.Serializable

This class handles the requirements for the manipulation of the packets moving to and from an Audio player component. It is designed to play audio sound tracks by requesting the audio URL as defined by the command packet. Sound file types which work are:
Sampling rates of 8192 Hz and 16384 Hz
SUN Sparc .AU file format
Coding: u-Law, A-Law, ADPCM, IMA ADPCM (also called DVI ADPCM), GSM
Single Channel (Mono)
Data encoding: bytes, 16-bit words, 32-bit longwords, 32-bit floats, 64-bit double floats, or 80-bit IEEE floats.

The remote client class also responds to information stored in the parameters field of the XYConstraints object when this handler is added to a panel. The allowed parameters are separated in the string by '|' characters. Any unused trailing parameters are optional and will assume default values, however the parameter order is fixed.

For example, if the component takes 4 parameters which are ints, a valid parameter string would be:

"1|2|3"

In this case the fourth parameter would assume the default value.

The parameter elements for this component are:

Component Parameters

Name	Type	Description	Repeats	Default

Version:

1.0.0

Author:

Dr. David J. Knowles

See Also:

ApplicationInterface, ComponentHandler, XYConstraints, Serialized Form

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Field Summary

static byte	GetAudioClipName
static byte	GetAudioClipNameResponse
static byte	LoopAudioClip
static byte	PlayAudioClip
static byte	SetAudioClipName
static byte	StopAudioClip

Fields inherited from class amber.server.component.ComponentHandler

actionCommand, active, ApplicationId, CancelReturn, dataEncoder, DefaultTimeout, enabledState, encoderBytes, id, InvalidId, MaximumId, NoReturn, OkCancelType, OkReturn, OkType, OkYesReturn, parentPage, responsePackets, timeoutValue, UnchangeableInvalidId, visibleState, YesNoCancelType, YesNoType, YesReturn

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

AudioHandler()
Default constructor.

AudioHandler(ApplicationInterface pageHandler)
The initialising constructor.

AudioHandler(int id, ApplicationInterface pageHandler)
The initialising constructor.

Method Summary

java.lang.String	getAudioClipName() Get the name of the current Audio Clip.
java.lang.String	getPanelType() This function returns the panel component to use with this class.
void	loadAudioClip(java.lang.String audioClipName) This function instructs the remote audio component to load an audio clip.
void	loopAudioClip(java.lang.String audioClipName) Similar to playAudioClip this function instructs the remote audio component to commence playing an audio clip.
void	playAudioClip(java.lang.String audioClipName) This function instructs the remote audio component to commence playing an audio clip.
void	stopAudioClip() This function instructs the remote component to stop playing the audio clip.

Methods inherited from class amber.server.component.ComponentHandler

addActionListener, addComponentListener, addEventMask, addFocusListener, addItemListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addReceivedPacket, addTextListener, addWindowListener, booleanToInt, createDataInput, directPacket, displayMessageBox, fireWindowActivated, fireWindowClosed, fireWindowClosing, fireWindowDeactivated, fireWindowDeiconified, fireWindowEvent, fireWindowIconified, fireWindowOpened, forceComponentGetUrl, forceComponentGetUrl, forwardEventPacket, generateActionEvent, generateFocusEvent, generateItemEvent, generateKeyEvent, generateMouseEvent, getActionCommand, getBounds, getComponentStructure, getDefaultParameters, getEventMask, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontStyle, getId, getLocation, getLog, getModalObject, getParentApplication, getParentContainer, getParentServer, getResponsePacket, getSelectedObjects, getSize, getTimeout, getValidId, getX, getY, handleMessages, handlePacket, internalForwardPacket, internalGetBounds, intToBoolean, isActive, isApplicationActive, isComponentModal, isConnected, isEnabled, isMyId, isVisible, processActionEvent, processComponentEvent, processCurrentPacket, processEvent, processFocusEvent, processItemEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processNormalResponse, processTextEvent, queryMessageBox, removeActionListener, removeComponentListener, removeEventMask, removeFocusListener, removeItemListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removeTextListener, removeWindowListener, requestFocus, resetState, restart, sendPacket, sendPacketAndBlock, sendPendingPackets, setActionCommand, setActive, setBackground, setComponentModal, setConnectedState, setCursor, setEnabled, setEventMask, setFont, setFont, setFontStyle, setForeground, setForegroundBackground, setId, setLog, setModalObject, setParentApplication, setParentContainer, setParentServer, setTimeout, setVisible, setX, setY, shutDown, shutDownClient, shutDownClient, start

Methods inherited from class java.awt.Component

action, add, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getListeners, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, remove, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

SetAudioClipName

public static final byte SetAudioClipName

PlayAudioClip

public static final byte PlayAudioClip

LoopAudioClip

public static final byte LoopAudioClip

StopAudioClip

public static final byte StopAudioClip

GetAudioClipName

public static final byte GetAudioClipName

GetAudioClipNameResponse

public static final byte GetAudioClipNameResponse

Constructor Detail

AudioHandler

public AudioHandler()

Default constructor.

AudioHandler

public AudioHandler(ApplicationInterface pageHandler)

The initialising constructor. This constructor dynamically requests a valid ID value from the ApplicationInterface.

Parameters:

pageHandler - The handle to the main ApplicationInterface which handles the functions of page overall. residing on the browser.

AudioHandler

public AudioHandler(int id,
                    ApplicationInterface pageHandler)

The initialising constructor.

Parameters:

id - The int containing the id of the corresponding remote component residing on the browser.

pageHandler - The handle to the main ApplicationInterface which handles the functions of page overall.

Method Detail

loadAudioClip

public void loadAudioClip(java.lang.String audioClipName)
                   throws ComponentHandlerException

This function instructs the remote audio component to load an audio clip. NOTE this function does not tell the component to start playing.

Parameters:

audioClipName - String containing the URL of the audio clip to play.

Throws:

ComponentHandlerException - containing the error information.

playAudioClip

public void playAudioClip(java.lang.String audioClipName)
                   throws ComponentHandlerException

This function instructs the remote audio component to commence playing an audio clip.

Parameters:

audioClipName - String containing the URL of the audio clip to play. If the string is empty or null a command to play the currently resident audio clip will be sent.

Throws:

ComponentHandlerException - containing the error information.

loopAudioClip

public void loopAudioClip(java.lang.String audioClipName)
                   throws ComponentHandlerException

Similar to playAudioClip this function instructs the remote audio component to commence playing an audio clip. Unlike playAudioClip this function instructs the remote component to loop endlessly.

Parameters:

audioClipName - String containing the URL of the audio clip to play. If the string is empty or null a command to play the currently resident audio clip will be sent.

Throws:

ComponentHandlerException - containing the error information.

stopAudioClip

public void stopAudioClip()
                   throws ComponentHandlerException

This function instructs the remote component to stop playing the audio clip.

Throws:

ComponentHandlerException - containing the error information.

getAudioClipName

public java.lang.String getAudioClipName()
                                  throws ComponentHandlerException

Get the name of the current Audio Clip.

Returns:

String containing the name of the clip or null.

Throws:

ComponentHandlerException - containing the error information.

getPanelType

public java.lang.String getPanelType()

This function returns the panel component to use with this class.

Overrides:

getPanelType in class ComponentHandler

Returns:

String containing the panel type to use.