public interface AudioDevice
A Java3D application running on a particular machine could have one of several options available to it for playing the audio image created by the sound renderer. Perhaps the machine Java3D is executing on has more than one sound card (e.g., one that is a Wave Table Synthesis card and the other with accelerated sound spatialization hardware). Furthermore, suppose there are Java3D audio device drivers that execute Java3D audio methods on each of these specific cards. In such a case the application would have at least two audio device drivers through which the audio could be produced. For such a case the Java3D application must choose the audio device driver with which sound rendering is to be performed. Once this audio device is chosen, the application can additionally select the type of audio playback type the rendered sound image is to be output on. The playback device (headphones or speaker(s)) is physically connected to the port the selected device driver outputs to.
AudioDevice Interface
The AudioDevice object interface specifies an abstract input device that creators of Java3D class libraries would implement for a particular device. Java3D's uses several methods to interact with specific devices. Since all audio devices implement this consistent interface, the user could have a portable means of initialize, set particular audio device elements and query generic characteristics for any audio device.
Initialization
Audio Playback Type
Distance to Speaker
Angular Offset of Speakers
Device Driver Specific Data
Instantiating and Registering a New Device
The API for instantiating devices is site-specific, but it consists of a device object with a constructor and at least all of the methods specified in the AudioDevice interface.
Once instantiated, the browser or application must register the device with the Java3D sound scheduler by associating this device with a PhysicalEnvironment. The setAudioDevice method introduces new devices to the Java3D environment and the allAudioDevices method produces an enumeration that allows examining all available devices within a Java3D environment. See PhysicalEnvironment class for more details.
General Rules for calling AudioDevice methods: It is illegal for an application to call any non-query AudioDevice method if the AudioDevice is created then explicitly assigned to a PhysicalEnvironment using PhysicalEnvironment.setAudioDevice(); When either PhysicalEnvironment.setAudioDevice() is called - including when implicitly called by SimpleUniverse.getViewer().createAudioDevice() - the Core creates a SoundScheduler thread which makes calls to the AudioDevice.
If an application creates it's own instance of an AudioDevice and initializes it directly, rather than using PhysicalEnvironment. setAudioDevice(), that application may make any AudioDevice3D methods calls without fear of the Java 3D Core also trying to control the AudioDevice. Under this condition it is safe to call AudioDevice non-query methods.
Modifier and Type | Field and Description |
---|---|
static int |
HEADPHONES
Choosing Headphones as the audio playback type
specifies that the audio playback will be through stereo headphones.
|
static int |
MONO_SPEAKER
Choosing a
single near-field monoaural speaker
as the audio playback type
specifies that the audio playback will be through a single speaker
some supplied distance away from the listener.
|
static int |
STEREO_SPEAKERS
Choosing a
two near-field stereo speakers
as the audio playback type
specifies that the audio playback will be through stereo speakers
some supplied distance away from, and at some given angle to
the listener.
|
Modifier and Type | Method and Description |
---|---|
boolean |
close()
Code to close the device and release resources.
|
float |
getAngleOffsetToSpeaker()
Get Angle Offset (in radians) To Speaker.
|
int |
getAudioPlaybackType()
Get Type of Audio Playback Output Device.
|
float |
getCenterEarToSpeaker()
Get Distance from interaural mid-point between Ears to a Speaker.
|
int |
getChannelsAvailable()
Query number of channels currently available for use.
|
int |
getChannelsUsedForSound(Sound node)
Query number of channels that are used, or would be used to render
a particular sound node.
|
int |
getTotalChannels()
Query total number of channels available for sound rendering
for this audio device.
|
boolean |
initialize()
Initialize the audio device.
|
void |
setAngleOffsetToSpeaker(float angle)
Set Angle Offset (in radians) To Speaker.
|
void |
setAudioPlaybackType(int type)
Set Type of Audio Playback physical transducer(s) sound is output to.
|
void |
setCenterEarToSpeaker(float distance)
Set Distance from interaural mid-point between Ears to a Speaker.
|
static final int HEADPHONES
static final int MONO_SPEAKER
static final int STEREO_SPEAKERS
boolean initialize()
boolean close()
void setAudioPlaybackType(int type)
type
- audio playback typeint getAudioPlaybackType()
void setCenterEarToSpeaker(float distance)
distance
- from interaural midpoint between the ears to closest speakerfloat getCenterEarToSpeaker()
void setAngleOffsetToSpeaker(float angle)
angle
- in radians from head Z axis and vector from center ear to speakerfloat getAngleOffsetToSpeaker()
int getTotalChannels()
int getChannelsAvailable()
int getChannelsUsedForSound(Sound node)
Copyright © 2016–2022 SciJava. All rights reserved.