BASS_OPUS_StreamCreateURL
Creates a sample stream from an Opus file on the internet, optionally receiving the downloaded data in a callback.
HSTREAM BASS_OPUS_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.
| ||||||||||||||||||||||||
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 | Only decoding channels (BASS_STREAM_DECODE) are allowed when using the "no sound" device. The BASS_STREAM_AUTOFREE flag is also unavailable to decoding channels. |
BASS_ERROR_NONET | No internet connection could be opened. |
BASS_ERROR_ILLPARAM | url is not a valid URL. |
BASS_ERROR_SSL | SSL/HTTPS support is not available. |
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 by the device/drivers. If the stream is more than stereo or the BASS_SAMPLE_FLOAT flag is used, it could be that they are not supported (ie. no WDM drivers). |
BASS_ERROR_SPEAKER | The specified SPEAKER flags are invalid. The device/drivers do not support them, they are attempting to assign a stereo stream to a mono speaker or 3D functionality is enabled. |
BASS_ERROR_MEM | There is insufficent memory. |
BASS_ERROR_NO3D | Could not initialize 3D support. |
BASS_ERROR_UNKNOWN | Some other mystery problem! |
Remarks
Use BASS_ChannelGetInfo to retrieve information on the format of the stream. Opus always has a sample rate of 48000 Hz, but the source material may have had a different sample rate, which is available via the BASS_ATTRIB_OPUS_ORIGFREQ attribute. The playback length is not available until the entire file has been downloaded, at which point it can be retrieved using BASS_ChannelGetLength.The Opus file format is Ogg-based, so the standard BASS_TAG_OGG and BASS_TAG_VENDOR tag types apply to Opus too, via BASS_ChannelGetTags. The BASS_SYNC_OGG_CHANGE sync is also supported, via BASS_ChannelSetSync.
When playing the stream, BASS will stall the playback if there is insufficient data to continue playing. Playback will automatically be resumed when sufficient data has been downloaded. BASS_ChannelIsActive can be used to check if the playback is stalled, and the progress of the file download can be checked with BASS_StreamGetFilePosition.
When streaming in blocks (BASS_STREAM_BLOCK flag), be careful not to stop/pause the stream for too long, otherwise the connection may timeout due to there being no activity and the stream will end prematurely.
When using an offset, the file length returned by BASS_StreamGetFilePosition can be used to check that it was successful by comparing it with the original file length. Another way to check is to inspect the HTTP headers retrieved with BASS_ChannelGetTags.
Platform-specific
Away from Windows, all mixing is done in software (by BASS), so the BASS_SAMPLE_SOFTWARE flag is unnecessary. The BASS_SAMPLE_FX flag is also ignored.See also
BASS_OPUS_StreamCreateFile, BASS_OPUS_StreamCreateFileUserBASS_ChannelGetInfo, BASS_ChannelGetLength, BASS_ChannelGetTags, BASS_ChannelPlay, BASS_ChannelSetAttribute, BASS_ChannelSetDSP, BASS_ChannelSetFX, BASS_ChannelSetLink, BASS_StreamFree, DOWNLOADPROC callback, BASS_CONFIG_NET_AGENT, BASS_CONFIG_NET_BUFFER, BASS_CONFIG_NET_PREBUF, BASS_CONFIG_NET_PROXY, BASS_CONFIG_NET_TIMEOUT