OggXtra v0.2 (c) 2004 Valentin Schmidt
contact: fluxus@freenet.de


***************************************************************
INSTALLATION
***************************************************************

OggXtra is a scripting xtra for director (win) that can be used to convert 
internal sound members or external WAV files to Ogg Vorbis (OGG) files.
It depends on the DLL 'vorb_enc.dll'. This DLL must be in the system path or in 
the same folder as director.exe (authoring mode) or the projector (runtime mode). 
In case of a shockwave projector with external director DLLs, it has to reside in 
the same folder as the DLLs, e.g. the xtras folder.
The mem2ogg method also requires the two xtras 'Mix Services.x32' and 
'Sound Import Export.x32'.


***************************************************************
METHOD OVERVIEW ([...] = optional parameters, can be omitted)
***************************************************************

---------------------------------------------------------------
new(xtra "OggXtra")
---------------------------------------------------------------

Description:
============
Creates new xtra instance.

Example usage:
==============
ogg = new(xtra "OggXtra")


---------------------------------------------------------------
wav2ogg(object me, inputFile, outputFile, bitRate [, dbgFlag])
---------------------------------------------------------------

Description:
============
Converts the input WAV file 'inputFile' to OGG file 'outputFile' with 
specified bitRate (between 8 and 350(?)). If an error occurs while executing the method,
a message window pops up with an error description and an error code is returned 
(error codes see below). To suppress the message window set the optional parameter 
'dbgFlag' to 0 (zero).

Example usage:
==============
err = ogg.wav2ogg(the moviepath&"test.wav",the moviepath&"test.ogg",128)
err = ogg.wav2ogg("C:\a.wav","c:\b.ogg",32,0) -- silent mode, no error popups


---------------------------------------------------------------
mem2ogg(object me, soundMem, cast, inputFile, outputFile, bitRate [, dbgFlag])
---------------------------------------------------------------

Description:
============
Exports the sound member 'soundMem' (name or number) of castLib 'cast' (name or number)
to OGG file 'outputFile' with specified bitRate (between 8 and 350(?)).
If an error occurs while executing the method, a message window pops up with an 
error description and an error code is returned (error codes see below). 
To suppress the message window set the optional parameter 'dbgFlag' to 0 (zero).

Example usage:
==============
err = ogg.mem2ogg("mySound",1,the moviepath&"test.ogg",128)
err = ogg.mem2ogg(23,2,"c:\b.ogg",32,0) -- silent mode, no error popups


***************************************************************
ERROR CODES
***************************************************************

0:  no error
1:  blade error - invalid format
2:  blade error - invalid format parameters
3:  blade error - no more handles
4:  blade error - invalid handle
5:  error loading BladeEnc.dll
6:  unable to get BladeEnc interface
7:  error opening InputFile 
8:  error creating OutputFile
9:  out of memory
10: read error
11: write error
12: member error
13: cast error
20: unknown error