lss::IStreamingSoundSourceStreamer Class Reference

An interface for the retrieval of sound data for use by the CStreamingSoundSource class. More...

#include <LSSStreamingSoundSourceStreamer.h>

Inheritance diagram for lss::IStreamingSoundSourceStreamer:

List of all members.

Public Member Functions
virtual LSBOOL LSE_CALL	GetData (LSUINT64 _ui64From, LSUINT64 &_ui64Length, LSUINT8 *&_pui8Data, CAllocator *_paAllocator) const =0
virtual LSUINT32 LSE_CALL	GetType () const =0
virtual const LSCHAR *LSE_CALL	GetName () const =0
virtual LSUINT32 LSE_CALL	GetFrequency () const =0
virtual LSUINT32 LSE_CALL	GetBits () const =0
virtual LSUINT32 LSE_CALL	GetChannels () const =0
virtual LSUINT64 LSE_CALL	GetAudioLength () const =0
LSVOID LSE_CALL	IncRef () const
LSVOID LSE_CALL	DecRef () const
LSUINT32 LSE_CALL	GetRef () const
Protected Attributes
LSUINT32	m_ui32RefCount

---

Detailed Description

An interface for the retrieval of sound data for use by the CStreamingSoundSource class.

Class IStreamingSoundSourceStreamer Description: A streaming sound source needs an abstract way to stream data from a source (file/memory/ network/etc.) This class provides an interface for the retrieval of sound data for use by the CStreamingSoundSource class.

---

Member Function Documentation

LSVOID LSE_CALL lss::IStreamingSoundSourceStreamer::DecRef

(

)

const

Decrease the reference count.

virtual LSUINT64 LSE_CALL lss::IStreamingSoundSourceStreamer::GetAudioLength

(

)

const [pure virtual]

Get the length of the data in microseconds.

Returns:

Returns the length, in microseconds, of the audio provided by this class.

Implemented in lss::CWaveStreamingSoundSourceStreamer.

virtual LSUINT32 LSE_CALL lss::IStreamingSoundSourceStreamer::GetBits

(

)

const [pure virtual]

Get the number of bits per channel of the data.

Returns:

Returns the number of bits per channel of the data provided by this class.

Implemented in lss::CWaveStreamingSoundSourceStreamer.

virtual LSUINT32 LSE_CALL lss::IStreamingSoundSourceStreamer::GetChannels

(

)

const [pure virtual]

Get the number of channels of the data.

Returns:

Returns the number of channels of the data provided by this class.

Implemented in lss::CWaveStreamingSoundSourceStreamer.

virtual LSBOOL LSE_CALL lss::IStreamingSoundSourceStreamer::GetData	(	LSUINT64	_ui64From,
		LSUINT64 &	_ui64Length,
		LSUINT8 *&	_pui8Data,
		CAllocator *	_paAllocator
	)		const [pure virtual]

Retrieve sound data for use by the CStreamingSoundSource class.

Parameters:

_ui64From	The offset within the data source to get the data, in microseconds.
_ui64Length	The length of the data to get, in microseconds. If the function succeeds, this holds the returned length of the data in bytes.
_pui8Data	The returned data.
_paAllocator	The allocator to be used to allocate the data to which _pui8Data will point on a successful return.

Returns:

Returns true if successful, false otherwise.

Implemented in lss::CWaveStreamingSoundSourceStreamer.

virtual LSUINT32 LSE_CALL lss::IStreamingSoundSourceStreamer::GetFrequency

(

)

const [pure virtual]

Get the frequency of the data.

Returns:

Returns the frequency of the data provided by this class.

Implemented in lss::CWaveStreamingSoundSourceStreamer.

virtual const LSCHAR* LSE_CALL lss::IStreamingSoundSourceStreamer::GetName

(

)

const [pure virtual]

Get the name of the streamer. This must uniquely identify the streamer.

Returns:

Returns a constant LSCHAR * to the name of the streamer.

Implemented in lss::CWaveStreamingSoundSourceStreamer.

LSUINT32 LSE_CALL lss::IStreamingSoundSourceStreamer::GetRef

(

)

const

Get the reference count.

Returns:

Returns the reference count on this object.

virtual LSUINT32 LSE_CALL lss::IStreamingSoundSourceStreamer::GetType

(

)

const [pure virtual]

Get the type of this streamer. The sound engine defines only this interface. which is of type LSS_DSS_BASE.

Returns:

Returns the bitmask representing the type of streamer this instance is.

Implemented in lss::CWaveStreamingSoundSourceStreamer.

LSVOID LSE_CALL lss::IStreamingSoundSourceStreamer::IncRef

(

)

const

Increase the reference count.

---

Member Data Documentation

LSUINT32 lss::IStreamingSoundSourceStreamer::m_ui32RefCount [mutable, protected]

The reference count on this object.

---

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

• F:/My Projects/LSEngine/Modules/LSSoundLib/Src/SoundComponents/LSSStreamingSoundSourceStreamer.h