BASS_APE_StreamCreateFileUser
Creates a sample stream from a Monkey's Audio file via user callback functions.
HSTREAM BASS_APE_StreamCreateFileUser(
DWORD system,
DWORD flags,
BASS_FILEPROCS *procs,
void *user
);
Parameters
| system | File system to use, one of the following.
| STREAMFILE_NOBUFFER | Unbuffered.
| | STREAMFILE_BUFFER | Buffered.
| | STREAMFILE_BUFFERPUSH | Buffered, with the data pushed to BASS via BASS_StreamPutFileData.
|
|
| flags | A combination of these flags.
| BASS_SAMPLE_FLOAT | Use 32-bit floating-point sample data. See Floating-point channels for info.
| | BASS_SAMPLE_3D | Enable 3D functionality. The stream must be mono. The SPEAKER flags cannot be used together with this flag.
| | BASS_SAMPLE_LOOP | Loop the file. This flag can be toggled at any time using BASS_ChannelFlags. This flag is ignored when streaming in blocks (BASS_STREAM_BLOCK).
| | BASS_STREAM_RESTRATE | Restrict the "download" rate of the file, according to the BASS_CONFIG_NET_RESTRATE config setting. If this flag is not used then the file will be downloaded as quickly as possible. This flag only has effect when using the STREAMFILE_BUFFER system.
| | BASS_STREAM_BLOCK | Only keep a block of the file in memory, determined by the BASS_CONFIG_NET_BUFFER config setting, rather than the whole file. This uses a lot less memory than otherwise, but it is not possible to seek or loop the stream. This flag will be applied automatically when the file length is unknown or over 2GB. This flag has no effect when using the STREAMFILE_NOBUFFER system.
| | BASS_STREAM_AUTOFREE | Automatically free the stream when playback ends.
| | BASS_STREAM_DECODE | Decode the sample data, without playing it. Use BASS_ChannelGetData to retrieve decoded sample data. The BASS_SAMPLE_3D, BASS_STREAM_AUTOFREE and SPEAKER flags cannot be used together with this flag.
| | BASS_SPEAKER_xxx | Speaker assignment flags. These flags have no effect when the stream is more than stereo.
| | BASS_ASYNCFILE | Read the file asynchronously. When enabled, the file is read and buffered in parallel with the decoding, to reduce the chances of the decoder being affected by I/O delays. This can be particularly useful with slow storage media and/or low latency output. The size of the file buffer is determined by the BASS_CONFIG_ASYNCFILE_BUFFER config option. This flag only applies when using the STREAMFILE_NOBUFFER system.
|
|
| procs | The user defined file functions.
|
| user | User instance data to pass to the callback functions.
|
Return value
If successful, the new stream's handle is returned, else 0 is returned. Use BASS_ErrorGetCode to get the error code.
Error codes
| BASS_ERROR_INIT | BASS_Init has not been successfully called.
|
| BASS_ERROR_NOTAVAIL | The BASS_STREAM_AUTOFREE flag cannot be combined with the BASS_STREAM_DECODE flag.
|
| BASS_ERROR_ILLPARAM | system is not valid.
|
| BASS_ERROR_FILEFORM | The file's format is not recognised/supported.
|
| BASS_ERROR_FORMAT | The sample format is not supported.
|
| BASS_ERROR_SPEAKER | The specified SPEAKER flags are invalid.
|
| BASS_ERROR_MEM | There is insufficient memory.
|
| BASS_ERROR_NO3D | Could not initialize 3D support.
|
| BASS_ERROR_UNKNOWN | Some other mystery problem!
|
Remarks
The BASS_APE_StreamCreateFile remarks also apply to this function, as do the general BASS_StreamCreateFileUser remarks.
See also
BASS_APE_StreamCreateFile, BASS_APE_StreamCreateURL
BASS_ChannelGetInfo, BASS_ChannelGetLength, BASS_ChannelGetTags, BASS_ChannelPlay, BASS_ChannelSetAttribute, BASS_ChannelSetDSP, BASS_ChannelSetFX, BASS_StreamFree, BASS_StreamGetFilePosition, BASS_StreamPutFileData, BASS_FILEPROCS structure, BASS_CONFIG_NET_BUFFER