StarBurn SDK (Software Development Kit)
ContentsIndexHome
PreviousUpNext
StarBurn_StarWave_CompressedFileUncompress Function
C++
__stdcall STARBURN_IMPEX_API ULONG StarBurn_StarWave_CompressedFileUncompress(IN PCHAR p__PCHAR__SourceCompressedFileName, IN PCHAR p__PCHAR__DestinationUncompressedFileName, IN ULONG p__ULONG__WorkingBufferSizeInUCHARs, IN BOOLEAN p__BOOLEAN__IsWavHeaderRequired, OUT PULONG p__PULONG__UncompressedSizeInUCHARs, IN PSTARBURN_STARWAVE_CALLBACK p__PSTARBURN_STARWAVE_CALLBACK, IN PVOID p__PVOID__Context);
Parameters 
Description 
IN PCHAR p__PCHAR__SourceCompressedFileName 
Pointer to source compressed file name.
 
IN PCHAR p__PCHAR__DestinationUncompressedFileName 
Pointer to destination uncompressed file name.
 
IN ULONG p__ULONG__WorkingBufferSizeInUCHARs 
Working buffer size in UCHARs (recommended to have it equal to STARBURN_STARWAVE_IO_BUFFER_SIZE_IN_UCHARS).
 
IN BOOLEAN p__BOOLEAN__IsWavHeaderRequired 
Is WAV header required for destination file (WAV would be result) or not (RAW would be result).
 
OUT PULONG p__PULONG__UncompressedSizeInUCHARs 
Pointer to the variable to receive uncompressed payload size in UCHARs.
 
IN PSTARBURN_STARWAVE_CALLBACK p__PSTARBURN_STARWAVE_CALLBACK 
Pointer to callback function to process progress indication and I/O cancellation.
 
IN PVOID p__PVOID__Context 
Pointer to the context value passed to callback function. 

Execution status.

This function uncompresses compressed file to either WAV or RAW PCM.

None.

See AudioCompressor StarBurn sample application as an example how to use StarBurn_StarWave_CompressedFileUncompress API call.