TeamTalk 5 .NET DLL: BearWare.SoundDevice Struct Reference

TeamTalk 5 .NET DLL Version 5.18A

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

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

## Public Attributes

int | nDeviceID

The ID of the sound device. Used for passing to TeamTalkBase.InitSoundInputDevice() and TeamTalkBase.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.
string | szDeviceName
| The name of the sound device.
string | szDeviceID
| 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.
int | nWaveDeviceID
| A Windows specific ID to the sound device.
bool | bSupports3D
| Whether the sound device supports 3D-sound effects.
int | nMaxInputChannels
| The maximum number of input channels.
int | nMaxOutputChannels
| The maximum number of output channels.
int[] | inputSampleRates
| Supported sample rates by device for recording. A zero value terminates the list of supported sample rates or its maximum size of BearWare.TeamTalkBase.TT_SAMPLERATES_MAX.
int[] | outputSampleRates
| Supported sample rates by device for playback. A zero value terminates the list of supported sample rates or its maximum size of BearWare.TeamTalkBase.TT_SAMPLERATES_MAX.
int | nDefaultSampleRate
| The default sample rate for the sound device.
SoundDeviceFeature | 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 TeamTalkBase.InitSoundInputDevice() or TeamTalkBase.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
  TeamTalkBase.GetSoundDevices

Definition at line 209 of file TeamTalk.cs.

## Member Data Documentation

## ◆ nDeviceID

int BearWare.SoundDevice.nDeviceID

The ID of the sound device. Used for passing to TeamTalkBase.InitSoundInputDevice() and TeamTalkBase.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 216 of file TeamTalk.cs.

## ◆ nSoundSystem

SoundSystem BearWare.SoundDevice.nSoundSystem

The sound system used by the sound device.

Definition at line 218 of file TeamTalk.cs.

## ◆ szDeviceName

string BearWare.SoundDevice.szDeviceName

The name of the sound device.

Definition at line 221 of file TeamTalk.cs.

## ◆ szDeviceID

string BearWare.SoundDevice.szDeviceID

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 227 of file TeamTalk.cs.

## ◆ nWaveDeviceID

int BearWare.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
  WindowsMixer.GetWaveInName
  WindowsMixer.GetWaveOutName
  WindowsMixer.GetMixerCount

Definition at line 244 of file TeamTalk.cs.

## ◆ bSupports3D

bool BearWare.SoundDevice.bSupports3D

Whether the sound device supports 3D-sound effects.

Deprecated
  Use BearWare.SoundDeviceFeature.SOUNDDEVICEFEATURE_3DPOSITION.

Definition at line 247 of file TeamTalk.cs.

## ◆ nMaxInputChannels

int BearWare.SoundDevice.nMaxInputChannels

The maximum number of input channels.

Definition at line 249 of file TeamTalk.cs.

## ◆ nMaxOutputChannels

int BearWare.SoundDevice.nMaxOutputChannels

The maximum number of output channels.

Definition at line 251 of file TeamTalk.cs.

## ◆ inputSampleRates

int [] BearWare.SoundDevice.inputSampleRates

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

Definition at line 256 of file TeamTalk.cs.

## ◆ outputSampleRates

int [] BearWare.SoundDevice.outputSampleRates

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

Definition at line 261 of file TeamTalk.cs.

## ◆ nDefaultSampleRate

int BearWare.SoundDevice.nDefaultSampleRate

The default sample rate for the sound device.

Definition at line 263 of file TeamTalk.cs.

## ◆ uSoundDeviceFeatures

SoundDeviceFeature BearWare.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
  TeamTalkBase.SetSoundDeviceEffects()

Definition at line 269 of file TeamTalk.cs.