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

SoSFBool(3)							       Coin							       SoSFBool(3)

NAME

       SoSFBool -

       The SoSFBool class is a container for an SbBool value.

       This field is used where nodes, engines or other field containers needs to store a boolean on/off or TRUE/FALSE value, like for instance as
       the 'on' field of the SoPointLight, SoSpotLight and SoDirectionalLight node classes.

SYNOPSIS

       #include <Inventor/fields/SoSFBool.h>

       Inherits SoSField.

   Public Member Functions
       virtual SoType getTypeId (void) const
       virtual void copyFrom (const SoField &field)
       const SoSFBool & operator= (const SoSFBool &field)
       virtual SbBool isSame (const SoField &field) const
       SbBool getValue (void) const
       void setValue (SbBool newvalue)
       SbBool operator= (SbBool newvalue)
       int operator== (const SoSFBool &field) const
       int operator!= (const SoSFBool &field) const

   Static Public Member Functions
       static void * createInstance (void)
       static SoType getClassTypeId (void)
       static void initClass (void)

   Protected Attributes
       SbBool value

   Additional Inherited Members
Detailed Description
       The SoSFBool class is a container for an SbBool value.

       This field is used where nodes, engines or other field containers needs to store a boolean on/off or TRUE/FALSE value, like for instance as
       the 'on' field of the SoPointLight, SoSpotLight and SoDirectionalLight node classes.

       See also:
	   SoMFBool

Member Function Documentation
   SoType SoSFBool::getClassTypeId (void) [static]
       Returns a unique type identifier for this field class.

       See also:
	   getTypeId(), SoType

       Reimplemented from SoSField.

   SoType SoSFBool::getTypeId (void) const [virtual]
       Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

       See also:
	   getClassTypeId(), SoType

       Implements SoField.

   void SoSFBool::copyFrom (const SoField &f) [virtual]
       Copy value(s) from f into this field. f must be of the same type as this field.

       Implements SoField.

   SbBool SoSFBool::isSame (const SoField &f) const [virtual]
       Check for equal type and value(s).

       Implements SoField.

   void SoSFBool::initClass (void) [static]
       Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

       Reimplemented from SoSField.

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						       SoSFBool(3)

Linux and UNIX Man Pages

soaudiodevice(3) [debian man page]

Check Out this Related Man Page