Navigation:  thinBasic Modules > TBASS (Sound Module) > TBASS Config >

TBASS_SetConfig

Previous pageReturn to chapter overviewNext page

 

Description

 

Sets the value of a config option.

 

Syntax

 

n = TBASS_SetConfig(Option, Value)

 

Returns

 

Number

If successful, the new value is returned, which may not be the same as requested with some options. Otherwise, -1 is returned. Use TBASS_ErrorGetCode to get the error code.

 

Parameters

 

Name

Type

Optional

Meaning

Option

Number

No

The option to get the value of... one of the following.

 

Flag

Meaning

%TBASS_CONFIG_3DALGORITHM

The 3D algorithm for software mixed 3D channels.

%TBASS_CONFIG_BUFFER

Playback buffer length.

%TBASS_CONFIG_CURVE_PAN

Panning translation curve.

%TBASS_CONFIG_CURVE_VOL

Volume translation curve.

%TBASS_CONFIG_FLOATDSP

Pass 32-bit floating-point sample data to all DSP functions?

%TBASS_CONFIG_GVOL_MUSIC

Global music volume.

%TBASS_CONFIG_GVOL_SAMPLE

Global sample volume.

%TBASS_CONFIG_GVOL_STREAM

Global stream volume.

%TBASS_CONFIG_MAXVOL

Maximum volume level.

%TBASS_CONFIG_MP3_CODEC

MP3 decoder to use.

%TBASS_CONFIG_NET_AGENT

"User-Agent" header.

%TBASS_CONFIG_NET_BUFFER

Internet download buffer length.

%TBASS_CONFIG_NET_PASSIVE

Use passive mode in FTP connections?

%TBASS_CONFIG_NET_PREBUF

Amount to pre-buffer when opening internet streams.

%TBASS_CONFIG_NET_PROXY

Proxy server settings.

%TBASS_CONFIG_NET_TIMEOUT

Time to wait for a server to respond to a connection request.

%TBASS_CONFIG_PAUSE_NOPLAY

Prevent channels being played when the output is paused?

%TBASS_CONFIG_UPDATEPERIOD

Update period of playback buffers.



 

Value

Number

No

The new option value. See the option's documentation for details on the possible values.

 

Remarks

 

Restrictions

 

See also

 

Examples