BASS_APE_StreamCreateURL
Creates a sample stream from a Monkey's Audio file on the internet, optionally receiving the downloaded data in a callback.
HSTREAM BASS_APE_StreamCreateURL(
char *url,
DWORD offset,
DWORD flags,
DOWNLOADPROC *proc,
void *user
);
Parameters
| url | URL of the file to stream. Should begin with "http://" or "https://" or "ftp://".
|
| offset | File position to start streaming from. This is ignored by some servers, specifically when the file length is unknown.
|
| 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.
| | BASS_STREAM_BLOCK | Only keep a block of the downloaded 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.
| | BASS_STREAM_STATUS | Pass status info (HTTP/ICY tags) from the server to the DOWNLOADPROC callback during connection. This can be useful to determine the reason for a failure.
| | 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_UNICODE | url is in UTF-16 form. Otherwise it is ANSI on Windows and UTF-8 on other platforms.
|
|
| proc | Callback function to receive the file as it is downloaded... NULL = no callback.
|
| user | User instance data to pass to the callback function.
|
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_NONET | No internet connection could be opened.
|
| BASS_ERROR_ILLPARAM | url is not a valid URL.
|
| BASS_ERROR_PROTOCOL | The protocol in url is not supported.
|
| BASS_ERROR_SSL | SSL/HTTPS support is not available. See BASS_CONFIG_LIBSSL.
|
| BASS_ERROR_TIMEOUT | The server did not respond to the request within the timeout period, as set with the BASS_CONFIG_NET_TIMEOUT config option.
|
| BASS_ERROR_FILEOPEN | The file could not be opened.
|
| 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_StreamCreateURL remarks.
See also
BASS_APE_StreamCreateFile, BASS_APE_StreamCreateFileUser
BASS_ChannelGetInfo, BASS_ChannelGetLength, BASS_ChannelGetTags, BASS_ChannelPlay, BASS_ChannelSetAttribute, BASS_ChannelSetDSP, BASS_ChannelSetFX, BASS_StreamFree, BASS_StreamGetFilePosition, DOWNLOADPROC callback, BASS_CONFIG_NET_AGENT, BASS_CONFIG_NET_BUFFER, BASS_CONFIG_NET_PREBUF, BASS_CONFIG_NET_PROXY, BASS_CONFIG_NET_TIMEOUT