BassBASS_ChannelGet3DAttributes Method (Int32, Object, Object, Object, Object, Object, Object)

BASS.NET API for the Un4seen BASS Audio Library

Retrieves the 3D attributes of a sample, stream, or MOD music channel with 3D functionality.

Namespace: Un4seen.Bass
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.17.5

Syntax

[DllImportAttribute("bass")]
public static bool BASS_ChannelGet3DAttributes(
	int handle,
	Object mode,
	Object min,
	Object max,
	Object iangle,
	Object oangle,
	Object outvol
)

<DllImportAttribute("bass">]
Public Shared Function BASS_ChannelGet3DAttributes ( 
	handle As Integer,
	<OutAttribute> mode As Object,
	<OutAttribute> min As Object,
	<OutAttribute> max As Object,
	<OutAttribute> iangle As Object,
	<OutAttribute> oangle As Object,
	<OutAttribute> outvol As Object
) As Boolean

Parameters

handle: Type: SystemInt32
The channel handle... a HCHANNEL, HMUSIC, HSTREAM.
mode: Type: SystemObject
The 3D processing mode (see BASS3DMode)... = don't retrieve it. (int)
min: Type: SystemObject
The minimum distance... = don't retrieve it. (float)
max: Type: SystemObject
The maximum distance... = don't retrieve it. (float)
iangle: Type: SystemObject
The angle of the inside projection cone... = don't retrieve it. (int)
oangle: Type: SystemObject
The angle of the outside projection cone... = don't retrieve it. (int)
outvol: Type: SystemObject
The delta-volume outside the outer projection cone... = don't retrieve it. (int)

Return Value

Type: Boolean
If succesful, then is returned, else is returned. Use BASS_ErrorGetCode to get the error code.

Remarks

The iangle and oangle parameters must both be retrieved in a single call to this function (ie. you can't retrieve one without the other). See BASS_ChannelSet3DAttributes(Int32, BASS3DMode, Single, Single, Int32, Int32, Int32) for an explanation of the parameters.

This overload uses native object, so you can specify for some or all parameters in order to not retrieve them. However, the return values of these parameters must be casted back to it's original type.

ERROR CODE	Description
BASS_ERROR_HANDLE	handle is not a valid channel.
BASS_ERROR_NO3D	The channel does not have 3D functionality.

Examples

Only get the delta-volume outside the outer projection cone:

Copy

object outvol = 0;
bool ok = Bass.BASS_ChannelGet3DAttributes(handle, null, null, null, null, null, outvol);
// cast the outvol back it it's normal value type (int)
int deltaVol = (int)outvol;

Dim outvol As BASobject = 0
Dim ok As Boolean = Bass.BASS_ChannelGet3DAttributes(handle, Nothing, Nothing, Nothing, Nothing, Nothing, outvol)
' cast the outvol back it it's normal value type (int)
Dim deltaVol As Integer = CInt(outvol)

Reference

Bass Class

BASS_ChannelGet3DAttributes Overload

Un4seen.Bass Namespace

BassAddLanguageSpecificTextSet("LST911079A0_0?cpp=::|nu=.");BASS_ChannelGet3DAttributes Method (Int32, Object, Object, Object, Object, Object, Object)

Parameters

Return Value

Reference

BassBASS_ChannelGet3DAttributes Method (Int32, Object, Object, Object, Object, Object, Object)