DzAudioImporter Class Reference
[File Input and Output Objects]

Base class for all audio clip importers. More...

Inheritance diagram for DzAudioImporter:

DzFileIO DzBase QObject Object List of all members.

Methods

String getDescription ()
String getExtension ()
DzError loadAudio (String filename, DzAudioClip clip, DzFileIOSettings options)
DzError loadAudio (String filename, DzAudioClip clip)
Boolean recognize (String filename)

Detailed Description

Base class for all audio clip importers.

See also:
DzMultiMediaMgr


Member Function Documentation

String DzAudioImporter::getDescription (  ) 

Returns:
A description of the importer that can be placed in a file type selection combo box (e.g. "WAV Format").

String DzAudioImporter::getExtension (  ) 

Returns:
The file extension (excluding the preceding dot) supported by this importer.

DzError DzAudioImporter::loadAudio ( String  filename,
DzAudioClip  clip,
DzFileIOSettings  options 
)

Reads the file.

Parameters:
filename Name of the file to be read.
clip Audio clip to read data into.
options Options for loading the audio clip.
Returns:
DZ_NO_ERROR on success, otherwise an error code.

DzError DzAudioImporter::loadAudio ( String  filename,
DzAudioClip  clip 
)

Reads the file.

Parameters:
filename Name of the file to be read.
clip Audio clip to read data into.
Returns:
DZ_NO_ERROR on success, otherwise an error code.

Boolean DzAudioImporter::recognize ( String  filename  ) 

Test the given filename and file contents to see if this importer can read it.

Parameters:
filename The name of the file to test.
Returns:
true if the importer can import the file, otherwise false.


Generated on Thu Sep 24 12:21:10 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.