This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
Description
Creates a sample stream from an MP3, MP2, MP1, OGG, WAV, AIFF or plugin supported file.
Syntax
hStream = TBASS_StreamCreateFile (Memory, FileName, Offset, Lenght, Flags)
Returns
Number
If successful, the new stream's handle is returned, else 0 is returned. Use %TBASS_ErrorGetCode to get the error code.
Parameters
Name |
Type |
Optional |
Meaning |
||||||||||||||||||||||||
Memory |
Number |
No |
%TBASS_TRUE = stream the file from memory. |
||||||||||||||||||||||||
FileName |
String/Number |
No |
Filename (Memory = %TBASS_FALSE) or a memory location (Memory = %TBASS_TRUE). |
||||||||||||||||||||||||
Offset |
Number |
No |
File offset to begin streaming from (only used if Memory = %TBASS_FALSE). |
||||||||||||||||||||||||
Lenght |
Number |
No |
Data length... 0 = use all data up to the end of the file (if Memory = %TBASS_FALSE). |
||||||||||||||||||||||||
Flags |
Number |
No |
Any combination of these flags.
|
Remarks
Restrictions
See also
Examples