Pure virtual AudioStream base class. More...

Inheritance diagram for osg::AudioStream:

Public Types
enum	SampleFormat { SAMPLE_FORMAT_U8, SAMPLE_FORMAT_S16, SAMPLE_FORMAT_S24, SAMPLE_FORMAT_S32, SAMPLE_FORMAT_F32 }
Public Member Functions
	AudioStream ()
	AudioStream (const AudioStream &audio, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
virtual bool	isSameKindAs (const Object *obj) const
virtual const char *	libraryName () const
	return the name of the object's library.
virtual const char *	className () const
	return the name of the object's class type.
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

Detailed Description

Pure virtual AudioStream base class.

Subclasses provide mechanism for reading/generating audio data

Member Enumeration Documentation

Enumerator:

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.

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 [inline, virtual]

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 [inline, virtual]

Reimplemented from osg::Object.

virtual const char* osg::AudioStream::libraryName ( ) const [inline, virtual]

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: