openscenegraph
Public Types | Public Member Functions | List of all members
osg::AudioStream Class Referenceabstract
Inheritance diagram for osg::AudioStream:
osg::Object osg::Referenced

Public Types

enum  SampleFormat {
  SAMPLE_FORMAT_U8, SAMPLE_FORMAT_S16, SAMPLE_FORMAT_S24, SAMPLE_FORMAT_S32,
  SAMPLE_FORMAT_F32
}
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 AudioStream ()
 
 AudioStream (const AudioStream &audio, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual void setAudioSink (osg::AudioSink *audio_sink)=0
 
virtual void consumeAudioBuffer (void *const buffer, const size_t size)=0
 
virtual int audioFrequency () const =0
 
virtual int audioNbChannels () const =0
 
virtual SampleFormat audioSampleFormat () const =0
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 

Detailed Description

Pure virtual AudioStream base class. Subclasses provide mechanism for reading/generating audio data

Member Enumeration Documentation

Enumerator:
SAMPLE_FORMAT_U8 
SAMPLE_FORMAT_S16 
SAMPLE_FORMAT_S24 
SAMPLE_FORMAT_S32 
SAMPLE_FORMAT_F32 

Constructor & Destructor Documentation

osg::AudioStream::AudioStream ( )
osg::AudioStream::AudioStream ( const AudioStream audio,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

Member Function Documentation

virtual int osg::AudioStream::audioFrequency ( ) const
pure virtual
virtual int osg::AudioStream::audioNbChannels ( ) const
pure virtual
virtual SampleFormat osg::AudioStream::audioSampleFormat ( ) const
pure virtual
virtual const char* osg::AudioStream::className ( ) const
inlinevirtual

return the name of the object's class type. Must be defined by derived classes.

Implements osg::Object.

virtual void osg::AudioStream::consumeAudioBuffer ( void *const  buffer,
const size_t  size 
)
pure virtual
virtual bool osg::AudioStream::isSameKindAs ( const Object obj) const
inlinevirtual

Reimplemented from osg::Object.

virtual const char* osg::AudioStream::libraryName ( ) const
inlinevirtual

return the name of the object's library. Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

virtual void osg::AudioStream::setAudioSink ( osg::AudioSink audio_sink)
pure virtual

The documentation for this class was generated from the following file: