PTLib  Version 2.10.11
Public Member Functions | List of all members
PWAVFileFormat Class Referenceabstract

Abstract factory class for handling WAV files formats. More...

#include <pwavfile.h>

Public Member Functions

virtual ~PWAVFileFormat ()
 
virtual unsigned GetFormat () const =0
 Return a PWAVFile format code. More...
 
virtual PString GetFormatString () const =0
 Return a string that can be used as a media format. More...
 
virtual PString GetDescription () const =0
 Return a string that can be used as a text description. More...
 
virtual bool CanSetChannels (unsigned channels) const =0
 Check that this format can be set to the number of channels. More...
 
virtual void CreateHeader (PWAV::FMTChunk &header, PBYTEArray &extendedHeader)=0
 Populate the header with the correct values. More...
 
virtual void UpdateHeader (PWAV::FMTChunk &, PBYTEArray &)
 Populate the header with the correct values after initial parameters are set. More...
 
virtual PBoolean WriteExtraChunks (PWAVFile &)
 Write any extra headers after the FORMAT chunk. More...
 
virtual PBoolean ReadExtraChunks (PWAVFile &)
 Read any extra headers after the FORMAT chunk. More...
 
virtual void OnStart ()
 Called before the reading/writing starts. More...
 
virtual void OnStop ()
 Called after the reading/writing stops. More...
 
virtual PBoolean Read (PWAVFile &file, void *buf, PINDEX &len)
 Write data to the file. More...
 
virtual PBoolean Write (PWAVFile &file, const void *buf, PINDEX &len)
 Read data from the file. More...
 

Detailed Description

Abstract factory class for handling WAV files formats.

Constructor & Destructor Documentation

§ ~PWAVFileFormat()

virtual PWAVFileFormat::~PWAVFileFormat ( )
inlinevirtual

Member Function Documentation

§ CanSetChannels()

virtual bool PWAVFileFormat::CanSetChannels ( unsigned  channels) const
pure virtual

Check that this format can be set to the number of channels.

§ CreateHeader()

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

Populate the header with the correct values.

§ GetDescription()

virtual PString PWAVFileFormat::GetDescription ( ) const
pure virtual

Return a string that can be used as a text description.

§ GetFormat()

virtual unsigned PWAVFileFormat::GetFormat ( ) const
pure virtual

Return a PWAVFile format code.

§ GetFormatString()

virtual PString PWAVFileFormat::GetFormatString ( ) const
pure virtual

Return a string that can be used as a media format.

§ OnStart()

virtual void PWAVFileFormat::OnStart ( )
inlinevirtual

Called before the reading/writing starts.

§ OnStop()

virtual void PWAVFileFormat::OnStop ( )
inlinevirtual

Called after the reading/writing stops.

§ Read()

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

Write data to the file.

§ ReadExtraChunks()

virtual PBoolean PWAVFileFormat::ReadExtraChunks ( PWAVFile &  )
inlinevirtual

Read any extra headers after the FORMAT chunk.

§ UpdateHeader()

virtual void PWAVFileFormat::UpdateHeader ( PWAV::FMTChunk &  ,
PBYTEArray &   
)
inlinevirtual

Populate the header with the correct values after initial parameters are set.

§ Write()

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

Read data from the file.

§ WriteExtraChunks()

virtual PBoolean PWAVFileFormat::WriteExtraChunks ( PWAVFile &  )
inlinevirtual

Write any extra headers after the FORMAT chunk.

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