An audio file writer. More...

Typedefs
typedef struct PlankAudioFileWriter *	PlankAudioFileWriterRef
	An opaque reference to the Plank AudioFileWriter object.
Functions
PlankAudioFileWriterRef	pl_AudioFileWriter_CreateAndInit ()
	Create and intitialise a Plank AudioFileWriter object and return an oqaque reference to it.
PlankAudioFileWriterRef	pl_AudioFileWriter_Create ()
	Create a Plank AudioFileWriter object and return an oqaque reference to it.
PlankResult	pl_AudioFileWriter_Init (PlankAudioFileWriterRef p)
	Inititalise a Plank AudioFileWriter object.
PlankResult	pl_AudioFileWriter_DeInit (PlankAudioFileWriterRef p)
	Deinitialise a Plank AudioFileWriter object.
PlankResult	pl_AudioFileWriter_Destroy (PlankAudioFileWriterRef p)
	Destroy a Plank AudioFileWriter object.
PlankFileRef	pl_AudioFileWriter_GetFile (PlankAudioFileWriterRef p)
	Gets the underlying Plank File object.
PlankAudioFileFormatInfo *	pl_AudioFileWriter_GetFormatInfo (PlankAudioFileWriterRef p)
	Get format before open.

Detailed Description

An audio file writer.

Typedef Documentation

typedef struct PlankAudioFileWriter* PlankAudioFileWriterRef

An opaque reference to the Plank AudioFileWriter object.

PlankAudioFileWriterRef pl_AudioFileWriter_Create ( )

Create a Plank AudioFileWriter object and return an oqaque reference to it.

Returns:: A Plank AudioFileWriter object as an opaque reference or PLANK_NULL.

PlankAudioFileWriterRef pl_AudioFileWriter_CreateAndInit ( )

Create and intitialise a Plank AudioFileWriter object and return an oqaque reference to it.

Returns:: A Plank AudioFileWriter object as an opaque reference or PLANK_NULL.

---

PlankResult pl_AudioFileWriter_DeInit ( PlankAudioFileWriterRef p )

Deinitialise a Plank AudioFileWriter object.

Parameters:

p	The Plank AudioFileWriter object.

Returns:: A result code which will be PlankResult_OK if the operation was completely successful.

PlankResult pl_AudioFileWriter_Destroy ( PlankAudioFileWriterRef p )

Destroy a Plank AudioFileWriter object.

Parameters:

p	The Plank AudioFileWriter object.

Returns:: A result code which will be PlankResult_OK if the operation was completely successful.

PlankFileRef pl_AudioFileWriter_GetFile ( PlankAudioFileWriterRef p )

Gets the underlying Plank File object.

This is the raw file object the is performing the fundamental file access operations.

Parameters:

p	The Plank AudioFileWriter object.

PlankAudioFileFormatInfo* pl_AudioFileWriter_GetFormatInfo ( PlankAudioFileWriterRef p )

Get format before open.

Returns null if the file is already open.

PlankResult pl_AudioFileWriter_Init ( PlankAudioFileWriterRef p )

Inititalise a Plank AudioFileWriter object.

Parameters:

p	The Plank AudioFileWriter object.

Returns:: A result code which will be PlankResult_OK if the operation was completely successful.