TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iSoundData Struct Referenceabstract
Inheritance diagram for iSoundData:
iUnknown

Detailed Description

Sound data interface.

Public Member Functions

virtual iSoundDataClone () const =0
 Clone the sound data. More...
 
virtual eSoundFormat GetFormat () const =0
 Get the sound's format bits. {Property}. More...
 
virtual tU32 GetFrequency () const =0
 Get the sound frequency in hertz. {Property}. More...
 
virtual tI32 ReadRaw (tPtr apOut, tU32 anSize)=0
 Read a chunk of the specified size. More...
 
virtual void Reset ()=0
 Reset data stream to the begining. More...
 
virtual tU32 GetLength () const =0
 Get the sound length in frames. {Property}. More...
 
- Public Member Functions inherited from iUnknown
virtual tBool IsOK () const =0
 Check if the object is valid. More...
 
virtual tI32 AddRef ()=0
 Signal that one more reference of the object has been created. More...
 
virtual tI32 Release ()=0
 Release a reference of the object. More...
 
virtual void DeleteThis ()=0
 Bypass any reference counting and delete this object. More...
 
virtual void Invalidate ()=0
 Invalidate the object. More...
 
virtual iUnknownQueryInterface (const tUUID &aIID)=0
 Query an interface. More...
 
virtual void ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
 Fill a UUID list containing the UUIDs of the implemented interfaces. More...
 
virtual tI32 SetNumRefs (tI32 anNumRefs)=0
 Set the reference counter directly. More...
 
virtual tI32 GetNumRefs () const =0
 Get the number of references to this object. More...
 

Member Function Documentation

virtual iSoundData* Clone ( ) const
pure virtual

Clone the sound data.

Remarks
This is necessary for streaming as streamed data need separate read pointers.
virtual eSoundFormat GetFormat ( ) const
pure virtual

Get the sound's format bits. {Property}.

virtual tU32 GetFrequency ( ) const
pure virtual

Get the sound frequency in hertz. {Property}.

virtual tI32 ReadRaw ( tPtr  apOut,
tU32  anSize 
)
pure virtual

Read a chunk of the specified size.

Parameters
aptrOutis the buffer where to output the data.
anSizeis the number of bytes to read.
Returns
The number of bytes read and a negative value on error.
virtual void Reset ( )
pure virtual

Reset data stream to the begining.

virtual tU32 GetLength ( ) const
pure virtual

Get the sound length in frames. {Property}.