HGE::Stream_Load

Loads a compressed audio stream from memory, resource pack or disk file.

HSTREAM Stream_Load(
  const char *filename,
  DWORD size = 0
);

Parameters

filename

Stream file name.

size

If this parameter isn't 0, it is the size of memory block containing the stream in one of the known formats and the parameter filename is treated as a pointer to this block.

Return value

If successful, returns the stream handle to be used with Stream_Play function. Otherwise returns 0.

Remarks

Supports MP1, MP2, MP3, OGG and WAV file formats.

If filename specifies relative path, stream file is first searched within all resource packs attached with Resource_AttachPack, then in the application disk folder. If filename specifies absolute disk path, stream file is loaded directly from disk.

If the function fails, you may obtain error message with System_GetErrorMessage function. Also if HGE_LOGFILE system state was set, the error message is written to log.

When the stream isn't needed longer, you must delete it with Stream_Free function.

Requirements

Header: hge.h
Import library: hge.lib

See also

Stream_Free, Stream_Play