Retrieves the value of an attribute of a sample, stream or MOD music. Can also get the sample rate of a recording channel.
Namespace: Un4seen.Bass
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.17.2
Syntax
[DllImportAttribute("bass")] public static bool BASS_ChannelGetAttribute( int handle, BASSAttribute attrib, ref float value )
Parameters
- handle
- Type: SystemInt32
The channel handle... a HCHANNEL, HMUSIC, HSTREAM or HRECORD. - attrib
- Type: Un4seen.BassBASSAttribute
The attribute to set the value of (one of the following, see BASSAttribute):Other attributes may be supported by add-ons, e.g. BASS_FX:BASS_ATTRIB_BITRATE Average bitrate. (HSTREAM only). BASS_ATTRIB_BUFFER Playback buffering length. (HMUSIC/HSTREAM only). BASS_ATTRIB_CPU CPU usage. (HMUSIC/HSTREAM) BASS_ATTRIB_FREQ Sample rate. BASS_ATTRIB_GRANULE Processing granularity. (HMUSIC/HSTREAM/HRECORD). BASS_ATTRIB_MUSIC_ACTIVE Active channel count. (HMUSIC) BASS_ATTRIB_MUSIC_AMPLIFY Amplification level. (HMUSIC) BASS_ATTRIB_MUSIC_BPM BPM. (HMUSIC) BASS_ATTRIB_MUSIC_PANSEP Pan separation level. (HMUSIC) BASS_ATTRIB_MUSIC_PSCALER Position scaler. (HMUSIC) BASS_ATTRIB_MUSIC_SPEED Speed. (HMUSIC) BASS_ATTRIB_MUSIC_VOL_CHAN A channel volume level. (HMUSIC) BASS_ATTRIB_MUSIC_VOL_GLOBAL Global volume level. (HMUSIC) BASS_ATTRIB_MUSIC_VOL_INST An instrument/sample volume level. (HMUSIC) BASS_ATTRIB_NET_RESUME The volume level, 0 (silent) to 1 (full) or above. BASS_ATTRIB_NOBUFFER Buffer level to resume stalled playback. (HSTREAM). BASS_ATTRIB_NORAMP Playback ramping switch. BASS_ATTRIB_PAN Panning/balance position. BASS_ATTRIB_PUSH_LIMIT Push stream buffer limit. BASS_ATTRIB_SRC Sample rate conversion quality. BASS_ATTRIB_TAIL Length extension. (HMUSIC/HSTREAM). BASS_ATTRIB_VOL Volume level. BASS_ATTRIB_TEMPO The tempo of a channel in percent. BASS_ATTRIB_TEMPO_PITCH The pitch of a channel in semitones. BASS_ATTRIB_TEMPO_FREQ The sample rate of a channel in Hz. BASS_ATTRIB_TEMPO_OPTION_USE_AA_FILTER AA Filter used on a tempo channel. BASS_ATTRIB_TEMPO_OPTION_AA_FILTER_LENGTH The AA Filter length in taps. BASS_ATTRIB_TEMPO_OPTION_USE_QUICKALGO Tempo quick algorithm used on a tempo channel. BASS_ATTRIB_TEMPO_OPTION_SEQUENCE_MS The tempo sequence in ms. used on a tempo channel. BASS_ATTRIB_TEMPO_OPTION_SEEKWINDOW_MS The tempo seek window in ms. used on a tempo channel. BASS_ATTRIB_TEMPO_OPTION_OVERLAP_MS The tempo overlap in ms. used on a tempo channel. BASS_ATTRIB_REVERSE_DIR The current playback direction of a reverse stream. - value
- Type: SystemSingle
Pointer to a variable to receive the attribute value.
Return Value
Type: BooleanIf successful, is returned, else is returned. Use BASS_ErrorGetCode to get the error code.
Remarks
ERROR CODE | Description |
---|---|
BASS_ERROR_HANDLE | handle is not a valid channel. |
BASS_ERROR_ILLTYPE | attrib is not valid. |
Examples
float vol = 0f; if (Bass.BASS_ChannelGetAttribute(stream, BASSAttribute.BASS_ATTRIB_VOL, ref vol)) Console.WriteLine("Volume={0}", vol);
See Also