core/html/_xt_stream_8h_source.html

 #ifndef XT_API_STREAM_H

 #define XT_API_STREAM_H


 #include <xt/api/Shared.h>

 #include <xt/api/Structs.h>

 #include <stdint.h>

 #ifdef __cplusplus

 extern "C" {

 #endif


 XT_API void XT_CALL

 XtStreamStop(XtStream* s);

 XT_API XtError XT_CALL

 XtStreamStart(XtStream* s);

 XT_API void XT_CALL

 XtStreamDestroy(XtStream* s);

 XT_API void* XT_CALL

 XtStreamGetHandle(XtStream const* s);

 XT_API XtBool XT_CALL

 XtStreamIsRunning(XtStream const* s);

 XT_API const XtFormat* XT_CALL

 XtStreamGetFormat(XtStream const* s);

 XT_API XtBool XT_CALL

 XtStreamIsInterleaved(XtStream const* s);

 XT_API XtError XT_CALL

 XtStreamGetFrames(XtStream const* s, int32_t* frames);

 XT_API XtError XT_CALL

 XtStreamGetLatency(XtStream const* s, XtLatency* latency);


 #ifdef __cplusplus

 }

 #endif // __cplusplus

 #endif // XT_API_STREAM_H

XtStreamDestroy
void XtStreamDestroy(XtStream *s)
Destroys an audio stream.

XtStreamStop
void XtStreamStop(XtStream *s)
Stops an audio stream.

XtFormat
Audio stream format.
Definition: Structs.h:65

XtError
uint64_t XtError
Error type.
Definition: Shared.h:26

XtStreamIsInterleaved
XtBool XtStreamIsInterleaved(XtStream const *s)
Get stream interleaved mode.

XtStreamGetFrames
XtError XtStreamGetFrames(XtStream const *s, int32_t *frames)
Get maximum stream buffer size.

Structs.h
Data structure types.

XT_CALL
#define XT_CALL
Calling convention.

XtStream
struct XtStream XtStream
opaque audio stream handle
Definition: Shared.h:31

XtBool
int32_t XtBool
Boolean type.
Definition: Shared.h:25

Shared.h
Calling conventions and common data types.

XtStreamIsRunning
XtBool XtStreamIsRunning(XtStream const *s)
Query stream state.

XtStreamGetLatency
XtError XtStreamGetLatency(XtStream const *s, XtLatency *latency)
Get the end-to-end latency, if supported by the system.

XtStreamGetFormat
const XtFormat * XtStreamGetFormat(XtStream const *s)
Get stream format.

XtStreamStart
XtError XtStreamStart(XtStream *s)
Starts an audio stream.

XtStreamGetHandle
void * XtStreamGetHandle(XtStream const *s)
Implementation-defined handle to the backend stream.

XtLatency
Stream latency.
Definition: Structs.h:51