TeamTalk 4 .NET DLL
Version 4.5A
|
This section explains how to record and playback audio in the client instance. More...
Classes | |
struct | BearWare.SoundDevice |
A struct containing the properties of a sound device for either playback or recording. More... | |
struct | BearWare.SoundLevel |
An enum encapsulation the minimum, maximum and default sound levels for input and output sound devices. More... | |
struct | BearWare.AudioBlock |
An audio block containing the raw audio from a user who was talking. More... | |
struct | BearWare.AudioFormat |
Struct describing the audio format used by a media file. More... | |
Enumerations | |
enum | BearWare.SoundSystem : uint { BearWare.SOUNDSYSTEM_NONE = 0, BearWare.SOUNDSYSTEM_WINMM = 1, BearWare.SOUNDSYSTEM_DSOUND = 2, BearWare.SOUNDSYSTEM_ALSA = 3, BearWare.SOUNDSYSTEM_COREAUDIO = 4, BearWare.SOUNDSYSTEM_WASAPI = 5 } |
The supported sound systems. More... | |
enum | BearWare.AudioFileStatus : uint { BearWare.AFS_ERROR = 0, BearWare.AFS_STARTED = 1, BearWare.AFS_FINISHED = 2, BearWare.AFS_ABORTED = 3 } |
Status of audio files being written to disk. More... | |
enum | BearWare.AudioFileFormat : uint { BearWare.AFF_NONE = 0, BearWare.AFF_WAVE_FORMAT = 2, BearWare.AFF_MP3_64KBIT_FORMAT = 3, BearWare.AFF_MP3_128KBIT_FORMAT = 4, BearWare.AFF_MP3_256KBIT_FORMAT = 5, BearWare.AFF_MP3_16KBIT_FORMAT = 6, BearWare.AFF_MP3_32KBIT_FORMAT = 7 } |
Audio file formats supported for muxed audio recordings. More... | |
Functions | |
bool | BearWare.TeamTalk4.GetDefaultSoundDevices (out int lpnInputDeviceID, out int lpnOutputDeviceID) |
Get the default sound devices. More... | |
bool | BearWare.TeamTalk4.GetDefaultSoundDevicesEx (SoundSystem nSndSystem, out int lpnInputDeviceID, out int lpnOutputDeviceID) |
Get the default sound devices for the specified sound system. More... | |
bool | BearWare.TeamTalk4.GetSoundInputDevices (out SoundDevice[] lpSoundDevices) |
Get information about input devices for audio recording. More... | |
bool | BearWare.TeamTalk4.GetSoundOutputDevices (out SoundDevice[] lpSoundDevices) |
Get the list of sound output devices for playback. More... | |
bool | BearWare.TeamTalk4.InitSoundInputDevice (int nInputDeviceID) |
Initialize the sound input devices (for recording audio). More... | |
bool | BearWare.TeamTalk4.InitSoundOutputDevice (int nOutputDeviceID) |
Initialize the sound output devices (for sound playback). More... | |
bool | BearWare.TeamTalk4.InitSoundDuplexDevices (int nInputDeviceID, int nOutputDeviceID) |
Enable duplex mode where multiple audio streams are mixed into a single stream using software. More... | |
bool | BearWare.TeamTalk4.CloseSoundInputDevice () |
Shutdown the input sound device. More... | |
bool | BearWare.TeamTalk4.CloseSoundOutputDevice () |
Shutdown the output sound device. More... | |
bool | BearWare.TeamTalk4.CloseSoundDuplexDevices () |
Shut down sound devices running in duplex mode. More... | |
static bool | BearWare.TeamTalk4.RestartSoundSystem () |
Reinitialize sound system (in order to detect new/removed devices). More... | |
bool | BearWare.TeamTalk4.StartSoundLoopbackTest (int nInputDeviceID, int nOutputDeviceID, int nSampleRate, int nChannels) |
Perform a record and playback test of specified sound devices. More... | |
bool | BearWare.TeamTalk4.StartSoundLoopbackTestEx (int nInputDeviceID, int nOutputDeviceID, int nSampleRate, int nChannels, AudioConfig lpAudioConfig, bool bEchoCancel) |
Perform a record and playback test of specified sound devices along with an audio configuration and ability to try echo cancellation. More... | |
bool | BearWare.TeamTalk4.StopSoundLoopbackTest () |
Stop recorder and playback test. More... | |
int | BearWare.TeamTalk4.GetSoundInputLevel () |
Get the volume level of the current recorded audio. More... | |
bool | BearWare.TeamTalk4.SetSoundInputGainLevel (int nLevel) |
Set voice gaining of recorded audio. More... | |
int | BearWare.TeamTalk4.GetSoundInputGainLevel () |
Get voice gain level of outgoing audio. More... | |
bool | BearWare.TeamTalk4.SetSoundOutputVolume (int nVolume) |
Set master volume. More... | |
int | BearWare.TeamTalk4.GetSoundOutputVolume () |
Get master volume. More... | |
bool | BearWare.TeamTalk4.SetSoundOutputMute (bool bMuteAll) |
Set all users mute. More... | |
bool | BearWare.TeamTalk4.EnableDenoising (bool bEnable) |
Enable denoising of recorded audio. More... | |
bool | BearWare.TeamTalk4.SetDenoiseLevel (int nLevel) |
Set the denoise level of recorded audio. More... | |
int | BearWare.TeamTalk4.GetDenoiseLevel () |
Set the denoise level of recorded audio. More... | |
bool | BearWare.TeamTalk4.EnableEchoCancellation (bool bEnable) |
Enable/disable acoustic echo cancellation (AEC). More... | |
bool | BearWare.TeamTalk4.EnableAGC (bool bEnable) |
Enable Automatic Gain Control. More... | |
bool | BearWare.TeamTalk4.SetAGCSettings (int nGainLevel, int nMaxIncrement, int nMaxDecrement, int nMaxGain) |
Set Automatic Gain Control (AGC) settings. More... | |
bool | BearWare.TeamTalk4.GetAGCSettings (out int lpnGainLevel, out int lpnMaxIncrement, out int lpnMaxDecrement, out int lpnMaxGain) |
Get Automatic Gain Control settings. More... | |
bool | BearWare.TeamTalk4.Enable3DSoundPositioning (bool bEnable) |
Enable automatically position users using 3D-sound. More... | |
bool | BearWare.TeamTalk4.AutoPositionUsers () |
Automatically position users using 3D-sound. More... | |
bool | BearWare.TeamTalk4.EnableAudioBlockEvent (bool bEnable) |
Enable/disable access to user's raw audio. More... | |
bool | BearWare.TeamTalk4.SetUserVolume (int nUserID, int nVolume) |
Set the volume of a user. More... | |
int | BearWare.TeamTalk4.GetUserVolume (int nUserID) |
Get the volume of a user. More... | |
bool | BearWare.TeamTalk4.SetUserGainLevel (int nUserID, int nGainLevel) |
Use software to gain a user's volume. More... | |
int | BearWare.TeamTalk4.GetUserGainLevel (int nUserID) |
Get the software gain level for a user. More... | |
bool | BearWare.TeamTalk4.SetUserMute (int nUserID, bool bMute) |
Mute a user. More... | |
bool | BearWare.TeamTalk4.SetUserStoppedTalkingDelay (int nUserID, int nDelayMSec) |
Set the delay of when a user should be considered to no longer be talking. More... | |
int | BearWare.TeamTalk4.GetUserStoppedTalkingDelay (int nUserID) |
Get the delay of when a user should no longer be considered as talking. More... | |
bool | BearWare.TeamTalk4.SetUserPosition (int nUserID, float x, float y, float z) |
Set the position of a user. More... | |
bool | BearWare.TeamTalk4.GetUserPosition (int nUserID, out float x, out float y, out float z) |
Get a user's position. More... | |
bool | BearWare.TeamTalk4.SetUserStereo (int nUserID, bool bLeftSpeaker, bool bRightSpeaker) |
Set whether a user should speak in the left, right or both speakers. This function only works if BearWare.AudioCodec has been set to use stereo. More... | |
bool | BearWare.TeamTalk4.GetUserStereo (int nUserID, out bool lpbLeftSpeaker, out bool lpbRightSpeaker) |
Check what speaker a user is outputting to. More... | |
bool | BearWare.TeamTalk4.SetUserAudioFolder (int nUserID, string szFolderPath, string szFileNameVars, AudioFileFormat uAFF) |
Store audio conversations to disk. More... | |
bool | BearWare.TeamTalk4.SetUserMediaBufferSize (int nUserID, int nMSec) |
Change the amount of media data which can be buffered in the user's playback queue. More... | |
bool | BearWare.TeamTalk4.AcquireUserAudioBlock (int nUserID, ref AudioBlock lpAudioBlock) |
Extract the raw audio from a user who has been talking. More... | |
bool | BearWare.TeamTalk4.ReleaseUserAudioBlock (int nUserID) |
Release the shared memory of an BearWare.AudioBlock. More... | |
bool | BearWare.TeamTalk4.ReleaseAllUserAudioBlocks () |
Release all audio blocks of the local client instance. More... | |
Variables | |
const int | BearWare.TeamTalk4.TT_SAMPLERATES_MAX = 16 |
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 TeamTalk4.GetSoundInputDevices() and TeamTalk4.GetSoundOutputDevices(). These two functions return arrays of BearWare.SoundDevice-structs which contains a description of the sound device. In the BearWare.SoundDevice-struct there's a member variable called nDeviceID. This ID should be passed to the client instance's two sound initialization functions TeamTalk4.InitSoundInputDevice() and TeamTalk4.InitSoundOutputDevice(). Once this has been done the TeamTalk4.GetFlags() call will return a value containing the mask bits ClientFlag CLIENT_SNDINPUT_READY and ClientFlag CLIENT_SNDOUTPUT_READY.
A computer's default sound devices can be queried using TeamTalk4.GetDefaultSoundDevices(). A loop-back test of the selected sound devices can be performed using TeamTalk4.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 ClientError INTERR_SNDINPUT_FAILURE and ClientError INTERR_SNDOUTPUT_FAILURE in the TeamTalk4.OnInternalError() event.
Read section Audio and Video Transmission to see how to transmit recorded audio to other users.
enum BearWare.SoundSystem : uint |
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 BearWare.AudioFileStatus : uint |
enum BearWare.AudioFileFormat : uint |
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 |
|
bool BearWare.TeamTalk4.GetDefaultSoundDevices | ( | out int | lpnInputDeviceID, |
out int | lpnOutputDeviceID | ||
) |
Get the default sound devices.
lpnInputDeviceID | The ID of the default input device. |
lpnOutputDeviceID | The ID of the default output device. |
bool BearWare.TeamTalk4.GetDefaultSoundDevicesEx | ( | SoundSystem | nSndSystem, |
out int | lpnInputDeviceID, | ||
out int | lpnOutputDeviceID | ||
) |
Get the default sound devices for the specified sound system.
bool BearWare.TeamTalk4.GetSoundInputDevices | ( | out SoundDevice[] | lpSoundDevices | ) |
Get information about input devices for audio recording.
lpSoundDevices | An output array of BearWare.SoundDevice-structs which will receive the available sound input devices. |
bool BearWare.TeamTalk4.GetSoundOutputDevices | ( | out SoundDevice[] | lpSoundDevices | ) |
Get the list of sound output devices for playback.
The nDeviceID of the BearWare.SoundDevice struct should be passed to InitSoundOutputDevice.
lpSoundDevices | An output array of BearWare.SoundDevice-structs which will receive the available sound output devices. |
bool BearWare.TeamTalk4.InitSoundInputDevice | ( | int | nInputDeviceID | ) |
Initialize the sound input devices (for recording audio).
The nDeviceID of the BearWare.SoundDevice should be used as nInputDeviceID.
Calling this function will set the flag ClientFlag CLIENT_SNDINPUT_READY.
nInputDeviceID | The nDeviceID of BearWare.SoundDevice extracted through GetSoundInputDevices. |
bool BearWare.TeamTalk4.InitSoundOutputDevice | ( | int | nOutputDeviceID | ) |
Initialize the sound output devices (for sound playback).
The nDeviceID of the BearWare.SoundDevice should be used as nOutputDeviceID.
Callling this function will set the flag ClientFlag CLIENT_SNDOUTPUT_READY.
nOutputDeviceID | Should be the nDeviceID of BearWare.SoundDevice extracted through GetSoundOutputDevices(). |
bool BearWare.TeamTalk4.InitSoundDuplexDevices | ( | int | nInputDeviceID, |
int | 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 SOUNDSYSTEM_WASAPI and SoundSystem SOUNDSYSTEM_ALSA typically only support a single sample rate. Check supportedSampleRates
in BearWare.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 TeamTalk4.InitSoundDuplexDevices() is successful the following flags will be set:
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 stream should use duplex mode.
Call TeamTalk4.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 TeamTalk4.DoSubscribe() with Subscription 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.
nInputDeviceID | The nDeviceID of BearWare.SoundDevice extracted through GetSoundInputDevices(). |
nOutputDeviceID | The nDeviceID of BearWare.SoundDevice extracted through GetSoundOutputDevices(). |
bool BearWare.TeamTalk4.CloseSoundInputDevice | ( | ) |
Shutdown the input sound device.
Callling this function will clear the flag ClientFlag CLIENT_SNDINPUT_READY.
If the local client instance is running in duplex mode (flag ClientFlag 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 TeamTalk4.CloseSoundDuplexDevices().
bool BearWare.TeamTalk4.CloseSoundOutputDevice | ( | ) |
Shutdown the output sound device.
Callling this function will clear set the flag ClientFlag CLIENT_SNDOUTPUT_READY.
If the local client instance is running in duplex mode (flag ClientFlag 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 TeamTalk4.CloseSoundDuplexDevices().
bool BearWare.TeamTalk4.CloseSoundDuplexDevices | ( | ) |
Shut down sound devices running in duplex mode.
Calling this function only applies if sound devices has been initialized with TeamTalk4.InitSoundDuplexDevices().
|
static |
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().
bool BearWare.TeamTalk4.StartSoundLoopbackTest | ( | int | nInputDeviceID, |
int | nOutputDeviceID, | ||
int | nSampleRate, | ||
int | nChannels | ||
) |
Perform a record and playback test of specified sound devices.
Call StopSoundLoopbackTest() to stop the loopback test.
nInputDeviceID | Should be the nDeviceID extracted through GetSoundInputDevices. |
nOutputDeviceID | Should be the nDeviceID extracted through 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. |
bool BearWare.TeamTalk4.StartSoundLoopbackTestEx | ( | int | nInputDeviceID, |
int | nOutputDeviceID, | ||
int | nSampleRate, | ||
int | nChannels, | ||
AudioConfig | lpAudioConfig, | ||
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 BearWare.SoundDevice to see which sample rates are supported.Call TeamTalk4.StopSoundLoopbackTest() to stop the loopback test.
This function is almost like TeamTalk4.StartSoundLoopbackTest() except that it allows the use of BearWare.AudioConfig to enable AGC and echo cancellation. Note that AGC and echo cancellation can only be used in mono, i.e. nChannels
= 1.
nInputDeviceID | Should be the nDeviceID extracted through TeamTalk4.GetSoundInputDevices(). |
nOutputDeviceID | Should be the nDeviceID extracted through TeamTalk4.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. |
bool BearWare.TeamTalk4.StopSoundLoopbackTest | ( | ) |
Stop recorder and playback test.
int BearWare.TeamTalk4.GetSoundInputLevel | ( | ) |
Get the volume level of the current recorded audio.
The current level is updated at an interval specified in a channel's BearWare.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.
bool BearWare.TeamTalk4.SetSoundInputGainLevel | ( | int | nLevel | ) |
Set voice gaining of recorded audio.
The gain level ranges from BearWare.SoundLevel.SOUND_GAIN_MIN to BearWare.SoundLevel.SOUND_GAIN_MAX where BearWare.SoundLevel.SOUND_GAIN_DEFAULT is no gain. So 100 is 1/10 of the original volume and 8000 is 8 times the original volume.
nLevel | A value from BearWare.SoundLevel.SOUND_GAIN_MIN to BearWare.SoundLevel.SOUND_GAIN_MAX. |
int BearWare.TeamTalk4.GetSoundInputGainLevel | ( | ) |
Get voice gain level of outgoing audio.
bool BearWare.TeamTalk4.SetSoundOutputVolume | ( | int | nVolume | ) |
Set master volume.
If still not loud enough use SetUserGainLevel().
nVolume | A value from BearWare.SoundLevel.SOUND_VOLUME_MIN to BearWare.SoundLevel.SOUND_VOLUME_MAX. |
int BearWare.TeamTalk4.GetSoundOutputVolume | ( | ) |
Get master volume.
bool BearWare.TeamTalk4.SetSoundOutputMute | ( | bool | bMuteAll | ) |
Set all users mute.
To stop receiving audio from a user call DoUnsubscribe().
bMuteAll | Whether to mute or unmute all users. |
bool BearWare.TeamTalk4.EnableDenoising | ( | bool | bEnable | ) |
Enable denoising of recorded audio.
This call will enable/disable the ClientFlag CLIENT_SNDINPUT_DENOISING flag. Denoising will not be active if the local client instance is participating in a channel which uses a stereo BearWare.AudioCodec.
bEnable | TRUE to enable, otherwise FALSE. |
bool BearWare.TeamTalk4.SetDenoiseLevel | ( | int | nLevel | ) |
Set the denoise level of recorded audio.
Setting denoise level is only valid if TeamTalk4.GetFlags() contains ClientFlag CLIENT_SNDINPUT_DENOISING.
nLevel | Maximum attenuation of the noise in dB. Negative value! Default value is -15. |
int BearWare.TeamTalk4.GetDenoiseLevel | ( | ) |
Set the denoise level of recorded audio.
Getting denoise level is only valid if TeamTalk4.GetFlags() contains ClientFlag CLIENT_SNDINPUT_DENOISING.
bool BearWare.TeamTalk4.EnableEchoCancellation | ( | 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 TeamTalk4.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 TeamTalk4.InitSoundDuplexDevices() the flag ClientFlag 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 TeamTalk4.EnableDenoising() and TeamTalk4.EnableAGC() respectively. Using an BearWare.AudioConfig on a BearWare.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 BearWare.AudioCodec.
After calling TeamTalk4.EnableEchoCancellation() the flag ClientFlag CLIENT_SNDINPUT_AEC will be set.
Note that Windows Mobile/CE doesn't support echo cancellation.
bEnable | Whether to enable or disable echo callation. |
bool BearWare.TeamTalk4.EnableAGC | ( | bool | bEnable | ) |
Enable Automatic Gain Control.
Each BearWare.Channel can also be configured to automatically enable the local client instance to enable AGC by specifying the bEnableAGC member of BearWare.AudioConfig.
AGC will not be active if the local client instance is participating in a channel which uses a stereo BearWare.AudioCodec.
Note that Windows Mobile/CE doesn't support AGC.
bEnable | Whether to enable AGC. |
bool BearWare.TeamTalk4.SetAGCSettings | ( | int | nGainLevel, |
int | nMaxIncrement, | ||
int | nMaxDecrement, | ||
int | 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 TeamTalk4.SetAGCSettings() is only valid if TeamTalk4.GetFlags() contains ClientFlag CLIENT_SNDINPUT_AGC.
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. |
bool BearWare.TeamTalk4.GetAGCSettings | ( | out int | lpnGainLevel, |
out int | lpnMaxIncrement, | ||
out int | lpnMaxDecrement, | ||
out int | lpnMaxGain | ||
) |
Get Automatic Gain Control settings.
Calling TeamTalk4.GetAGCSettings() is only valid if TeamTalk4.GetFlags() contains ClientFlag CLIENT_SNDINPUT_AGC.
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). |
bool BearWare.TeamTalk4.Enable3DSoundPositioning | ( | bool | bEnable | ) |
Enable automatically position users using 3D-sound.
Note that 3d-sound does not work if sound is running in duplex mode (ClientFlag CLIENT_SNDINOUTPUT_DUPLEX).
bEnable | TRUE to enable, otherwise FALSE. |
bool BearWare.TeamTalk4.AutoPositionUsers | ( | ) |
Automatically position users using 3D-sound.
Note that 3d-sound does not work if sound is running in duplex mode (ClientFlag CLIENT_SNDINOUTPUT_DUPLEX).
bool BearWare.TeamTalk4.EnableAudioBlockEvent | ( | bool | bEnable | ) |
Enable/disable access to user's raw audio.
With audio callbacks enabled all audio which has been played will be accessible by calling TeamTalk4.AcquireUserAudioBlock(). Every time a new BearWare.AudioBlock is available the event OnUserAudioBlock() is generated.
bool BearWare.TeamTalk4.SetUserVolume | ( | int | nUserID, |
int | 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.
nUserID | The ID of the user whose volume will be changed. |
nVolume | Must be between BearWare.SoundLevel.SOUND_VOLUME_MIN and BearWare.SoundLevel.SOUND_VOLUME_MAX. |
int BearWare.TeamTalk4.GetUserVolume | ( | int | 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.
nUserID | The ID of the user. |
bool BearWare.TeamTalk4.SetUserGainLevel | ( | int | nUserID, |
int | nGainLevel | ||
) |
Use software to gain a user's volume.
nUserID | The ID of the user who should have sound gained. |
nGainLevel | The gain level for the user. A value from BearWare.SoundLevel.SOUND_GAIN_MIN to BearWare.SoundLevel.SOUND_GAIN_MAX |
int BearWare.TeamTalk4.GetUserGainLevel | ( | int | nUserID | ) |
Get the software gain level for a user.
nUserID | The ID of the user whose gain level should be retrieved. |
bool BearWare.TeamTalk4.SetUserMute | ( | int | nUserID, |
bool | bMute | ||
) |
Mute a user.
To stop receiving audio from a user call TeamTalk4.DoUnsubscribe().
nUserID | The user ID of the user to mute (or unmute). |
bMute | TRUE will mute, FALSE will unmute. |
bool BearWare.TeamTalk4.SetUserStoppedTalkingDelay | ( | int | nUserID, |
int | nDelayMSec | ||
) |
Set the delay of when a user should be considered to no longer be talking.
When a user starts talking the TeamTalk4.OnUserTalking() 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 TeamTalk4.SetUserStoppedTalkingDelay().
int BearWare.TeamTalk4.GetUserStoppedTalkingDelay | ( | int | nUserID | ) |
Get the delay of when a user should no longer be considered as talking.
bool BearWare.TeamTalk4.SetUserPosition | ( | int | nUserID, |
float | x, | ||
float | y, | ||
float | z | ||
) |
Set the position of a user.
This can only be done using DirectSound (SoundSystem SOUNDSYSTEM_DSOUND) and with sound duplex mode (ClientFlag CLIENT_SNDINOUTPUT_DUPLEX) disabled.
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). |
bool BearWare.TeamTalk4.GetUserPosition | ( | int | nUserID, |
out float | x, | ||
out float | y, | ||
out float | z | ||
) |
Get a user's position.
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). |
bool BearWare.TeamTalk4.SetUserStereo | ( | int | nUserID, |
bool | bLeftSpeaker, | ||
bool | bRightSpeaker | ||
) |
Set whether a user should speak in the left, right or both speakers. This function only works if BearWare.AudioCodec has been set to use stereo.
nUserID | ID of user. |
bLeftSpeaker | TRUE if user should be played in left speaker. |
bRightSpeaker | TRUE if user should be played in right speaker. |
bool BearWare.TeamTalk4.GetUserStereo | ( | int | nUserID, |
out bool | lpbLeftSpeaker, | ||
out bool | lpbRightSpeaker | ||
) |
Check what speaker a user is outputting to.
nUserID | ID of user. |
lpbLeftSpeaker | TRUE if playing in left speaker. |
lpbRightSpeaker | TRUE if playing in right speaker. |
bool BearWare.TeamTalk4.SetUserAudioFolder | ( | int | nUserID, |
string | szFolderPath, | ||
string | szFileNameVars, | ||
AudioFileFormat | uAFF | ||
) |
Store audio conversations to disk.
Set the path of where to store audio from a channel 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 AudioFileFormat AFF_NONE.
To store audio of other channels than the client instance check out the section Spying on Users.
nUserID | The ID of the BearWare.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 BearWare.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 AudioFileFormat 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 AudioFileFormat AFF_NONE will cancel/reset the current recording. |
bool BearWare.TeamTalk4.SetUserMediaBufferSize | ( | int | nUserID, |
int | 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 TeamTalk4.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 TeamTalk4.DoChangeStatus() or to send a BearWare.TextMessage using TeamTalk4.DoTextMessage().
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. |
bool BearWare.TeamTalk4.AcquireUserAudioBlock | ( | int | nUserID, |
ref AudioBlock | lpAudioBlock | ||
) |
Extract the raw audio from a user who has been talking.
To enable access to user's raw audio first call TeamTalk4.EnableAudioBlockEvent(). Whenever new audio becomes available the event TeamTalk4.OnUserAudioBlock() is generated and TeamTalk4.AcquireUserAudioBlock() can be called to extract the audio.
The BearWare.AudioBlock contains shared memory with the local client instance therefore always remember to call TeamTalk4.ReleaseUserAudioBlock() to release the shared memory.
If TeamTalk4.AcquireUserAudioBlock() is called multiple times without calling TeamTalk4.ReleaseUserAudioBlock() then the same BearWare.AudioBlock will be retrieved again.
bool BearWare.TeamTalk4.ReleaseUserAudioBlock | ( | int | nUserID | ) |
Release the shared memory of an BearWare.AudioBlock.
All BearWare.AudioBlock-structures extracted through TeamTalk4.AcquireUserAudioBlock() must be released again since they share memory with the local client instance.
Never access lpRawAudio
after releasing its BearWare.AudioBlock. This will cause the application to crash with a memory exception.
bool BearWare.TeamTalk4.ReleaseAllUserAudioBlocks | ( | ) |
Release all audio blocks of the local client instance.
This function is only for convenience to ensure that no memory is leaked. Normally TeamTalk4.ReleaseUserAudioBlock() should be used to release BearWare.AudioBlock-data.
const int BearWare.TeamTalk4.TT_SAMPLERATES_MAX = 16 |
The maximum number of sample rates supported by a BearWare.SoundDevice.