soaudiodevice(3) [debian man page]
SoAudioDevice(3) Coin SoAudioDevice(3) NAME
SoAudioDevice - The SoAudioDevice class is used to control an audio device. The SoAudioDevice class is responsible for initialization of an audio device, as well as enabling and disabling sound. It is a singleton class. SYNOPSIS
#include <Inventor/misc/SoAudioDevice.h> Public Member Functions SbBool init (const SbString &devicetype, const SbString &devicename) SbBool enable () void disable () SbBool isEnabled () SbBool haveSound () void setGain (float gain) void mute (SbBool mute=TRUE) Static Public Member Functions static SoAudioDevice * instance () Detailed Description The SoAudioDevice class is used to control an audio device. The SoAudioDevice class is responsible for initialization of an audio device, as well as enabling and disabling sound. It is a singleton class. The application programmer does not need to use this class directly, as audio support is enabled by default, and the default settings are reasonable. Coin uses OpenAL (http://www.openal.org/, http://developer.soundblaster.com [Games section]) to render audio. OpenAL should work with any soundcard, and on most modern operating systems (including Unix, Linux, IRIX, *BSD, Mac OS X and Microsoft Windows). 2 speaker output is always available, and on some OS and soundcard combinations, more advanced speaker configurations are supported. On Microsoft Windows, OpenAL can use DirectSound3D to render audio, thus supporting any speaker configuration the current DirectSound3D driver supports. Configuring speakers are done through the soundcard driver, and is transparent to both Coin and OpenAL. Member Function Documentation SoAudioDevice * SoAudioDevice::instance () [static] Returns a pointer to the SoAudioDevice class, which is a singleton. SbBool SoAudioDevice::init (const SbString &devicetype, const SbString &devicename) Initializes the audio device. Currently, the only supported devicetype is 'OpenAL'. The supported devicename depends on the OS and on installed soundcards and drivers. On Microsoft Windows, supported device names are 'DirectSound3D', 'DirectSound', and 'MMSYSTEM'. See OpenAL documentation (available from http://www.openal.org/) for further information. The application programmer may override the default setting by calling this method with the wanted device type and name. The user can also control which devicename OpenAL uses by setting the COIN_SOUND_DRIVER_NAME environment variable. On Microsoft Windows, the default driver name is 'DirectSound3D', which should normally be what the user wants. SbBool SoAudioDevice::enable () Enables sound void SoAudioDevice::disable () Disables sound. Effectively silencing all audio output. SbBool SoAudioDevice::isEnabled (void) Returns TRUE if audio is enabled. SbBool SoAudioDevice::haveSound () returns true if the audio device has been initialized successfully. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoAudioDevice(3)
Check Out this Related Man Page
SoListenerOrientationElement(3) Coin SoListenerOrientationElement(3) NAME
SoListenerOrientationElement - The SoListenerOrientationElement holds the orientation of the current listener. This orientation is set by SoListener nodes and SoCamera Nodes during audio rendering. When a SoListener is visited by the SoAudioRenderAction, it will add a new SoListenerOrientationElement to the state, holding it's orientation and with the setbylistener flag set. When a SoCamera is visited by SoAudioRenderAction, it will add a new SoListenerOrientationElement only if there are no previous elements with the setbylistener flag set. SYNOPSIS
#include <Inventor/elements/SoListenerOrientationElement.h> Inherits SoReplacedElement. Public Member Functions virtual void init (SoState *state) virtual void print (FILE *file) const Prints the contents of the element (unimplemented) Static Public Member Functions static SoType getClassTypeId (void) static int getClassStackIndex (void) static void * createInstance (void) static void initClass (void) static void set (SoState *const state, SoNode *const node, const SbRotation &orientation, SbBool setbylistener) static const SbRotation & get (SoState *const state) Returns the current listener orientation. static SbBool isSetByListener (SoState *const state) Protected Member Functions virtual ~SoListenerOrientationElement () Protected Attributes SbRotation orientation SbBool setbylistener Additional Inherited Members Detailed Description The SoListenerOrientationElement holds the orientation of the current listener. This orientation is set by SoListener nodes and SoCamera Nodes during audio rendering. When a SoListener is visited by the SoAudioRenderAction, it will add a new SoListenerOrientationElement to the state, holding it's orientation and with the setbylistener flag set. When a SoCamera is visited by SoAudioRenderAction, it will add a new SoListenerOrientationElement only if there are no previous elements with the setbylistener flag set. The SoListenerOrientationElement is used when the SoVRMLSound nodes render themselves. Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since: Coin 2.0 Constructor &; Destructor Documentation SoListenerOrientationElement::~SoListenerOrientationElement (void) [protected], [virtual] The destructor. Member Function Documentation SoType SoListenerOrientationElement::getClassTypeId (void) [static] This static method returns the class type. Reimplemented from SoReplacedElement. int SoListenerOrientationElement::getClassStackIndex (void) [static] This static method returns the state stack index for the class. Reimplemented from SoReplacedElement. void * SoListenerOrientationElement::createInstance (void) [static] This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. void SoListenerOrientationElement::initClass (void) [static] This static method initializes static data for the SoListenerOrientationElement class. Reimplemented from SoReplacedElement. void SoListenerOrientationElement::init (SoState *state) [virtual] Initializes the element to it's default value. The default value for the orientation is (0.0f, 0.0f, 1.0f, 0.0f) and the default value for the setByListener flag is FALSE. Reimplemented from SoReplacedElement. void SoListenerOrientationElement::set (SoState *conststate, SoNode *constnode, const SbRotation &orientation, SbBoolsetbylistener) [static] Sets the current listener orientation, and indicates if it was set by a SoListener node or a SoCamera node. SbBool SoListenerOrientationElement::isSetByListener (SoState *conststate) [static] Returns TRUE if the orientation was set by a SoListener node, and FALSE if it was set by a SoCamera node Member Data Documentation SoListenerOrientationElement::orientation [protected] The orientation of the listener. Can be set by the SoListener class or the SoCamera class. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoListenerOrientationElement(3)