XT-Audio
Data Fields
XtBuffer Struct Reference

Streaming audio buffer. More...

#include <Structs.h>

Data Fields

void const * input
 The buffer containing data captured from the device, if any. More...
 
void * output
 The buffer where the application writes it's output, if any. More...
 
double time
 The stream timestamp. More...
 
uint64_t position
 The stream position. More...
 
int32_t frames
 The number of frames in the input and/or output buffer. More...
 
XtBool timeValid
 Indicates whether the time and position fields are valid. More...
 

Detailed Description

Streaming audio buffer.

Contains the input and output audio data and timestamp information for the audio callback (XtOnBuffer).

See also
XtOnBuffer

Field Documentation

XtBuffer::frames

The number of frames in the input and/or output buffer.

Will never exceed XtStreamGetFrames.

XtBuffer::input

The buffer containing data captured from the device, if any.

May be NULL if frames == 0 or when no input channels are present.

XtBuffer::output

The buffer where the application writes it's output, if any.

May be NULL if frames == 0 or when no output channels are present.

XtBuffer::position

The stream position.

Only available on services which have the Time capability (see XtServiceCaps), otherwise 0.

XtBuffer::time

The stream timestamp.

Only available on services which have the Time capability (see XtServiceCaps), otherwise 0.

XtBuffer::timeValid

Indicates whether the time and position fields are valid.

Only available on services which have the Time capability (see XtServiceCaps), otherwise false. Even on services which support time and position info this parameter may be false sometimes, for example during stream startup/shutdown or when a glitch occurred.


The documentation for this struct was generated from the following files: