TeamTalk 5 .NET DLL: BearWare.SpeexVBRCodec Struct Reference

TeamTalk 5 .NET DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
BearWare.SpeexVBRCodec Struct Reference
Audio and Video Codecs

Speex audio codec settings for Variable Bitrate mode (VBR). More...

## Public Attributes

int | nBandmode
| Set to 0 for 8 KHz (narrow band), set to 1 for 16 KHz (wide band), set to 2 for 32 KHz (ultra-wide band).
int | nQuality
| A value from 0-10. If `nBitRate` is non-zero it will override this value.
int | nBitRate

The bitrate at which the audio codec should output encoded audio data. Dividing it by 8 gives roughly the number of bytes per second used for transmitting the encoded data. For limits check out BearWare.SpeexConstants. Note that specifying `nBitRate` will override nQuality.

int | nMaxBitRate
| The maximum bitrate at which the audio codec is allowed to output audio. Set to zero if it should be ignored.
bool | bDTX
| Enable/disable discontinuous transmission. When enabled Speex will ignore silence, so the bitrate will become very low.
int | nTxIntervalMSec
| Milliseconds of audio data before each transmission.
bool | bStereoPlayback
| Playback should be done in stereo. Doing so will disable 3d-positioning.

## Detailed Description

Speex audio codec settings for Variable Bitrate mode (VBR).

Deprecated
  Use BearWare.OpusCodec.

Definition at line 945 of file TeamTalk.cs.

## Member Data Documentation

## ◆ nBandmode

int BearWare.SpeexVBRCodec.nBandmode

Set to 0 for 8 KHz (narrow band), set to 1 for 16 KHz (wide band), set to 2 for 32 KHz (ultra-wide band).

Definition at line 949 of file TeamTalk.cs.

## ◆ nQuality

int BearWare.SpeexVBRCodec.nQuality

A value from 0-10. If `nBitRate` is non-zero it will override this value.

Definition at line 952 of file TeamTalk.cs.

## ◆ nBitRate

int BearWare.SpeexVBRCodec.nBitRate

The bitrate at which the audio codec should output encoded audio data. Dividing it by 8 gives roughly the number of bytes per second used for transmitting the encoded data. For limits check out BearWare.SpeexConstants. Note that specifying `nBitRate` will override nQuality.

Definition at line 959 of file TeamTalk.cs.

## ◆ nMaxBitRate

int BearWare.SpeexVBRCodec.nMaxBitRate

The maximum bitrate at which the audio codec is allowed to output audio. Set to zero if it should be ignored.

Definition at line 963 of file TeamTalk.cs.

## ◆ bDTX

bool BearWare.SpeexVBRCodec.bDTX

Enable/disable discontinuous transmission. When enabled Speex will ignore silence, so the bitrate will become very low.

Definition at line 967 of file TeamTalk.cs.

## ◆ nTxIntervalMSec

int BearWare.SpeexVBRCodec.nTxIntervalMSec

Milliseconds of audio data before each transmission.

Speex uses 20 msec frame sizes. Recommended is 40 msec. Min is 20, max is 500 msec.

The BearWare.SoundSystem must be able to process audio packets at this interval. In most cases this makes less than 40 msec transmission interval unfeasible.

Definition at line 976 of file TeamTalk.cs.

## ◆ bStereoPlayback

bool BearWare.SpeexVBRCodec.bStereoPlayback

Playback should be done in stereo. Doing so will disable 3d-positioning.

See also
  TeamTalkBase.SetUserPosition
  TeamTalkBase.SetUserStereo

Definition at line 982 of file TeamTalk.cs.