TeamTalk 4 C-API DLL  Version 4.5A
SoundDevice Struct Reference

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

#include <TeamTalk4.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. More...
 
SoundSystem nSoundSystem
 The sound system used by the sound device. More...
 
TTCHAR szDeviceName [TT_STRLEN]
 The name of the sound device. More...
 
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. More...
 
INT32 nWaveDeviceID
 The ID of the device used in Win32's waveInGetDevCaps and waveOutGetDevCaps. More...
 
BOOL bSupports3D
 Whether the sound device supports 3D-sound effects. More...
 
INT32 nMaxInputChannels
 The maximum number of input channels. More...
 
INT32 nMaxOutputChannels
 The maximum number of output channels. More...
 
INT32 supportedSampleRates [TT_SAMPLERATES_MAX]
 Supported sample rates by device. A zero value terminates the list of supported sample rates or its maximum size of 16. Investigating the support sample rates is usually only required on Linux since sound devices often don't numerous sample rates. More...
 
INT32 nDefaultSampleRate
 The default sample rate for the sound device. More...
 

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_GetSoundInputDevices
TT_GetSoundOutputDevices

Member Data Documentation

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.

SoundSystem SoundDevice::nSoundSystem

The sound system used by the sound device.

TTCHAR SoundDevice::szDeviceName[TT_STRLEN]

The name of the sound device.

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.

INT32 SoundDevice::nWaveDeviceID

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.

See Also
TT_Mixer_GetWaveInName
TT_Mixer_GetWaveOutName
TT_Mixer_GetMixerCount
BOOL SoundDevice::bSupports3D

Whether the sound device supports 3D-sound effects.

INT32 SoundDevice::nMaxInputChannels

The maximum number of input channels.

INT32 SoundDevice::nMaxOutputChannels

The maximum number of output channels.

INT32 SoundDevice::supportedSampleRates[TT_SAMPLERATES_MAX]

Supported sample rates by device. A zero value terminates the list of supported sample rates or its maximum size of 16. Investigating the support sample rates is usually only required on Linux since sound devices often don't numerous sample rates.

INT32 SoundDevice::nDefaultSampleRate

The default sample rate for the sound device.