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
SoSoundElement(3) Coin SoSoundElement(3) NAME
SoSoundElement - The SoSoundElement is used for optimizing audio rendering and for turning off inactive SoVRMLSound nodes. SYNOPSIS
#include <Inventor/elements/SoSoundElement.h> Inherits SoReplacedElement. Public Member Functions virtual void init (SoState *state) virtual void push (SoState *state) virtual void pop (SoState *state, const SoElement *prevTopElement) virtual void print (FILE *file) const Prints contents of element (not implemented) 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, SbBool scenegraphhassoundnode, SbBool soundnodeisplaying, SbBool ispartofactivescenegraph) static SbBool setSceneGraphHasSoundNode (SoState *const state, SoNode *const node, SbBool flag) static SbBool sceneGraphHasSoundNode (SoState *const state) static SbBool setSoundNodeIsPlaying (SoState *const state, SoNode *const node, SbBool flag) static SbBool soundNodeIsPlaying (SoState *const state) static SbBool setIsPartOfActiveSceneGraph (SoState *const state, SoNode *const node, SbBool flag) static SbBool isPartOfActiveSceneGraph (SoState *const state) Protected Member Functions virtual ~SoSoundElement () void setDefaultValues () Protected Attributes SbBool scenegraphhassoundnode SbBool soundnodeisplaying SbBool ispartofactivescenegraph Additional Inherited Members Detailed Description The SoSoundElement is used for optimizing audio rendering and for turning off inactive SoVRMLSound nodes. Since: Coin 2.0 Constructor &; Destructor Documentation SoSoundElement::~SoSoundElement (void) [protected], [virtual] The destructor. Member Function Documentation SoType SoSoundElement::getClassTypeId (void) [static] This static method returns the class type. Reimplemented from SoReplacedElement. int SoSoundElement::getClassStackIndex (void) [static] This static method returns the state stack index for the class. Reimplemented from SoReplacedElement. void * SoSoundElement::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 SoSoundElement::initClass (void) [static] This static method initializes static data for the SoSoundElement class. Reimplemented from SoReplacedElement. void SoSoundElement::init (SoState *state) [virtual] Initializes the element to it's default value. Reimplemented from SoReplacedElement. void SoSoundElement::set (SoState *conststate, SoNode *constnode, SbBoolscenegraphhassoundnode, SbBoolsoundnodeisplaying, SbBoolispartofactivescenegraph) [static] Sets the flags. SbBool SoSoundElement::setSceneGraphHasSoundNode (SoState *conststate, SoNode *constnode, SbBoolflag) [static] Sets the sceneGraphHasSoundNode flag. SbBool SoSoundElement::sceneGraphHasSoundNode (SoState *conststate) [static] The sceneGraphHasSoundNode flag is used to stop the SoAudioRenderAction in SoSeparator and SoVRMLGroup nodes for cases where the sub-graph doesn not contain any SoVRMLSound nodes. Returns the value of the sceneGraphHasSoundNode flag. SbBool SoSoundElement::setSoundNodeIsPlaying (SoState *conststate, SoNode *constnode, SbBoolflag) [static] Sets the soundNodeIsPlaying flag. SbBool SoSoundElement::soundNodeIsPlaying (SoState *conststate) [static] The soundNodeIsPlaying flag is currently unused. Returns the value of the soundNodeIsPlaying flag. SbBool SoSoundElement::setIsPartOfActiveSceneGraph (SoState *conststate, SoNode *constnode, SbBoolflag) [static] Sets the isPartOfActiveSceneGraph flag. SbBool SoSoundElement::isPartOfActiveSceneGraph (SoState *conststate) [static] The isPartOfActiveSceneGraph flag is used to make SoVRMLSound that are below inactive parts of the scenegraph (i.e. below a SoSwitch or SoLOD node) stop playing. Returns the value of the isPartOfActiveSceneGraph flag. void SoSoundElement::push (SoState *state) [virtual] Calls the superclass' push method. Initializes the element to the default values. Uses previous element's isPartOfActiveSceneGraph flag. Reimplemented from SoElement. void SoSoundElement::pop (SoState *state, const SoElement *prevTopElement) [virtual] Calls the superclass' pop method. Reimplemented from SoElement. void SoSoundElement::setDefaultValues () [protected] Initializes the element to the default values. The default values for the sceneGraphHasSoundNode is FALSE. The default value for the isPartOfActiveSceneGraph flag is TRUE. the default value for the soundNodeIsPlaying flag is FALSE. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoSoundElement(3)