JoalAudioFactory (JMRI API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jmri.jmrit.audio
Class JoalAudioFactory

Show UML class diagram

java.lang.Object
  jmri.jmrit.audio.AbstractAudioFactory
      jmri.jmrit.audio.JoalAudioFactory

All Implemented Interfaces:: AudioFactory

public class JoalAudioFactory
extends AbstractAudioFactory
extends AbstractAudioFactory

This is the JOAL audio system specific AudioFactory.

The JOAL sound system supports, where available, full surround-sound with 3D positioning capabilities.

When only stereo capable hardware is available, it will automatically create an approximation of the desired sound-scape.

This factory initialises JOAL, provides new Joal-specific Audio objects and deals with clean-up operations.

This software is based on or using the JOAL Library available from http://joal.dev.java.net/

JOAL License:
Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-Redistribution of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistribution in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Sun Microsystems, Inc. or the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission.
This software is provided "AS IS," without a warranty of any kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
You acknowledge that this software is not designed or intended for use in the design, construction, operation or maintenance of any nuclear facility.

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Field Summary
`(package private) static int`	`AL_FORMAT_51CHN16` Definition of 16-bit 5.1 multi-channel audio format.
`(package private) static int`	`AL_FORMAT_51CHN8` Definition of 8-bit 5.1 multi-channel audio format.
`(package private) static int`	`AL_FORMAT_61CHN16` Definition of 16-bit 6.1 multi-channel audio format.
`(package private) static int`	`AL_FORMAT_61CHN8` Definition of 8-bit 6.1 multi-channel audio format.
`(package private) static int`	`AL_FORMAT_71CHN16` Definition of 16-bit 7.1 multi-channel audio format.
`(package private) static int`	`AL_FORMAT_71CHN8` Definition of 8-bit 7.1 multi-channel audio format.
`(package private) static int`	`AL_FORMAT_QUAD16` Definition of 16-bit quad multi-channel audio format.
`(package private) static int`	`AL_FORMAT_QUAD8` Definition of 8-bit quad multi-channel audio format.

Constructor Summary
`JoalAudioFactory()`

Method Summary
`static boolean`	`checkALCError(ALCdevice alcDevice)` Method to check if any error has occurred in the OpenAL sub-system.
`static boolean`	`checkALCError(ALCdevice alcDevice, String msg)` Method to check if any error has occurred in the OpenAL context sub-system.
`static boolean`	`checkALError()` Method to check if any error has occurred in the OpenAL sub-system.
`static boolean`	`checkALError(String msg)` Method to check if any error has occurred in the OpenAL sub-system.
`void`	`cleanup()` Perform any implementation specific clean-up operations.
`AudioBuffer`	`createNewBuffer(String systemName, String userName)` Provide a specific new AudioBuffer object.
`AudioListener`	`createNewListener(String systemName, String userName)` Provide a specific new AudioListener object.
`AudioSource`	`createNewSource(String systemName, String userName)` Provide a specific new AudioSource object.
`AudioListener`	`getActiveAudioListener()` Return the currently active Listener object
`static AL`	`getAL()` Return a reference to the active AL object for use by other Joal objects
`boolean`	`init()` Initialise this JoalAudioFactory and check for multi-channel support.
`void`	`setDistanceAttenuated(boolean attenuated)` Sets if this AudioFactory should attenuate sources based on their distance from the listener Default = true
`String`	`toString()`

Methods inherited from class jmri.jmrit.audio.AbstractAudioFactory
`audioCommandQueue, getCommandThread, isDistanceAttenuated`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

AL_FORMAT_QUAD8

static int AL_FORMAT_QUAD8

Definition of 8-bit quad multi-channel audio format.

These formats are only supported by certain OpenAL implementations and support is determined at runtime.