TeamTalk 5 C-API DLL: OpusCodec Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

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

OPUS audio codec settings. For detailed information about the OPUS codec check out http://www.opus-codec.org. More...

`#include <TeamTalk.h>`

## Public Attributes

INT32 | nSampleRate
| The sample rate to use. Sample rate must be 8000, 12000, 16000, 24000 or 48000 Hz.
INT32 | nChannels
| Mono = 1 or stereo = 2.
INT32 | nApplication
| Application of encoded audio, i.e. VoIP or music.
INT32 | nComplexity
| Complexity of encoding (affects CPU usage). Value from 0-10.
TTBOOL | bFEC
| Forward error correction. Corrects errors if there's packetloss.
TTBOOL | bDTX
| Discontinuous transmission. Enables "null" packets during silence.
INT32 | nBitRate
| Bitrate for encoded audio. Should be between OPUS_MIN_BITRATE and OPUS_MAX_BITRATE.
TTBOOL | bVBR
| Enable variable bitrate.
TTBOOL | bVBRConstraint
| Enable constrained VBR. `bVBR` must be enabled to enable this.
INT32 | nTxIntervalMSec
| Duration of audio before each transmission. Minimum is 2 msec. Recommended is 40 msec. Maximum is 500 msec.
INT32 | nFrameSizeMSec
| OPUS supports 2.5, 5, 10, 20, 40, 60, 80, 100 and 120 msec. If `nFrameSizeMSec` is 0 then `nFrameSizeMSec` will be same as `nTxIntervalMSec`.

## Detailed Description

OPUS audio codec settings. For detailed information about the OPUS codec check out http://www.opus-codec.org.

Definition at line 1149 of file TeamTalk.h.

## Member Data Documentation

## ◆ nSampleRate

INT32 OpusCodec::nSampleRate

The sample rate to use. Sample rate must be 8000, 12000, 16000, 24000 or 48000 Hz.

Definition at line 1153 of file TeamTalk.h.

## ◆ nChannels

INT32 OpusCodec::nChannels

Mono = 1 or stereo = 2.

Definition at line 1155 of file TeamTalk.h.

## ◆ nApplication

INT32 OpusCodec::nApplication

Application of encoded audio, i.e. VoIP or music.

See also
  OPUS_APPLICATION_VOIP
  OPUS_APPLICATION_AUDIO

Definition at line 1159 of file TeamTalk.h.

## ◆ nComplexity

INT32 OpusCodec::nComplexity

Complexity of encoding (affects CPU usage). Value from 0-10.

Definition at line 1162 of file TeamTalk.h.

## ◆ bFEC

TTBOOL OpusCodec::bFEC

Forward error correction. Corrects errors if there's packetloss.

Definition at line 1165 of file TeamTalk.h.

## ◆ bDTX

TTBOOL OpusCodec::bDTX

Discontinuous transmission. Enables "null" packets during silence.

Definition at line 1168 of file TeamTalk.h.

## ◆ nBitRate

INT32 OpusCodec::nBitRate

Bitrate for encoded audio. Should be between OPUS_MIN_BITRATE and OPUS_MAX_BITRATE.

Definition at line 1171 of file TeamTalk.h.

## ◆ bVBR

TTBOOL OpusCodec::bVBR

Enable variable bitrate.

Definition at line 1173 of file TeamTalk.h.

## ◆ bVBRConstraint

TTBOOL OpusCodec::bVBRConstraint

Enable constrained VBR. `bVBR` must be enabled to enable this.

Definition at line 1176 of file TeamTalk.h.

## ◆ nTxIntervalMSec

INT32 OpusCodec::nTxIntervalMSec

Duration of audio before each transmission. Minimum is 2 msec. Recommended is 40 msec. Maximum 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 1183 of file TeamTalk.h.

## ◆ nFrameSizeMSec

INT32 OpusCodec::nFrameSizeMSec

OPUS supports 2.5, 5, 10, 20, 40, 60, 80, 100 and 120 msec. If `nFrameSizeMSec` is 0 then `nFrameSizeMSec` will be same as `nTxIntervalMSec`.

Definition at line 1187 of file TeamTalk.h.