Blender V2.61 - r43446
Public Member Functions

AUD_IWriter Class Reference

#include <AUD_IWriter.h>

Inheritance diagram for AUD_IWriter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~AUD_IWriter ()
virtual int getPosition () const =0
virtual AUD_DeviceSpecs getSpecs () const =0
virtual void write (unsigned int length, sample_t *buffer)=0

Detailed Description

This class represents a sound sink where audio data can be written to.

Definition at line 38 of file AUD_IWriter.h.


Constructor & Destructor Documentation

virtual AUD_IWriter::~AUD_IWriter ( ) [inline, virtual]

Destroys the writer.

Definition at line 44 of file AUD_IWriter.h.


Member Function Documentation

virtual int AUD_IWriter::getPosition ( ) const [pure virtual]

Returns how many samples have been written so far.

Returns:
The writing position as sample count. May be negative if unknown.

Implemented in AUD_FFMPEGWriter, and AUD_SndFileWriter.

virtual AUD_DeviceSpecs AUD_IWriter::getSpecs ( ) const [pure virtual]

Returns the specification of the audio data being written into the sink.

Returns:
The AUD_DeviceSpecs structure.
Note:
Regardless of the format the input still has to be float!

Implemented in AUD_FFMPEGWriter, and AUD_SndFileWriter.

virtual void AUD_IWriter::write ( unsigned int  length,
sample_t buffer 
) [pure virtual]

Request to write the next length samples out into the sink.

Parameters:
lengthThe count of samples to write.
bufferThe pointer to the buffer containing the data.

Implemented in AUD_FFMPEGWriter, and AUD_SndFileWriter.


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