Main Page · Modules · All Classes · Class Hierarchy
Public Member Functions | List of all members
MASoundFile Class Reference

Sound file. More...

#include <MASoundFile.hpp>

Inheritance diagram for MASoundFile:
MASoundBase

Public Member Functions

virtual int GetSize () const
 Get the sound data size. More...
 
virtual bool IsValid () const
 Check if the sound data is valid. More...
 
virtual bool IsCached () const
 Check if the sound data is cached. More...
 
virtual void AddToBuffer (int position, int count, int32_t *buffer)
 Add sound data to a buffer. More...
 
- Public Member Functions inherited from MASoundBase
 MASoundBase (const std::string &display_name)
 Class constructor. More...
 
std::string GetDisplayName () const
 Get the display name. More...
 
bool IsEffect () const
 Check if the sound is an effect. More...
 

Detailed Description

Sound file.

Definition at line 37 of file MASoundFile.hpp.

Member Function Documentation

void MASoundFile::AddToBuffer ( int  position,
int  count,
int32_t *  buffer 
)
virtual

Add sound data to a buffer.

Parameters
positionPosition in buffer
countCount to be copied
bufferTarget buffer

Implements MASoundBase.

Definition at line 63 of file MASoundFile.cpp.

int MASoundFile::GetSize ( ) const
virtual

Get the sound data size.

Returns
Sound data size

Implements MASoundBase.

Definition at line 45 of file MASoundFile.cpp.

bool MASoundFile::IsCached ( ) const
virtual

Check if the sound data is cached.

Returns
True if cached otherwise false.

Implements MASoundBase.

Definition at line 57 of file MASoundFile.cpp.

bool MASoundFile::IsValid ( ) const
virtual

Check if the sound data is valid.

Returns
True if valid otherwise false.

Implements MASoundBase.

Definition at line 51 of file MASoundFile.cpp.


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