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

Speex audio codec settings for Variable Bitrate mode (VBR). The Speex codec is recommended for voice and uses less bandwidth than CELTCodec. The Speex VBR codec was introduced in version 4.2. More...

#include <TeamTalk4.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). More...
 
INT32 nQualityVBR
 A value from 0-10. If nBitRate is non-zero it will override this value. More...
 
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. More...
 
INT32 nMaxBitRate
 The maximum bitrate at which the audio codec is allowed to output audio. Set to zero if it should be ignored. More...
 
BOOL bDTX
 Enable/disable discontinuous transmission. When enabled Speex will ignore silence, so the bitrate will become very low. More...
 
INT32 nMSecPerPacket
 Milliseconds of audio data in each packet. Speex uses 20 msec frame sizes. Recommended is 40 ms. Min is 20, max is 1000. More...
 
BOOL bUseJitterBuffer
 Use Speex' jitter buffer for playback. Recommended is FALSE. More...
 
BOOL bStereoPlayback
 Playback should be done in stereo. Doing so will disable 3d-positioning. More...
 

Detailed Description

Speex audio codec settings for Variable Bitrate mode (VBR). The Speex codec is recommended for voice and uses less bandwidth than CELTCodec. The Speex VBR codec was introduced in version 4.2.

Member Data Documentation

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).

INT32 SpeexVBRCodec::nQualityVBR

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

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.

INT32 SpeexVBRCodec::nMaxBitRate

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

BOOL SpeexVBRCodec::bDTX

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

INT32 SpeexVBRCodec::nMSecPerPacket

Milliseconds of audio data in each packet. Speex uses 20 msec frame sizes. Recommended is 40 ms. Min is 20, max is 1000.

BOOL SpeexVBRCodec::bUseJitterBuffer

Use Speex' jitter buffer for playback. Recommended is FALSE.

BOOL SpeexVBRCodec::bStereoPlayback

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

See Also
TT_SetUserPosition
TT_SetUserStereo