BASS_SamplePlay3DEx

Plays a sample with 3D functionality from an offset, overriding the sample's default attributes with those specified.

HCHANNEL WINAPI BASS_SamplePlay3DEx( HSAMPLE handle BASS_3DVECTOR *pos, BASS_3DVECTOR *orient, BASS_3DVECTOR *vel DWORD start, int freq, int volume, BOOL loop );

Parameters

handle Handle of the sample to play.

pos Position of the sound... NULL = x / y / z = 0.

orient Orientation of the sound... NULL = x / y / z = 0.

vel Velocity of the sound... NULL = x / y / z = 0. This is only used to calculate the doppler effect, and has no effect on the sound's position.

start Playback start position in samples (not bytes).

freq The sample rate... 100 (min) - 100000 (max), -1 = use sample's default.

volume The volume... 0 (silent) - 100 (max), -1 = use sample's default.

loop TRUE = Loop the sample... -1 = use sample's default.

Return value
If successful, the handle of the channel used to play the sample is returned, else NULL is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_START The digital output has not been started. Use BASS_Start to do so.

BASS_ERROR_HANDLE handle is not a valid sample handle.

BASS_ERROR_FREQ freq is out of range... DirectSound only allows sample rates between 100 and 100000.

BASS_ERROR_NO3D The sample does not have 3D functionality... BASS_SamplePlayEx should be used to play it.

BASS_ERROR_NOCHAN The sample has no free channel on which to be played... the maximum number of simultaneous playbacks has been reached, and no BASS_SAMPLE_OVER flag was specfied for the sample.

BASS_ERROR_NOHW No hardware voices are available... this only occurs if the sample was loaded or created with the BASS_SAMPLE_VAM flag, and BASS_VAM_HARDWARE is set in the sample's VAM mode, and there are no hardware voices available to play it.
BASS_ERROR_BUFLOST Should not happen, but... PLEASE REPORT IT IF YOU DO GET THIS ERROR!

handle	Handle of the sample to play.
pos	Position of the sound... NULL = x / y / z = 0.
orient	Orientation of the sound... NULL = x / y / z = 0.
vel	Velocity of the sound... NULL = x / y / z = 0. This is only used to calculate the doppler effect, and has no effect on the sound's position.
start	Playback start position in samples (not bytes).
freq	The sample rate... 100 (min) - 100000 (max), -1 = use sample's default.
volume	The volume... 0 (silent) - 100 (max), -1 = use sample's default.
loop	TRUE = Loop the sample... -1 = use sample's default.

BASS_ERROR_START	The digital output has not been started. Use BASS_Start to do so.
BASS_ERROR_HANDLE	handle is not a valid sample handle.
BASS_ERROR_FREQ	freq is out of range... DirectSound only allows sample rates between 100 and 100000.
BASS_ERROR_NO3D	The sample does not have 3D functionality... BASS_SamplePlayEx should be used to play it.
BASS_ERROR_NOCHAN	The sample has no free channel on which to be played... the maximum number of simultaneous playbacks has been reached, and no BASS_SAMPLE_OVER flag was specfied for the sample.
BASS_ERROR_NOHW	No hardware voices are available... this only occurs if the sample was loaded or created with the BASS_SAMPLE_VAM flag, and BASS_VAM_HARDWARE is set in the sample's VAM mode, and there are no hardware voices available to play it.
BASS_ERROR_BUFLOST	Should not happen, but... PLEASE REPORT IT IF YOU DO GET THIS ERROR!