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

An audio block containing the raw audio from a user who was talking. More...

#include <TeamTalk4.h>

Public Attributes

INT32 nSampleRate
 The sample rate of the raw audio. More...
 
INT32 nChannels
 The number of channels used (1 for mono, 2 for stereo). More...
 
VOID * lpRawAudio
 The raw audio in 16-bit integer format array. The size of the array in bytes is sizeof(short) * nSamples * nChannels. More...
 
INT32 nSamples
 The number of samples in the raw audio array. More...
 
UINT32 uSampleIndex
 The index of the first sample in lpRawAudio. Its value will be a multiple of nSamples. The sample index can be used to detect overflows of the internal buffer. When a user initially starts talking the nSampleIndex will be 0 and while the user is talking nSampleIndex will be greater than 0. When the user stops talking nSampleIndex will be reset to 0 again. More...
 

Detailed Description

An audio block containing the raw audio from a user who was talking.

To enable audio blocks first call TT_EnableAudioBlockEvent() then whenever new audio is played the event WM_TEAMTALK_USER_AUDIOBLOCK is generated. Use TT_AcquireUserAudioBlock() to retrieve the audio block.

Note that each user is limited to 128 kbytes of audio data.

See Also
TT_EnableAudioBlockEvent()
TT_AcquireUserAudioBlock()
TT_ReleaseUserAudioBlock()

Member Data Documentation

INT32 AudioBlock::nSampleRate

The sample rate of the raw audio.

INT32 AudioBlock::nChannels

The number of channels used (1 for mono, 2 for stereo).

VOID* AudioBlock::lpRawAudio

The raw audio in 16-bit integer format array. The size of the array in bytes is sizeof(short) * nSamples * nChannels.

INT32 AudioBlock::nSamples

The number of samples in the raw audio array.

UINT32 AudioBlock::uSampleIndex

The index of the first sample in lpRawAudio. Its value will be a multiple of nSamples. The sample index can be used to detect overflows of the internal buffer. When a user initially starts talking the nSampleIndex will be 0 and while the user is talking nSampleIndex will be greater than 0. When the user stops talking nSampleIndex will be reset to 0 again.