SoundDevice Struct Reference
[Sound Capture and Playback]

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

#include <TeamTalk4.h>

List of all members.

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 and WinMM it would be the GUID of the sound device. Note that it may not always be available.
INT32 nWaveDeviceID
 The ID of the device used in Win32's waveInGetDevCaps and waveOutGetDevCaps.
BOOL 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 supportedSampleRates [16]
 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.

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

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.

The sound system used by the sound device.

The name of the sound device.

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

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

Whether the sound device supports 3D-sound effects.

The maximum number of input channels.

The maximum number of output channels.

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.

Generated on Sun Mar 18 17:18:33 2012 for TeamTalk 4 C-API DLL by  doxygen 1.6.3