Query current mode and device

Current modes

The currently used capture mode on a given connection can be queried using

unsigned int ts3client_getCurrentCaptureMode(uint64 serverConnectionHandlerID, char **result)

retrieve the mode the current capture device on a server is using

Parameters:

  • serverConnectionHandlerID – the connection handler to retrieve the capture mode on

  • result – address of a variable receiving a c string of the capture mode currently in use. Memory is allocated by the client lib and must be freed by caller using ts3client_freeMemory

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason

The currently used playback mode on a given connection is queried using

unsigned int ts3client_getCurrentPlayBackMode(uint64 serverConnectionHandlerID, char **result)

retrieve the mode the current playback device on a server is using

Parameters:

  • serverConnectionHandlerID – the connection handler to retrieve the playback mode on

  • result – address of a variable receiving a c string of the playback mode currently in use. Memory is allocated by the client lib and must be freed by caller using ts3client_freeMemory

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason

Current devices

To query the currently open capture device on a connection use

unsigned int ts3client_getCurrentCaptureDeviceName(uint64 serverConnectionHandlerID, char **result, int *isDefault)

retrieve the device name that is currently used to capture audio on a server

Parameters:

  • serverConnectionHandlerID – the connection handler to retrieve the active capture device on

  • result – address of a variable receiving a c string of the device name currently in use. Memory is allocated by the client lib and must be freed by caller using ts3client_freeMemory

  • isDefault – address of a variable receiving whether the device in use is the default device. Pass NULL if you don’t need the information

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason

To query the currently open playback device on a connection use

unsigned int ts3client_getCurrentPlaybackDeviceName(uint64 serverConnectionHandlerID, char **result, int *isDefault)

retrieve the device name that is currently used to play audio on a server

Parameters:

  • serverConnectionHandlerID – the connection handler to retrieve the active playback device on

  • result – address of a variable receiving a c string of the device name currently in use. Memory is allocated by the client lib and must be freed by caller using ts3client_freeMemory

  • isDefault – address of a variable receiving whether the device in use is the default device. Pass NULL if you don’t need the information

Returns:

An Error code from the Ts3ErrorType enum indicating either success or the failure reason