Basic Data Types

Typedefs

typedef char IPLint8

Signed 8-bit integer.

typedef unsigned char IPLuint8

Unsigned 8-bit integer.

typedef short IPLint16

Signed 16-bit integer.

typedef unsigned short IPLuint16

Unsigned 16-bit integer.

typedef int IPLint32

Signed 32-bit integer.

typedef unsigned int IPLuint32

Unsigned 32-bit integer.

typedef long long IPLint64

Signed 64-bit integer.

typedef unsigned long long IPLuint64

Unsigned 64-bit integer.

typedef float IPLfloat32

Single-precision floating-point number.

typedef double IPLfloat64

Double-precision floating-point number.

typedef unsigned char IPLbyte

A single byte.

typedef size_t IPLsize

Unsigned integer of machine-dependent size.

Equivalent to size_t.

typedef const char *IPLstring

NULL-terminated ASCII or UTF-8 string.

Enumerations

enum IPLbool

Boolean values.

Values:

enumerator IPL_FALSE

The Boolean value false.

enumerator IPL_TRUE

The Boolean value true.

enum IPLerror

Status codes returned by Steam Audio API functions.

Values:

enumerator IPL_STATUS_SUCCESS

The operation completed successfully.

enumerator IPL_STATUS_FAILURE

An unspecified error occurred.

enumerator IPL_STATUS_OUTOFMEMORY

The system ran out of memory.

enumerator IPL_STATUS_INITIALIZATION

An error occurred while initializing an external dependency.

Callbacks

typedef void (*IPLProgressCallback)(IPLfloat32 progress, void *userData)

Callback for updating the application on the progress of a function.

You can use this to provide the user with visual feedback, like a progress bar.

Param progress:

Fraction of the function work that has been completed, between 0.0 and 1.0.

Param userData:

Pointer to arbitrary user-specified data provided when calling the function that will call this callback.