Navigation: thinBasic Modules > TBASS > Channels > TBASS_ChannelGetAttributes |
|
Description
Retrieves the basic playback attributes of a sample, stream or MOD music. Can also get the sample rate of a recording channel.
Syntax
n = TBASS_ChannelGetAttributes(hChannel, Frequency, Volume, Pan)
Returns
Number
If successful, then %TBASS_TRUE is returned, else %TBASS_FALSE is returned. Use TBASS_ErrorGetCode to get the error code.
Parameters
Name |
Type |
Optional |
Meaning |
hChannel |
Numeric |
No |
The channel handle... a HCHANNEL, HMUSIC, HSTREAM, or HRECORD. |
Frequency |
Variable |
No |
The sample rate 100 (min) 100000 (max) |
Volume |
Variable |
No |
The volume 0 (silent) 100 (max) |
Pan |
Variable |
No |
The panning position -100 (left) 100 (right) |
Remarks
Frequency, Volume, Pan must be single variables and not expressions. They will receive back relevant values.
Restrictions
See also
Examples
© 2004-2008 thinBasic. All rights reserved. | Version 1.7.0.0 | Web Site: http://www.thinbasic.com |