Interface spatialAudio.Listener 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface spatialAudio.Listener

public interface Listener
extends Object
The Listener interface provides methods for controlling the position and orientation of a Listener in 3D space. The DirectListener interface provides additional methods for handling the audio device; the StreamingListener interface provides methods for handling buffers.

Use the Environment.createListener() method to create a Listener. An Environment can support exactly one Listener.

Copyright (c) 1996 Intel Corporation

See Also:
Environment, DirectListener, StreamingListener

METHOD INDEX

O getInfo()
Retrieves the info value set by the application.
O getOrientation()
Retrieves a "two vector" description of the Listener's orientation in 3D space.
O getPosition()
Retrieves the X,Y,Z coordinates of the Listener's position.
O move(float, float, float)
Moves the position of the Listener by the X,Y,Z offsets provided.
O move(Vector3D)
Moves the position of the Listener by the X,Y,Z offsets provided.
O release()
Requests that any resources associated with the Listener object be freed.
O setInfo(Object)
Sets the info value for the Listener.
O setOrientation(float, float, float, float, float, float)
Uses a "two vector" description to set the Listener's orientation in 3D space.
O setOrientation(Orientation6D)
Uses a "two vector" description to set the Listener's orientation in 3D space.
O setOrientation(Vector3D, Vector3D)
Uses a two 3D vectors to set the Listener's orientation in 3D space.
O setPosition(float, float, float)
Sets the X,Y,Z coordinates of the Listener's position.
O setPosition(Vector3D)
Sets the X,Y,Z coordinates of the Listener's position.

METHODS

O getOrientation 
  public abstract Orientation6D getOrientation() throws SpatialAudioException
Retrieves a "two vector" description of the Listener's orientation in 3D space.
Returns:
An instance of the Orientation6D class. If the call fails, a SpatialAudioException is thrown.
O setOrientation 
  public abstract boolean setOrientation(Orientation6D orientation)
Uses a "two vector" description to set the Listener's orientation in 3D space.
Parameters:
orientation - The orientation of the listener in 3D space.
Returns:
true if the call succeeded, or false if it failed.
O setOrientation 
  public abstract boolean setOrientation(Vector3D forward,
                                         Vector3D up)
Uses a two 3D vectors to set the Listener's orientation in 3D space.
Parameters:
forward - The "forward" direction of the Listener in 3D space.
up - The "up" direction of the Listener in 3D space.
Returns:
true if the call succeeded, or false if it failed.
O setOrientation 
  public abstract boolean setOrientation(float forwardX,
                                         float forwardY,
                                         float forwardZ,
                                         float upX,
                                         float upY,
                                         float upZ)
Uses a "two vector" description to set the Listener's orientation in 3D space.
Parameters:
forwardX - The X component of the "forward" direction of the Listener in 3D space.
forwardY - The Y component of the "forward" direction of the Listener in 3D space.
forwardZ - The Z component of the "forward" direction of the Listener in 3D space.
upX - The X component of the "up direction of the Listener in 3D space.
upY - The Y component of the "up" direction of the Listener in 3D space.
upZ The - Z component of the "up" direction of the Listener in 3D space.
Returns:
true if the call succeeded, or false if it failed.
O getPosition 
  public abstract Vector3D getPosition() throws SpatialAudioException
Retrieves the X,Y,Z coordinates of the Listener's position.
Returns:
An instance of the Vector3D class containing the coordinates of the Listener's position. If the call fails, a SpatialAudioException is thrown.
O setPosition 
  public abstract boolean setPosition(Vector3D position)
Sets the X,Y,Z coordinates of the Listener's position.
Parameters:
position - Position of the Listener in 3D space.
Returns:
true if the call succeeded, or false if it failed.
O setPosition 
  public abstract boolean setPosition(float x,
                                      float y,
                                      float z)
Sets the X,Y,Z coordinates of the Listener's position.
Parameters:
x - X coordinate of the Listener.
y - Y coordinate of the Listener.
z - Z coordinate of the Listener.
Returns:
true if the call succeeded, or false if it failed.
O move 
  public abstract boolean move(Vector3D distance)
Moves the position of the Listener by the X,Y,Z offsets provided.
Parameters:
position - A 3D vector containing the requested X, Y, and Z position changes of the Listener.
Returns:
true if the call succeeded, or false if it failed.
O move 
  public abstract boolean move(float x,
                               float y,
                               float z)
Moves the position of the Listener by the X,Y,Z offsets provided.
Parameters:
position - The requested X, Y, and Z position changes of the Listener.
Returns:
true if the call succeeded, or false if it failed.
O setInfo 
  public abstract void setInfo(Object info)
Sets the info value for the Listener.
Parameters:
The - info value set by the application.
O getInfo 
  public abstract Object getInfo()
Retrieves the info value set by the application.
Returns:
The info value set by the application. Returns null if the call fails, or if the info value has not been set.
O release 
  public abstract void release()
Requests that any resources associated with the Listener object be freed. The object may or may not continue to exist, but application must not attempt to use it after release() has been called. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Free Web Hosting