PWAVFileFormat Class Reference

#include <pwavfile.h>

List of all members.

Public Member Functions
virtual	~PWAVFileFormat ()
virtual unsigned	GetFormat () const=0
virtual PString	GetFormatString () const=0
virtual PString	GetDescription () const=0
virtual void	CreateHeader (PWAV::FMTChunk &header, PBYTEArray &extendedHeader)=0
virtual void	UpdateHeader (PWAV::FMTChunk &, PBYTEArray &)
virtual PBoolean	WriteExtraChunks (PWAVFile &)
virtual PBoolean	ReadExtraChunks (PWAVFile &)
virtual void	OnStart ()
virtual void	OnStop ()
virtual PBoolean	Read (PWAVFile &file, void *buf, PINDEX &len)
virtual PBoolean	Write (PWAVFile &file, const void *buf, PINDEX &len)

---

Detailed Description

abstract factory class for handling WAV files formats

---

Constructor & Destructor Documentation

virtual PWAVFileFormat::~PWAVFileFormat

(

)

[inline, virtual]

---

Member Function Documentation

virtual unsigned PWAVFileFormat::GetFormat

(

)

const [pure virtual]

return a PWAVFile format code

virtual PString PWAVFileFormat::GetFormatString

(

)

const [pure virtual]

return a string that can be used as a media format

virtual PString PWAVFileFormat::GetDescription

(

)

const [pure virtual]

return a string that can be used as a text description

virtual void PWAVFileFormat::CreateHeader	(	PWAV::FMTChunk &	header,
		PBYTEArray &	extendedHeader
	)			[pure virtual]

populate the header with the correct values

virtual void PWAVFileFormat::UpdateHeader	(	PWAV::FMTChunk &	,
		PBYTEArray &
	)			[inline, virtual]

populate the header with the correct values after initial parameters are set

virtual PBoolean PWAVFileFormat::WriteExtraChunks

(

PWAVFile &

)

[inline, virtual]

write any extra headers after the FORMAT chunk

virtual PBoolean PWAVFileFormat::ReadExtraChunks

(

PWAVFile &

)

[inline, virtual]

read any extra headers after the FORMAT chunk

virtual void PWAVFileFormat::OnStart

(

)

[inline, virtual]

called before the reading/writing starts

virtual void PWAVFileFormat::OnStop

(

)

[inline, virtual]

called after the reading/writing stops

virtual PBoolean PWAVFileFormat::Read	(	PWAVFile &	file,
		void *	buf,
		PINDEX &	len
	)			[virtual]

write data to the file

virtual PBoolean PWAVFileFormat::Write	(	PWAVFile &	file,
		const void *	buf,
		PINDEX &	len
	)			[virtual]

read data from the file

---

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

• pwavfile.h

---