TeamTalk 4 C-API DLL
Version 4.5A
|
This section explains how to record and playback audio in the client instance. More...
Classes | |
struct | SoundDevice |
A struct containing the properties of a sound device for either playback or recording. More... | |
struct | AudioBlock |
An audio block containing the raw audio from a user who was talking. More... | |
struct | AudioFormat |
Struct describing the audio format used by a media file. More... | |
Macros | |
#define | TT_SAMPLERATES_MAX 16 |
Typedefs | |
typedef enum SoundSystem | SoundSystem |
The supported sound systems. More... | |
typedef struct SoundDevice | SoundDevice |
A struct containing the properties of a sound device for either playback or recording. More... | |
typedef enum SoundLevel | SoundLevel |
An enum encapsulation the minimum, maximum and default sound levels for input and output sound devices. More... | |
typedef enum AudioFileStatus | AudioFileStatus |
Status of audio files being written to disk. More... | |
typedef enum AudioFileFormat | AudioFileFormat |
Audio file formats supported for muxed audio recordings. More... | |
typedef struct AudioBlock | AudioBlock |
An audio block containing the raw audio from a user who was talking. More... | |
typedef struct AudioFormat | AudioFormat |
Struct describing the audio format used by a media file. More... | |
Enumerations | |
enum | SoundSystem { SOUNDSYSTEM_NONE = 0, SOUNDSYSTEM_WINMM = 1, SOUNDSYSTEM_DSOUND = 2, SOUNDSYSTEM_ALSA = 3, SOUNDSYSTEM_COREAUDIO = 4, SOUNDSYSTEM_WASAPI = 5 } |
The supported sound systems. More... | |
enum | SoundLevel { SOUND_VU_MAX = 20, SOUND_VU_MIN = 0, SOUND_VOLUME_MAX = 255, SOUND_VOLUME_MIN = 0, SOUND_GAIN_MAX = 32000, SOUND_GAIN_DEFAULT = 1000, SOUND_GAIN_MIN = 0 } |
An enum encapsulation the minimum, maximum and default sound levels for input and output sound devices. More... | |
enum | AudioFileStatus { AFS_ERROR = 0, AFS_STARTED = 1, AFS_FINISHED = 2, AFS_ABORTED = 3 } |
Status of audio files being written to disk. More... | |
enum | AudioFileFormat { AFF_NONE = 0, AFF_WAVE_FORMAT = 2, AFF_MP3_64KBIT_FORMAT = 3, AFF_MP3_128KBIT_FORMAT = 4, AFF_MP3_256KBIT_FORMAT = 5, AFF_MP3_16KBIT_FORMAT = 6, AFF_MP3_32KBIT_FORMAT = 7 } |
Audio file formats supported for muxed audio recordings. More... | |
Functions | |
TEAMTALKDLL_API BOOL | TT_GetDefaultSoundDevices (IN TTInstance *lpTTInstance, OUT INT32 *lpnInputDeviceID, OUT INT32 *lpnOutputDeviceID) |
Get the default sound devices. More... | |
TEAMTALKDLL_API BOOL | TT_GetDefaultSoundDevicesEx (IN SoundSystem nSndSystem, OUT INT32 *lpnInputDeviceID, OUT INT32 *lpnOutputDeviceID) |
Get the default sound devices for the specified sound system. More... | |
TEAMTALKDLL_API BOOL | TT_GetSoundInputDevices (IN TTInstance *lpTTInstance, IN OUT SoundDevice *lpSoundDevices, IN OUT INT32 *lpnHowMany) |
Get information about input devices for audio recording. More... | |
TEAMTALKDLL_API BOOL | TT_GetSoundOutputDevices (IN TTInstance *lpTTInstance, IN OUT SoundDevice *lpSoundDevices, IN OUT INT32 *lpnHowMany) |
Get the list of sound output devices for playback. More... | |
TEAMTALKDLL_API BOOL | TT_InitSoundInputDevice (IN TTInstance *lpTTInstance, IN INT32 nInputDeviceID) |
Initialize the sound input devices (for recording audio). More... | |
TEAMTALKDLL_API BOOL | TT_InitSoundOutputDevice (IN TTInstance *lpTTInstance, IN INT32 nOutputDeviceID) |
Initialize the sound output devices (for sound playback). More... | |
TEAMTALKDLL_API BOOL | TT_InitSoundDuplexDevices (IN TTInstance *lpTTInstance, IN INT32 nInputDeviceID, IN INT32 nOutputDeviceID) |
Enable duplex mode where multiple audio streams are mixed into a single stream using software. More... | |
TEAMTALKDLL_API BOOL | TT_CloseSoundInputDevice (IN TTInstance *lpTTInstance) |
Shutdown the input sound device. More... | |
TEAMTALKDLL_API BOOL | TT_CloseSoundOutputDevice (IN TTInstance *lpTTInstance) |
Shutdown the output sound device. More... | |
TEAMTALKDLL_API BOOL | TT_CloseSoundDuplexDevices (IN TTInstance *lpTTInstance) |
Shut down sound devices running in duplex mode. More... | |
TEAMTALKDLL_API BOOL | TT_RestartSoundSystem () |
Reinitialize sound system (in order to detect new/removed devices). More... | |
TEAMTALKDLL_API BOOL | TT_StartSoundLoopbackTest (IN TTInstance *lpTTInstance, IN INT32 nInputDeviceID, IN INT32 nOutputDeviceID, IN INT32 nSampleRate, IN INT32 nChannels) |
Perform a record and playback test of specified sound devices. More... | |
TEAMTALKDLL_API BOOL | TT_StartSoundLoopbackTestEx (IN TTInstance *lpTTInstance, IN INT32 nInputDeviceID, IN INT32 nOutputDeviceID, IN INT32 nSampleRate, IN INT32 nChannels, IN const AudioConfig *lpAudioConfig, IN BOOL bEchoCancel) |
Perform a record and playback test of specified sound devices along with an audio configuration and ability to try echo cancellation. More... | |
TEAMTALKDLL_API BOOL | TT_StopSoundLoopbackTest (IN TTInstance *lpTTInstance) |
Stop recorder and playback test. More... | |
TEAMTALKDLL_API INT32 | TT_GetSoundInputLevel (IN TTInstance *lpTTInstance) |
Get the volume level of the current recorded audio. More... | |
TEAMTALKDLL_API BOOL | TT_SetSoundInputGainLevel (IN TTInstance *lpTTInstance, IN INT32 nLevel) |
Set voice gaining of recorded audio. More... | |
TEAMTALKDLL_API INT32 | TT_GetSoundInputGainLevel (IN TTInstance *lpTTInstance) |
Get voice gain level of outgoing audio. More... | |
TEAMTALKDLL_API BOOL | TT_SetSoundOutputVolume (IN TTInstance *lpTTInstance, IN INT32 nVolume) |
Set master volume. More... | |
TEAMTALKDLL_API INT32 | TT_GetSoundOutputVolume (IN TTInstance *lpTTInstance) |
Get master volume. More... | |
TEAMTALKDLL_API BOOL | TT_SetSoundOutputMute (IN TTInstance *lpTTInstance, IN BOOL bMuteAll) |
Set all users mute. More... | |
TEAMTALKDLL_API BOOL | TT_EnableDenoising (IN TTInstance *lpTTInstance, IN BOOL bEnable) |
Enable denoising of recorded audio. More... | |
TEAMTALKDLL_API BOOL | TT_SetDenoiseLevel (IN TTInstance *lpTTInstance, IN INT32 nLevel) |
Set the denoise level of recorded audio. More... | |
TEAMTALKDLL_API INT32 | TT_GetDenoiseLevel (IN TTInstance *lpTTInstance) |
Set the denoise level of recorded audio. More... | |
TEAMTALKDLL_API BOOL | TT_EnableEchoCancellation (IN TTInstance *lpTTInstance, IN BOOL bEnable) |
Enable/disable acoustic echo cancellation (AEC). More... | |
TEAMTALKDLL_API BOOL | TT_EnableAGC (IN TTInstance *lpTTInstance, IN BOOL bEnable) |
Enable Automatic Gain Control. More... | |
TEAMTALKDLL_API BOOL | TT_SetAGCSettings (IN TTInstance *lpTTInstance, IN INT32 nGainLevel, IN INT32 nMaxIncrement, IN INT32 nMaxDecrement, IN INT32 nMaxGain) |
Set Automatic Gain Control (AGC) settings. More... | |
TEAMTALKDLL_API BOOL | TT_GetAGCSettings (IN TTInstance *lpTTInstance, OUT INT32 *lpnGainLevel, OUT INT32 *lpnMaxIncrement, OUT INT32 *lpnMaxDecrement, OUT INT32 *lpnMaxGain) |
Get Automatic Gain Control settings. More... | |
TEAMTALKDLL_API BOOL | TT_Enable3DSoundPositioning (IN TTInstance *lpTTInstance, IN BOOL bEnable) |
Enable automatically position users using 3D-sound. More... | |
TEAMTALKDLL_API BOOL | TT_AutoPositionUsers (IN TTInstance *lpTTInstance) |
Automatically position users using 3D-sound. More... | |
TEAMTALKDLL_API BOOL | TT_EnableAudioBlockEvent (IN TTInstance *lpTTInstance, IN BOOL bEnable) |
Enable/disable access to user's raw audio. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserVolume (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN INT32 nVolume) |
Set the volume of a user. More... | |
TEAMTALKDLL_API INT32 | TT_GetUserVolume (IN TTInstance *lpTTInstance, IN INT32 nUserID) |
Get the volume of a user. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserGainLevel (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN INT32 nGainLevel) |
Use software to gain a user's volume. More... | |
TEAMTALKDLL_API INT32 | TT_GetUserGainLevel (IN TTInstance *lpTTInstance, IN INT32 nUserID) |
Get the software gain level for a user. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserMute (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN BOOL bMute) |
Mute a user. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserStoppedTalkingDelay (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN INT32 nDelayMSec) |
Set the delay of when a user should be considered to no longer be talking. More... | |
TEAMTALKDLL_API INT32 | TT_GetUserStoppedTalkingDelay (IN TTInstance *lpTTInstance, IN INT32 nUserID) |
Get the delay of when a user should no longer be considered as talking. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserPosition (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN float x, IN float y, IN float z) |
Set the position of a user. More... | |
TEAMTALKDLL_API BOOL | TT_GetUserPosition (IN TTInstance *lpTTInstance, IN INT32 nUserID, OUT float *x, OUT float *y, OUT float *z) |
Get a user's position. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserStereo (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN BOOL bLeftSpeaker, IN BOOL bRightSpeaker) |
Set whether a user should speak in the left, right or both speakers. This function only works if AudioCodec has been set to use stereo. More... | |
TEAMTALKDLL_API BOOL | TT_GetUserStereo (IN TTInstance *lpTTInstance, IN INT32 nUserID, OUT BOOL *lpbLeftSpeaker, OUT BOOL *lpbRightSpeaker) |
Check what speaker a user is outputting to. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserAudioFolder (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN const TTCHAR *szFolderPath, IN const TTCHAR *szFileNameVars, IN AudioFileFormat uAFF) |
Store user's audio to disk. More... | |
TEAMTALKDLL_API BOOL | TT_SetUserMediaBufferSize (IN TTInstance *lpTTInstance, IN INT32 nUserID, IN INT32 nMSec) |
Change the amount of media data which can be buffered in the user's playback queue. More... | |
TEAMTALKDLL_API BOOL | TT_AcquireUserAudioBlock (IN TTInstance *lpTTInstance, IN INT32 nUserID, OUT AudioBlock *lpAudioBlock) |
Extract the raw audio from a user who has been talking. More... | |
TEAMTALKDLL_API BOOL | TT_ReleaseUserAudioBlock (IN TTInstance *lpTTInstance, IN INT32 nUserID) |
Release the shared memory of an AudioBlock. More... | |
TEAMTALKDLL_API BOOL | TT_ReleaseAllAudioBlocks (IN TTInstance *lpTTInstance) |
Release all audio blocks of the local client instance. More... | |
This section explains how to record and playback audio in the client instance.
Before being able to initialize the sound devices to use for recording and playback the computer's available sound devices must first be queried. This is done using the functions TT_GetSoundInputDevices and TT_GetSoundOutputDevices. These two functions return arrays of SoundDevice-structs which contains a description of the sound device. In the SoundDevice-struct there's a member variable called nDeviceID. This ID should be passed to the client instance's two sound initialization functions TT_InitSoundInputDevice and TT_InitSoundOutputDevice. Once this has been done the TT_GetFlags call will return a value containing the mask bits CLIENT_SNDINPUT_READY and CLIENT_SNDOUTPUT_READY.
A computer's default sound devices can be queried using TT_GetDefaultSoundDevices. A loop-back test of the selected sound devices can be performed using TT_StartSoundLoopbackTest.
Be aware that the sound devices might fail if e.g. a USB sound device is unplugged while the client is talking in a channel. In this case ensure the application is processing the errors INTERR_SNDINPUT_FAILURE and INTERR_SNDOUTPUT_FAILURE in the WM_TEAMTALK_INTERNAL_ERROR event.
Read section Audio and Video Transmission to see how to transmit recorded audio to other users.
#define TT_SAMPLERATES_MAX 16 |
The maximum number of sample rates supported by a SoundDevice.
typedef enum SoundSystem SoundSystem |
The supported sound systems.
typedef struct SoundDevice SoundDevice |
A struct containing the properties of a sound device for either playback or recording.
Use nDeviceID to pass to TT_InitSoundInputDevice or TT_InitSoundOutputDevice.
Note that the nDeviceID may change if the user application is restarted and a new sound device is added or removed from the computer.
typedef enum SoundLevel SoundLevel |
An enum encapsulation the minimum, maximum and default sound levels for input and output sound devices.
typedef enum AudioFileStatus AudioFileStatus |
Status of audio files being written to disk.
typedef enum AudioFileFormat AudioFileFormat |
Audio file formats supported for muxed audio recordings.
typedef struct AudioBlock AudioBlock |
An audio block containing the raw audio from a user who was talking.
To enable audio blocks first call TT_EnableAudioBlockEvent() then whenever new audio is played the event WM_TEAMTALK_USER_AUDIOBLOCK is generated. Use TT_AcquireUserAudioBlock() to retrieve the audio block.
Note that each user is limited to 128 kbytes of audio data.
typedef struct AudioFormat AudioFormat |
Struct describing the audio format used by a media file.
enum SoundSystem |
The supported sound systems.
Enumerator | |
---|---|
SOUNDSYSTEM_NONE |
Sound system denoting invalid or not found. |
SOUNDSYSTEM_WINMM |
Windows legacy audio system. Should be used on Windows Mobile. |
SOUNDSYSTEM_DSOUND |
DirectSound audio system. Should be used on Windows 2K/XP. |
SOUNDSYSTEM_ALSA |
Advanced Linux Sound Architecture (ALSA). Should be used on Linux. Often ALSA sound devices only support a limited number of sample rates so TeamTalk internally use software filters to resample the audio to the sample rate used by the selected audio codecs. |
SOUNDSYSTEM_COREAUDIO |
Core Audio. Should be used on MacOS. |
SOUNDSYSTEM_WASAPI |
Windows Audio Session API (WASAPI). Should be used on Windows Vista/7. WASAPI audio devices typically only support a single sample rate so internally TeamTalk uses software filters to resample audio to the sample rate used by the selected audio codecs. Check |
enum SoundLevel |
An enum encapsulation the minimum, maximum and default sound levels for input and output sound devices.
Enumerator | |
---|---|
SOUND_VU_MAX |
The maximum value of recorded audio. |
SOUND_VU_MIN |
The minimum value of recorded audio. |
SOUND_VOLUME_MAX |
The maximum volume for master volume. To gain the volume level using software call TT_SetUserGainLevel. |
SOUND_VOLUME_MIN |
The minimum volume for master volume. |
SOUND_GAIN_MAX |
The maximum gain level. A gain level of 32000 gains the volume by a factor 32. A gain level of SOUND_GAIN_DEFAULT means no gain. |
SOUND_GAIN_DEFAULT |
The default gain level. A gain level of 1000 means no gain. Check SOUND_GAIN_MAX and SOUND_GAIN_MIN to see how to increase and lower gain level. |
SOUND_GAIN_MIN |
The minimum gain level (since it's zero it means silence). A gain level of 100 is 1/10 of the default volume. |
enum AudioFileStatus |
Status of audio files being written to disk.
Enumerator | |
---|---|
AFS_ERROR |
Error while processing audio file. |
AFS_STARTED |
Started processing audio file. |
AFS_FINISHED |
Finished processing audio file. |
AFS_ABORTED |
Aborted processing of audio file. |
enum AudioFileFormat |
Audio file formats supported for muxed audio recordings.
Enumerator | |
---|---|
AFF_NONE |
Used to denote nothing selected. |
AFF_WAVE_FORMAT |
Store in 16-bit wave format. |
AFF_MP3_64KBIT_FORMAT |
Store in MP3-format. This requires lame_enc.dll to be in the same directory as the application's execuable. The LAME DLLs can be obtained from http://lame.sourceforge.net. Note that the MP3-format is subject to licensing by Fraunhofer and Thomson Multimedia. |
AFF_MP3_128KBIT_FORMAT |
|
AFF_MP3_256KBIT_FORMAT |
|
AFF_MP3_16KBIT_FORMAT |
|
AFF_MP3_32KBIT_FORMAT |
|
TEAMTALKDLL_API BOOL TT_GetDefaultSoundDevices | ( | IN TTInstance * | lpTTInstance, |
OUT INT32 * | lpnInputDeviceID, | ||
OUT INT32 * | lpnOutputDeviceID | ||
) |
Get the default sound devices.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
lpnInputDeviceID | The ID of the default input device. |
lpnOutputDeviceID | The ID of the default output device. |
TEAMTALKDLL_API BOOL TT_GetDefaultSoundDevicesEx | ( | IN SoundSystem | nSndSystem, |
OUT INT32 * | lpnInputDeviceID, | ||
OUT INT32 * | lpnOutputDeviceID | ||
) |
Get the default sound devices for the specified sound system.
TEAMTALKDLL_API BOOL TT_GetSoundInputDevices | ( | IN TTInstance * | lpTTInstance, |
IN OUT SoundDevice * | lpSoundDevices, | ||
IN OUT INT32 * | lpnHowMany | ||
) |
Get information about input devices for audio recording.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
lpSoundDevices | Array of SoundDevice-structs where lpnHowMany holds the size of the array. Pass NULL as lpSoundDevices to query the number of devices. |
lpnHowMany | This is both an input and an output parameter. If lpSoundDevices is NULL lpnHowMany will after the call hold the number of devices, otherwise it should hold the size of the lpSoundDevices array. |
TEAMTALKDLL_API BOOL TT_GetSoundOutputDevices | ( | IN TTInstance * | lpTTInstance, |
IN OUT SoundDevice * | lpSoundDevices, | ||
IN OUT INT32 * | lpnHowMany | ||
) |
Get the list of sound output devices for playback.
The nDeviceID of the SoundDevice struct should be passed to TT_InitSoundOutputDevice.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
lpSoundDevices | Array of SoundDevice-structs where lpnHowMany holds the size of the array. Pass NULL as lpSoundDevices to query the number of devices. |
lpnHowMany | This is both an input and an output parameter. If lpSoundDevices is NULL lpnHowMany will after the call hold the number of devices, otherwise it should hold the size of the lpSoundDevices array. |
TEAMTALKDLL_API BOOL TT_InitSoundInputDevice | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nInputDeviceID | ||
) |
Initialize the sound input devices (for recording audio).
The nDeviceID of the SoundDevice should be used as nInputDeviceID.
Callling this function will set the flag CLIENT_SNDINPUT_READY.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nInputDeviceID | The nDeviceID of SoundDevice extracted through TT_GetSoundInputDevices. |
TEAMTALKDLL_API BOOL TT_InitSoundOutputDevice | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nOutputDeviceID | ||
) |
Initialize the sound output devices (for sound playback).
The nDeviceID of the SoundDevice should be used as nOutputDeviceID.
Callling this function will set the flag CLIENT_SNDOUTPUT_READY.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nOutputDeviceID | The nDeviceID of SoundDevice extracted through TT_GetSoundOutputDevices. |
TEAMTALKDLL_API BOOL TT_InitSoundDuplexDevices | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nInputDeviceID, | ||
IN INT32 | nOutputDeviceID | ||
) |
Enable duplex mode where multiple audio streams are mixed into a single stream using software.
Duplex mode can ONLY be enabled on sound devices which support the same sample rate. Sound systems SOUNDSYSTEM_WASAPI and SOUNDSYSTEM_ALSA typically only support a single sample rate. Check supportedSampleRates
in SoundDevice to see which sample rates are supported.
Sound duplex mode is required for echo cancellation since sound input and output device must be synchronized. Also sound cards which does not support multiple output streams should use duplex mode.
If TT_InitSoundDuplexDevices() is successful the following flags will be set:
Call TT_CloseSoundDuplexDevices() to shut down duplex mode.
Note that it is only the audio streams from users in the local client instance's current channel which will be mixed. If the local client instance calls TT_DoSubscribe() with SUBSCRIBE_INTERCEPT_AUDIO on a user in another channel then the audio from this user will be started in a separate stream. The reason for this is that the other user may use a different audio codec.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nInputDeviceID | The nDeviceID of SoundDevice extracted through TT_GetSoundInputDevices. |
nOutputDeviceID | The nDeviceID of SoundDevice extracted through TT_GetSoundOutputDevices. |
TEAMTALKDLL_API BOOL TT_CloseSoundInputDevice | ( | IN TTInstance * | lpTTInstance | ) |
Shutdown the input sound device.
Callling this function will clear the flag CLIENT_SNDINPUT_READY.
If the local client instance is running in duplex mode (flag CLIENT_SNDINOUTPUT_DUPLEX is set) then trying to close the sound device will fail since duplex mode require that both input and output sound devices are active at the same time. Therefore in order to close sound devices running in duplex mode call TT_CloseSoundDuplexDevices().
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_CloseSoundOutputDevice | ( | IN TTInstance * | lpTTInstance | ) |
Shutdown the output sound device.
Callling this function will clear set the flag CLIENT_SNDOUTPUT_READY.
If the local client instance is running in duplex mode (flag CLIENT_SNDINOUTPUT_DUPLEX is set) then trying to close the sound device will fail since duplex mode require that both input and output sound devices are active at the same time. Therefore in order to close sound devices running in duplex mode call TT_CloseSoundDuplexDevices().
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_CloseSoundDuplexDevices | ( | IN TTInstance * | lpTTInstance | ) |
Shut down sound devices running in duplex mode.
Calling this function only applies if sound devices has been initialized with TT_InitSoundDuplexDevices().
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_RestartSoundSystem | ( | ) |
Reinitialize sound system (in order to detect new/removed devices).
When the TeamTalk client is first initialized all the sound devices are detected and stored in a list inside the client instance. If a user adds or removes e.g. a USB sound device then it's not picked up automatically by the client instance. TT_RestartSoundSystem() can be used to reinitialize the sound system and thereby detect if sound devices have been removed or added.
In order to restart the sound system all sound devices in all client instances must be closed using TT_CloseSoundInputDevice(), TT_CloseSoundoutputDevice() and TT_CloseSoundDuplexDevices().
TEAMTALKDLL_API BOOL TT_StartSoundLoopbackTest | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nInputDeviceID, | ||
IN INT32 | nOutputDeviceID, | ||
IN INT32 | nSampleRate, | ||
IN INT32 | nChannels | ||
) |
Perform a record and playback test of specified sound devices.
Call TT_StopSoundLoopbackTest() to stop the loopback test.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nInputDeviceID | Should be the nDeviceID extracted through TT_GetSoundInputDevices. |
nOutputDeviceID | Should be the nDeviceID extracted through TT_GetSoundOutputDevices. |
nSampleRate | The sample rate the client's recorder should use. |
nChannels | Number of channels to use, i.e. 1 = mono, 2 = stereo Note that echo cancellation, denoising and AGC is not supported in stereo. |
TEAMTALKDLL_API BOOL TT_StartSoundLoopbackTestEx | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nInputDeviceID, | ||
IN INT32 | nOutputDeviceID, | ||
IN INT32 | nSampleRate, | ||
IN INT32 | nChannels, | ||
IN const AudioConfig * | lpAudioConfig, | ||
IN BOOL | bEchoCancel | ||
) |
Perform a record and playback test of specified sound devices along with an audio configuration and ability to try echo cancellation.
Both input and output devices MUST support the specified sample rate since this loop back test uses duplex mode (
supportedSampleRates
of SoundDevice to see which sample rates are supported.Call TT_StopSoundLoopbackTest() to stop the loopback test.
This function is almost like TT_StartSoundLoopbackTest() except that it allows the use of AudioConfig to enable AGC and echo cancellation. Note that AGC and echo cancellation can only be used in mono, i.e. nChannels
= 1.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nInputDeviceID | Should be the nDeviceID extracted through TT_GetSoundInputDevices. |
nOutputDeviceID | Should be the nDeviceID extracted through TT_GetSoundOutputDevices. |
nSampleRate | The sample rate the client's recorder should use. |
nChannels | Number of channels to use, i.e. 1 = mono, 2 = stereo. Note that echo cancellation, denoising and AGC is not supported in stereo. |
lpAudioConfig | The audio configuration to use, i.e. AGC and denoising properties. |
bEchoCancel | Whether to enable echo cancellation. |
TEAMTALKDLL_API BOOL TT_StopSoundLoopbackTest | ( | IN TTInstance * | lpTTInstance | ) |
Stop recorder and playback test.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API INT32 TT_GetSoundInputLevel | ( | IN TTInstance * | lpTTInstance | ) |
Get the volume level of the current recorded audio.
The current level is updated at an interval specified in a channel's AudioCodec.
Note that the volume level will not be available until the client instance joins a channel, i.e. it knows what sample rate to use.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_SetSoundInputGainLevel | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nLevel | ||
) |
Set voice gaining of recorded audio.
The gain level ranges from SOUND_GAIN_MIN to SOUND_GAIN_MAX where SOUND_GAIN_DEFAULT is no gain. So 100 is 1/10 of the original volume and 8000 is 8 times the original volume.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nLevel | A value from SOUND_GAIN_MIN to SOUND_GAIN_MAX. |
TEAMTALKDLL_API INT32 TT_GetSoundInputGainLevel | ( | IN TTInstance * | lpTTInstance | ) |
Get voice gain level of outgoing audio.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_SetSoundOutputVolume | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nVolume | ||
) |
Set master volume.
If still not loud enough use TT_SetUserGainLevel.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nVolume | A value from SOUND_VOLUME_MIN to SOUND_VOLUME_MAX. |
TEAMTALKDLL_API INT32 TT_GetSoundOutputVolume | ( | IN TTInstance * | lpTTInstance | ) |
Get master volume.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_SetSoundOutputMute | ( | IN TTInstance * | lpTTInstance, |
IN BOOL | bMuteAll | ||
) |
Set all users mute.
To stop receiving audio from a user call TT_DoUnsubscribe.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
bMuteAll | Whether to mute or unmute all users. |
TEAMTALKDLL_API BOOL TT_EnableDenoising | ( | IN TTInstance * | lpTTInstance, |
IN BOOL | bEnable | ||
) |
Enable denoising of recorded audio.
This call will enable/disable the CLIENT_SNDINPUT_DENOISING flag. Denoising will not be active if the local client instance is participating in a channel which uses a stereo AudioCodec.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
bEnable | TRUE to enable, otherwise FALSE. |
TEAMTALKDLL_API BOOL TT_SetDenoiseLevel | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nLevel | ||
) |
Set the denoise level of recorded audio.
Setting denoise level is only valid if TT_GetFlags() contains CLIENT_SNDINPUT_DENOISING.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nLevel | Maximum attenuation of the noise in dB. Negative value! Default value is -15. |
TEAMTALKDLL_API INT32 TT_GetDenoiseLevel | ( | IN TTInstance * | lpTTInstance | ) |
Set the denoise level of recorded audio.
Getting denoise level is only valid if TT_GetFlags() contains CLIENT_SNDINPUT_DENOISING.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_EnableEchoCancellation | ( | IN TTInstance * | lpTTInstance, |
IN BOOL | bEnable | ||
) |
Enable/disable acoustic echo cancellation (AEC).
In order to enable echo cancellation mode the local client instance must first be set in sound duplex mode by calling TT_InitSoundDuplexDevices(). This is because the echo canceller must first mixed all audio streams into a single stream and have then run in synch with the input stream. After calling TT_InitSoundDuplexDevices() the flag CLIENT_SNDINOUTPUT_DUPLEX will be set.
For echo cancellation to work the sound input and output device must be the same sound card since the input and output stream must be completely synchronized. Also it is recommended to also enable denoising and AGC for better echo cancellation by calling TT_EnableDenoising() and TT_EnableAGC() respectively. Using an AudioConfig on a Channel can also be use to automatically enable denoising and AGC.
Echo cancellation will not be active if the local client instance is participating in a channel which uses a stereo AudioCodec.
After calling TT_EnableEchoCancellation() the flag CLIENT_SNDINPUT_AEC will be set.
Note that Windows Mobile/CE doesn't support echo cancellation.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
bEnable | Whether to enable or disable echo callation. |
TEAMTALKDLL_API BOOL TT_EnableAGC | ( | IN TTInstance * | lpTTInstance, |
IN BOOL | bEnable | ||
) |
Enable Automatic Gain Control.
Each Channel can also be configured to automatically enable the local client instance to enable AGC by specifying the bEnableAGC member of AudioConfig.
AGC will not be active if the local client instance is participating in a channel which uses a stereo AudioCodec.
Note that Windows Mobile/CE doesn't support AGC.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
bEnable | Whether to enable AGC. |
TEAMTALKDLL_API BOOL TT_SetAGCSettings | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nGainLevel, | ||
IN INT32 | nMaxIncrement, | ||
IN INT32 | nMaxDecrement, | ||
IN INT32 | nMaxGain | ||
) |
Set Automatic Gain Control (AGC) settings.
Since microphone volumes may vary AGC can be used to adjust a signal to a reference volume. That way users will speak at the same volume level.
Calling TT_SetAGCSettings() is only valid if TT_GetFlags() contains CLIENT_SNDINPUT_AGC.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nGainLevel | A value from 0 to 32768. Default is 8000. |
nMaxIncrement | Used so volume should not be amplified too quickly (maximal gain increase in dB/second). Default is 12. |
nMaxDecrement | Negative value! Used so volume should not be attenuated too quickly (maximal gain decrease in dB/second). Default is -40. |
nMaxGain | Ensure volume doesn't become too loud (maximal gain in dB). Default is 30. |
TEAMTALKDLL_API BOOL TT_GetAGCSettings | ( | IN TTInstance * | lpTTInstance, |
OUT INT32 * | lpnGainLevel, | ||
OUT INT32 * | lpnMaxIncrement, | ||
OUT INT32 * | lpnMaxDecrement, | ||
OUT INT32 * | lpnMaxGain | ||
) |
Get Automatic Gain Control settings.
Calling TT_GetAGCSettings() is only valid if TT_GetFlags() contains CLIENT_SNDINPUT_AGC.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
lpnGainLevel | A value from 0 to 32768. |
lpnMaxIncrement | Used so volume should not be amplified too quickly (maximal gain increase in dB/second). |
lpnMaxDecrement | Negative value! Used so volume should not be attenuated too quickly (maximal gain decrease in dB/second). |
lpnMaxGain | Ensure volume doesn't become too loud (maximal gain in dB). |
TEAMTALKDLL_API BOOL TT_Enable3DSoundPositioning | ( | IN TTInstance * | lpTTInstance, |
IN BOOL | bEnable | ||
) |
Enable automatically position users using 3D-sound.
Note that 3d-sound does not work if sound is running in duplex mode (CLIENT_SNDINOUTPUT_DUPLEX).
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
bEnable | TRUE to enable, otherwise FALSE. |
TEAMTALKDLL_API BOOL TT_AutoPositionUsers | ( | IN TTInstance * | lpTTInstance | ) |
Automatically position users using 3D-sound.
Note that 3d-sound does not work if sound is running in duplex mode (CLIENT_SNDINOUTPUT_DUPLEX).
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
TEAMTALKDLL_API BOOL TT_EnableAudioBlockEvent | ( | IN TTInstance * | lpTTInstance, |
IN BOOL | bEnable | ||
) |
Enable/disable access to user's raw audio.
With audio block event enabled all audio which has been played will be accessible by calling TT_AcquireUserAudioBlock(). Every time a new AudioBlock is available the event WM_TEAMTALK_USER_AUDIOBLOCK is generated.
TEAMTALKDLL_API BOOL TT_SetUserVolume | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN INT32 | nVolume | ||
) |
Set the volume of a user.
Note that it's a virtual volume which is being set since the master volume affects the user volume.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The ID of the user whose volume will be changed. |
nVolume | Must be between SOUND_VOLUME_MIN and SOUND_VOLUME_MAX. |
TEAMTALKDLL_API INT32 TT_GetUserVolume | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID | ||
) |
Get the volume of a user.
Note that it's a virtual volume which is being set since the master volume affects the user volume.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The ID of the user. |
TEAMTALKDLL_API BOOL TT_SetUserGainLevel | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN INT32 | nGainLevel | ||
) |
Use software to gain a user's volume.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The ID of the user who should have sound gained. |
nGainLevel | The gain level for the user. A value from SOUND_GAIN_MIN to SOUND_GAIN_MAX |
TEAMTALKDLL_API INT32 TT_GetUserGainLevel | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID | ||
) |
Get the software gain level for a user.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The ID of the user whose gain level should be retrieved. |
TEAMTALKDLL_API BOOL TT_SetUserMute | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN BOOL | bMute | ||
) |
Mute a user.
To stop receiving audio from a user call TT_DoUnsubscribe with SUBSCRIBE_AUDIO.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The user ID of the user to mute (or unmute). |
bMute | TRUE will mute, FALSE will unmute. |
TEAMTALKDLL_API BOOL TT_SetUserStoppedTalkingDelay | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN INT32 | nDelayMSec | ||
) |
Set the delay of when a user should be considered to no longer be talking.
When a user starts talking the WM_TEAMTALK_USER_TALKING is triggered with its parameter set to active. A user will remain in this active state until no packets are received from this user, plus a delay (due to network interruptions). This delay is by default set to 500 msec but can be changed by calling TT_SetUserStoppedTalkingDelay().
TEAMTALKDLL_API INT32 TT_GetUserStoppedTalkingDelay | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID | ||
) |
Get the delay of when a user should no longer be considered as talking.
TEAMTALKDLL_API BOOL TT_SetUserPosition | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN float | x, | ||
IN float | y, | ||
IN float | z | ||
) |
Set the position of a user.
This can only be done using DirectSound (SOUNDSYSTEM_DSOUND) and with sound duplex mode (CLIENT_SNDINOUTPUT_DUPLEX) disabled.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | ID of user. |
x | Distance in meters to user (left/right). |
y | Distance in meters to user (back/forward). |
z | Distance in meters to user (up/down). |
TEAMTALKDLL_API BOOL TT_GetUserPosition | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
OUT float * | x, | ||
OUT float * | y, | ||
OUT float * | z | ||
) |
Get a user's position.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | ID of user. |
x | Distance in meters to user (left/right). |
y | Distance in meters to user (back/forward). |
z | Distance in meters to user (up/down). |
TEAMTALKDLL_API BOOL TT_SetUserStereo | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN BOOL | bLeftSpeaker, | ||
IN BOOL | bRightSpeaker | ||
) |
Set whether a user should speak in the left, right or both speakers. This function only works if AudioCodec has been set to use stereo.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | ID of user. |
bLeftSpeaker | TRUE if user should be played in left speaker. |
bRightSpeaker | TRUE if user should be played in right speaker. |
TEAMTALKDLL_API BOOL TT_GetUserStereo | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
OUT BOOL * | lpbLeftSpeaker, | ||
OUT BOOL * | lpbRightSpeaker | ||
) |
Check what speaker a user is outputting to.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | ID of user. |
lpbLeftSpeaker | TRUE if playing in left speaker. |
lpbRightSpeaker | TRUE if playing in right speaker. |
TEAMTALKDLL_API BOOL TT_SetUserAudioFolder | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN const TTCHAR * | szFolderPath, | ||
IN const TTCHAR * | szFileNameVars, | ||
IN AudioFileFormat | uAFF | ||
) |
Store user's audio to disk.
Set the path of where to store audio from a user to disk. To store in MP3 format instead of .wav format ensure that the LAME MP3 encoder file lame_enc.dll is placed in the same directory as the SDKs DLL files. To stop recording set szFolderPath to an empty string and uAFF to AFF_NONE.
To store audio of users not in current channel of the client instance check out the section Spying on Users.
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The ID of the User which should store audio to disk. |
szFolderPath | The path on disk to where files should be stored. This value will be stored in szAudioFolder of User. |
szFileNameVars | The file name used for audio files can consist of the following variables: %nickname%, %username%, %userid%, %counter% and a specified time based on strftime (google 'strftime' for a description of the format. The default format used by TeamTalk is: '%Y%m%d-%H%M%S #%userid% %username%'. The %counter% variable is a 9 digit integer which is incremented for each audio file. The file extension is automatically appended based on the file type (.wav for AFF_WAVE_FORMAT and .mp3 for AFF_MP3_*_FORMAT). Pass NULL or empty string to revert to default format. |
uAFF | The AudioFileFormat to use for storing audio files. Passing AFF_NONE will cancel/reset the current recording. |
TEAMTALKDLL_API BOOL TT_SetUserMediaBufferSize | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
IN INT32 | nMSec | ||
) |
Change the amount of media data which can be buffered in the user's playback queue.
Increasing the media buffer size is especially important when the user is currently streaming a media file using TT_StartStreamingMediaFileToChannel(). Once streaming has finished it is recommended to reset the media buffer, i.e. setting it to zero.
A simple way to notify users that the client instance is streaming a media file is to change the status of the local client instance using TT_DoChangeStatus() or to send a TextMessage using TT_DoTextMessage().
lpTTInstance | Pointer to client instance created by TT_InitTeamTalk. |
nUserID | The ID of the user who should have changed the size of the media buffer. |
nMSec | The number of miliseconds of audio and video which should be allowed to be stored in the media buffer. 2000 - 3000 msec is a good size for a media buffer. Set the media buffer size to 0 msec to reset the media buffer to its default value. |
TEAMTALKDLL_API BOOL TT_AcquireUserAudioBlock | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID, | ||
OUT AudioBlock * | lpAudioBlock | ||
) |
Extract the raw audio from a user who has been talking.
To enable access to user's raw audio first call TT_EnableAudioBlockEvent(). Whenever new audio becomes available the event WM_TEAMTALK_USER_AUDIOBLOCK is generated and TT_AcquireUserAudioBlock() can be called to extract the audio.
The AudioBlock contains shared memory with the local client instance therefore always remember to call TT_ReleaseUserAudioBlock() to release the shared memory.
If TT_AcquireUserAudioBlock() is called multiple times without calling TT_ReleaseUserAudioBlock() then the same AudioBlock will be retrieved again.
TEAMTALKDLL_API BOOL TT_ReleaseUserAudioBlock | ( | IN TTInstance * | lpTTInstance, |
IN INT32 | nUserID | ||
) |
Release the shared memory of an AudioBlock.
All AudioBlock-structures extracted through TT_AcquireUserAudioBlock() must be released again since they share memory with the local client instance.
Never access lpRawAudio
after releasing its AudioBlock. This will cause the application to crash with a memory exception.
TEAMTALKDLL_API BOOL TT_ReleaseAllAudioBlocks | ( | IN TTInstance * | lpTTInstance | ) |
Release all audio blocks of the local client instance.
This function is only for convenience to ensure that no memory is leaked. Normally TT_ReleaseUserAudioBlock() should be used to release AudioBlock-data.