---

CL_VorbisStream Class Reference

#include <vorbis_soundprovider_generic.h>

Inheritance diagram for CL_VorbisStream:

[legend]Collaboration diagram for CL_VorbisStream:

[legend]List of all members.

Public Methods
	CL_VorbisStream (CL_InputSource *input)
virtual	~CL_VorbisStream ()
virtual bool	eof () const
virtual void	stop ()
	retval: True if end of input data. False otherwise.
virtual bool	play ()
virtual bool	set_position (int pos)
	retval: True for success. False otherwise.
virtual int	get_data (void *data_ptr, int data_requested)
	param: pos - Position to seek to.retval: True for success. False otherwise.
virtual int	get_frequency () const
	param: data_ptr - Points to a buffer that should be filled withparam: sample data.param: data_requested - Bytes of data requested.retval: Number of bytes actually filled with sample data.
virtual SoundFormat	get_format () const
	retval: Playback frequency.
Private Methods
void	init ()
void	deinit ()
void	stream_data ()
Private Attributes
bool	inited
CL_InputSource*	input
bool	stream_eof
ogg_sync_state	oy
ogg_stream_state	os
ogg_page	og
ogg_packet	op
vorbis_info	vi
vorbis_comment	vc
vorbis_dsp_state	vd
vorbis_block	vb

---

Constructor & Destructor Documentation

CL_VorbisStream::CL_VorbisStream ( CL_InputSource * input )

virtual CL_VorbisStream::~CL_VorbisStream ( ) [virtual]

---

Member Function Documentation

void CL_VorbisStream::deinit ( ) [private]

virtual bool CL_VorbisStream::eof ( ) const [virtual]

Reimplemented from CL_StreamSoundProvider_Session.

virtual int CL_VorbisStream::get_data ( void * data_ptr, int data_requested ) [virtual]

param: pos - Position to seek to.retval: True for success. False otherwise. Reimplemented from CL_StreamSoundProvider_Session.

virtual SoundFormat CL_VorbisStream::get_format ( ) const [virtual]

retval: Playback frequency. Reimplemented from CL_StreamSoundProvider_Session.

virtual int CL_VorbisStream::get_frequency ( ) const [virtual]

param: data_ptr - Points to a buffer that should be filled withparam: sample data.param: data_requested - Bytes of data requested.retval: Number of bytes actually filled with sample data. Reimplemented from CL_StreamSoundProvider_Session.

void CL_VorbisStream::init ( ) [private]

virtual bool CL_VorbisStream::play ( ) [virtual]

Reimplemented from CL_StreamSoundProvider_Session.

virtual bool CL_VorbisStream::set_position ( int pos ) [virtual]

retval: True for success. False otherwise. Reimplemented from CL_StreamSoundProvider_Session.

virtual void CL_VorbisStream::stop ( ) [virtual]

retval: True if end of input data. False otherwise. Reimplemented from CL_StreamSoundProvider_Session.

void CL_VorbisStream::stream_data ( ) [private]

---

Member Data Documentation

bool CL_VorbisStream::inited [private]

Definition at line 50 of file vorbis_soundprovider_generic.h.

CL_InputSource* CL_VorbisStream::input [private]

Definition at line 51 of file vorbis_soundprovider_generic.h.

ogg_page CL_VorbisStream::og [private]

Definition at line 57 of file vorbis_soundprovider_generic.h.

ogg_packet CL_VorbisStream::op [private]

Definition at line 58 of file vorbis_soundprovider_generic.h.

ogg_stream_state CL_VorbisStream::os [private]

Definition at line 55 of file vorbis_soundprovider_generic.h.

ogg_sync_state CL_VorbisStream::oy [private]

Definition at line 54 of file vorbis_soundprovider_generic.h.

bool CL_VorbisStream::stream_eof [private]

Definition at line 52 of file vorbis_soundprovider_generic.h.

vorbis_block CL_VorbisStream::vb [private]

Definition at line 64 of file vorbis_soundprovider_generic.h.

vorbis_comment CL_VorbisStream::vc [private]

Definition at line 62 of file vorbis_soundprovider_generic.h.

vorbis_dsp_state CL_VorbisStream::vd [private]

Definition at line 63 of file vorbis_soundprovider_generic.h.

vorbis_info CL_VorbisStream::vi [private]

Definition at line 60 of file vorbis_soundprovider_generic.h.

---

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

• vorbis_soundprovider_generic.h

---