sound(3) [debian man page]

3D Sound Support Classes(3)					       Coin					       3D Sound Support Classes(3)

NAME

       3D Sound Support Classes -

   Classes
       class 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. "
   class SoListener
       The SoListener class defines listener attributes used when rendering sound.

       When rendering geometry, one needs to have a camera defining certain attributes related to vieweing. The SoListener plays a similar role
       when it comes to rendering audio. "
   class SoVRMLAudioClip
       The SoVRMLAudioClip class is used to load and store audio data.

       Audio data is loaded using the simage library, so make sure you have built the simage library with support for the audio file formats you
       intend to use (libogg, libvorbis and libvorbisfile for OggVorbis, libsndfile for WAV and several other formats). "
   class SoVRMLSound
       The SoVRMLSound class is used to represent a sound source.

       The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium,
       and is used by permission of the Consortium: "

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

Version 3.1.3							  Wed May 23 2012				       3D Sound Support Classes(3)

SoListenerGainElement(3)					       Coin						  SoListenerGainElement(3)

NAME

       SoListenerGainElement -

       The SoListenerGainElement class stores the SoListener gain during a scene graph traversal.

       This gain is set by SoListener nodes during audio rendering. The SoListenerGainElement is used when the SoVRMLSound nodes render
       themselves.

SYNOPSIS

       #include <Inventor/elements/SoListenerGainElement.h>

       Inherits SoFloatElement.

   Public Member Functions
       virtual void init (SoState *state)

   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 float gain)
       static void set (SoState *const state, const float gain)
       static float get (SoState *const state)

   Protected Member Functions
       virtual ~SoListenerGainElement ()

   Additional Inherited Members
Detailed Description
       The SoListenerGainElement class stores the SoListener gain during a scene graph traversal.

       This gain is set by SoListener nodes during audio rendering. The SoListenerGainElement 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
   SoListenerGainElement::~SoListenerGainElement (void) [protected],  [virtual]
       The destructor.

Member Function Documentation
   SoType SoListenerGainElement::getClassTypeId (void) [static]
       This static method returns the class type.

       Reimplemented from SoFloatElement.

   int SoListenerGainElement::getClassStackIndex (void) [static]
       This static method returns the state stack index for the class.

       Reimplemented from SoFloatElement.

   void * SoListenerGainElement::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 SoListenerGainElement::initClass (void) [static]
       Initialize relevant common data for all instances, like the type system.

       Reimplemented from SoFloatElement.

   void SoListenerGainElement::init (SoState *state) [virtual]
       This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState
       objects.

       Reimplemented from SoFloatElement.

   void SoListenerGainElement::set (SoState *conststate, SoNode *constnode, const floatgain) [static]
       Sets the value of this element.

   void SoListenerGainElement::set (SoState *conststate, const floatgain) [static]
       This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

   float SoListenerGainElement::get (SoState *conststate) [static]
       Returns the element value.

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

Version 3.1.3							  Wed May 23 2012					  SoListenerGainElement(3)