TeamTalk 5 C-API DLL: SpeexVBRCodec Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

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

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

`#include <TeamTalk.h>`

## Public Attributes

INT32 | 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).
INT32 | nQuality
| A value from 0-10. If `nBitRate` is non-zero it will override this value.
INT32 | 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 SPEEX_NB_MIN_BITRATE, SPEEX_NB_MAX_BITRATE, SPEEX_WB_MIN_BITRATE, SPEEX_WB_MAX_BITRATE, SPEEX_UWB_MIN_BITRATE and SPEEX_UWB_MAX_BITRATE. Note that specifying `nBitRate` will override nQualityVBR.

INT32 | nMaxBitRate
| The maximum bitrate at which the audio codec is allowed to output audio. Set to zero if it should be ignored.
TTBOOL | bDTX
| Enable/disable discontinuous transmission. When enabled Speex will ignore silence, so the bitrate will become very low.
INT32 | nTxIntervalMSec
| Milliseconds of audio data before each transmission.
TTBOOL | 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 OpusCodec.

Definition at line 1086 of file TeamTalk.h.

## Member Data Documentation

## ◆ nBandmode

INT32 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 1090 of file TeamTalk.h.

## ◆ nQuality

INT32 SpeexVBRCodec::nQuality

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

Definition at line 1093 of file TeamTalk.h.

## ◆ nBitRate

INT32 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 SPEEX_NB_MIN_BITRATE, SPEEX_NB_MAX_BITRATE, SPEEX_WB_MIN_BITRATE, SPEEX_WB_MAX_BITRATE, SPEEX_UWB_MIN_BITRATE and SPEEX_UWB_MAX_BITRATE. Note that specifying `nBitRate` will override nQualityVBR.

Definition at line 1102 of file TeamTalk.h.

## ◆ nMaxBitRate

INT32 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 1106 of file TeamTalk.h.

## ◆ bDTX

TTBOOL SpeexVBRCodec::bDTX

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

Definition at line 1110 of file TeamTalk.h.

## ◆ nTxIntervalMSec

INT32 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 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 1119 of file TeamTalk.h.

## ◆ bStereoPlayback

TTBOOL SpeexVBRCodec::bStereoPlayback

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

See also
  TT_SetUserPosition()
  TT_SetUserStereo()

Definition at line 1125 of file TeamTalk.h.