BASS_SAMPLE Class

[SerializableAttribute]
[StructLayoutAttribute(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
public sealed class BASS_SAMPLE

<SerializableAttribute>
<StructLayoutAttribute(LayoutKind.Sequential, CharSet := CharSet.Ansi)>
Public NotInheritable Class BASS_SAMPLE

The BASS_SAMPLE type exposes the following members.

	Name	Description
	BASS_SAMPLE	Default constructor.
	BASS_SAMPLE(Int32, Single, Single, BASSFlag, Int32, Int32, Int32, Int32, Int32, BASS3DMode, Single, Single, Int32, Int32, Single, BASSVam, Int32)	Constructor to initialize the members.

	Name	Description
	origresIsFloat	Is the original resolution floating point?
	origresValue	The original resolution value in bits per samples.

	Name	Description
	ToString	A description of the record decive info object (driver file name, inputs etc.). (Overrides ObjectToString.)

	Name	Description
	chans	Number of channels... 1=mono, 2=stereo (default), etc.
	flags	A combination of these flags (BASSFlag): BASS_SAMPLE_8BITS The samples's resolution is 8-bit. If neither this or the BASS_SAMPLE_FLOAT flags are present, then the sample's resolution is 16-bit. BASS_SAMPLE_FLOAT The samples's resolution is 32-bit floating-point. BASS_SAMPLE_LOOP Looped? BASS_SAMPLE_3D The sample has 3D functionality enabled. BASS_SAMPLE_MUTEMAX Mute the sample when it is at (or beyond) it's max distance (3D samples only). BASS_SAMPLE_SOFTWARE The sample is not using hardware mixing... it is being mixed in software by DirectSound. BASS_SAMPLE_VAM DX7 voice allocation and management features are enabled (see below). BASS_SAMPLE_OVER_VOL Override: the channel with the lowest volume is overriden. BASS_SAMPLE_OVER_POS Override: the longest playing channel is overriden. BASS_SAMPLE_OVER_DIST Override: the channel furthest away (from the listener) is overriden (3D samples only).
	freq	Default playback rate (set to 44100 by default).
	iangle	The angle of the inside projection cone in degrees... 0 (no cone, default) - 360 (sphere).
	length	The length in bytes.
	max	Maximum number of simultaneous playbacks (defaulted to 1).
	maxdist	The maximum distance (default 0). The sample's volume stops decreasing when the listener is beyond this distance.
	mindist	The minimum distance (default 0). The sample's volume is at maximum when the listener is within this distance.
	mingap	Minimum time gap in milliseconds between creating channels using BASS_SampleGetChannel(Int32, BASSFlag). This can be used to prevent flanging effects caused by playing a sample multiple times very close to eachother. The default setting, when loading/creating a sample, is 0 (disabled).
	mode3d	The 3D processing mode... one of these flags (see BASS3DMode): BASS_3DMODE_NORMAL Normal 3D processing (default). BASS_3DMODE_RELATIVE The sample's 3D position (position/velocity/orientation) is relative to the listener. When the listener's position/velocity/orientation is changed with BASS_Set3DPosition(BASS_3DVECTOR, BASS_3DVECTOR, BASS_3DVECTOR, BASS_3DVECTOR), the sample's position relative to the listener does not change. BASS_3DMODE_OFF Turn off 3D processing on the sample, the sound will be played in the center.
	oangle	The angle of the outside projection cone in degrees... 0 (no cone, default) - 360 (sphere).
	origres	The original resolution (bits per sample)... 0 = undefined (default).
	outvol	The delta-volume outside the outer projection cone... 0 (silent) to 1 (full, default) - same as inside the cone.
	pan	Default panning position -1 (full left) to +1 (full right) - defaulted to 0 = centre.
	priority	Priority, used with the BASS_VAM_TERM_PRIO flag... 0 (min, default) - 0xFFFFFFFF (max)
	vam	The following are the sample's DX7 voice allocation/management settings (if VAM is enabled)...a combination of these (BASSVam): BASS_VAM_HARDWARE Play the sample in hardware (default). If no hardware voices are available then the play call will fail. BASS_VAM_SOFTWARE Play the sample in software (ie. non-accelerated). No other VAM flags may be used together with this flag. The following flags enable hardware resource stealing... if the hardware has no available voices, a currently playing buffer will be stopped to make room for the new buffer. Only samples with VAM enabled are considered for termination: BASS_VAM_TERM_TIME If there are no free hardware voices, the buffer to be terminated will be the one with the least time left to play. BASS_VAM_TERM_DIST If there are no free hardware voices, the buffer to be terminated will be one that was loaded/created with the BASS_SAMPLE_MUTEMAX flag and is beyond it's max distance (maxdist). If there are no buffers that match this criteria, then the play call will fail. BASS_VAM_TERM_PRIO If there are no free hardware voices, the buffer to be terminated will be the one with the lowest priority. This flag may be used with the TERM_TIME or TERM_DIST flag, if multiple voices have the same priority then the time or distance is used to decide which to terminate.
	volume	Default volume... 0 (silent) to 1 (full, default).

When a sample has 3D functionality, the iangle and oangle angles decide how wide the sound is projected around the orientation angle (as set via BASS_ChannelSet3DPosition(Int32, BASS_3DVECTOR, BASS_3DVECTOR, BASS_3DVECTOR)). Within the inside angle the volume level is the level set in the volume member (or the BASS_ATTRIB_VOL attribute when the sample is playing). Outside the outer angle, the volume changes according to the outvol value. Between the inner and outer angles, the volume gradually changes between the inner and outer volume levels. If the inner and outer angles are 360 degrees, then the sound is transmitted equally in all directions.

When VAM is enabled, and neither the BASS_VAM_HARDWARE or BASS_VAM_SOFTWARE flags are specified, then the sample will be played in hardware if resources are available, and in software if no hardware resources are available.

Reference