TeamTalk 5 C-API DLL: SoundDevice Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
SoundDevice Struct Reference
Sound Capture and Playback

A struct containing the properties of a sound device for either playback or recording. More...

`#include <TeamTalk.h>`

## Public Attributes

INT32 | nDeviceID
| The ID of the sound device. Used for passing to TT_InitSoundInputDevice and TT_InitSoundOutputDevice. Note that nDeviceID might change if USB sound devices are plugged in or unplugged, therefore use szDeviceID to ensure proper device is used.
SoundSystem | nSoundSystem
| The sound system used by the sound device.
TTCHAR | szDeviceName [TT_STRLEN]
| The name of the sound device.
TTCHAR | szDeviceID [TT_STRLEN]
| An identifier uniquely identifying the sound device even when new sound devices are being added and removed. In DirectSound, WASAPI and WinMM it would be the GUID of the sound device. Note that it may not always be available.
INT32 | nWaveDeviceID
| A Windows specific ID to the sound device.
TTBOOL | bSupports3D
| Whether the sound device supports 3D-sound effects.
INT32 | nMaxInputChannels
| The maximum number of input channels.
INT32 | nMaxOutputChannels
| The maximum number of output channels.
INT32 | inputSampleRates [TT_SAMPLERATES_MAX]
| Supported sample rates by device for recording. A zero value terminates the list of supported sample rates or its maximum size of TT_SAMPLERATES_MAX.
INT32 | outputSampleRates [TT_SAMPLERATES_MAX]
| Supported sample rates by device for playback. A zero value terminates the list of supported sample rates or its maximum size of TT_SAMPLERATES_MAX.
INT32 | nDefaultSampleRate
| The default sample rate for the sound device.
SoundDeviceFeatures | uSoundDeviceFeatures
| Additional features available for this sound device. The sound device features can be used to enable additional features on the sound device.

## Detailed Description

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.

See also
  TT_GetSoundDevices

Definition at line 403 of file TeamTalk.h.

## Member Data Documentation

## ◆ nDeviceID

INT32 SoundDevice::nDeviceID

The ID of the sound device. Used for passing to TT_InitSoundInputDevice and TT_InitSoundOutputDevice. Note that nDeviceID might change if USB sound devices are plugged in or unplugged, therefore use szDeviceID to ensure proper device is used.

Definition at line 410 of file TeamTalk.h.

## ◆ nSoundSystem

SoundSystem SoundDevice::nSoundSystem

The sound system used by the sound device.

Definition at line 412 of file TeamTalk.h.

## ◆ szDeviceName

TTCHAR SoundDevice::szDeviceName[TT_STRLEN]

The name of the sound device.

Definition at line 414 of file TeamTalk.h.

## ◆ szDeviceID

TTCHAR SoundDevice::szDeviceID[TT_STRLEN]

An identifier uniquely identifying the sound device even when new sound devices are being added and removed. In DirectSound, WASAPI and WinMM it would be the GUID of the sound device. Note that it may not always be available.

Definition at line 419 of file TeamTalk.h.

## ◆ nWaveDeviceID

INT32 SoundDevice::nWaveDeviceID

A Windows specific ID to the sound device.

For DirectSound and WinMM this is the ID of the device used in Win32's waveInGetDevCaps and waveOutGetDevCaps. Value will be -1 if no ID could be found This ID can also be used to find the corresponding mixer on Windows passing it as nWaveDeviceID. Note that this ID applies both to DirectSound and WinMM.

For WASAPI this ID is the index of IMMDeviceEnumerator::EnumAudioEndpoints()

See also
  TT_Mixer_GetWaveInName
  TT_Mixer_GetWaveOutName
  TT_Mixer_GetMixerCount

Definition at line 436 of file TeamTalk.h.

## ◆ bSupports3D

TTBOOL SoundDevice::bSupports3D

Whether the sound device supports 3D-sound effects.

Deprecated
  Use SOUNDDEVICEFEATURE_3DPOSITION.

Definition at line 439 of file TeamTalk.h.

## ◆ nMaxInputChannels

INT32 SoundDevice::nMaxInputChannels

The maximum number of input channels.

Definition at line 441 of file TeamTalk.h.

## ◆ nMaxOutputChannels

INT32 SoundDevice::nMaxOutputChannels

The maximum number of output channels.

Definition at line 443 of file TeamTalk.h.

## ◆ inputSampleRates

INT32 SoundDevice::inputSampleRates[TT_SAMPLERATES_MAX]

Supported sample rates by device for recording. A zero value terminates the list of supported sample rates or its maximum size of TT_SAMPLERATES_MAX.

Definition at line 447 of file TeamTalk.h.

## ◆ outputSampleRates

INT32 SoundDevice::outputSampleRates[TT_SAMPLERATES_MAX]

Supported sample rates by device for playback. A zero value terminates the list of supported sample rates or its maximum size of TT_SAMPLERATES_MAX.

Definition at line 451 of file TeamTalk.h.

## ◆ nDefaultSampleRate

INT32 SoundDevice::nDefaultSampleRate

The default sample rate for the sound device.

Definition at line 453 of file TeamTalk.h.

## ◆ uSoundDeviceFeatures

SoundDeviceFeatures SoundDevice::uSoundDeviceFeatures

Additional features available for this sound device. The sound device features can be used to enable additional features on the sound device.

See also
  SoundDeviceFeature
  TT_SetSoundDeviceEffects()

Definition at line 459 of file TeamTalk.h.