Serialization

Typedefs

typedef struct _IPLSerializedObject_t *IPLSerializedObject

A serialized representation of an API object, like an IPLScene or IPLProbeBatch.

Create an empty serialized object if you want to serialize an existing object to a byte array, or create a serialized object that wraps an existing byte array if you want to deserialize it.

Functions

IPLerror iplSerializedObjectCreate(IPLContext context, IPLSerializedObjectSettings *settings, IPLSerializedObject *serializedObject)

Creates a serialized object.

Parameters

  • context – The context used to initialize Steam Audio.

  • settings – The settings to use when creating the serialized object.

  • serializedObject – [out] The created serialized object.

Returns

Status code indicating whether or not the operation succeeded.

IPLSerializedObject iplSerializedObjectRetain(IPLSerializedObject serializedObject)

Retains an additional reference to a serialized object.

Parameters

serializedObject – The serialized object to retain a reference to.

Returns

The additional reference to the serialized object.

void iplSerializedObjectRelease(IPLSerializedObject *serializedObject)

Releases a reference to a serialized object.

Parameters

serializedObject – The serialized object to release a reference to.

IPLsize iplSerializedObjectGetSize(IPLSerializedObject serializedObject)
Parameters

serializedObject – The serialized object.

Returns

The size in bytes of the serialized data contained in a serialized object.

IPLbyte *iplSerializedObjectGetData(IPLSerializedObject serializedObject)
Parameters

serializedObject – The serialized object.

Returns

A pointer to a byte array of serialized data contained in a serialized object.

Structures

struct IPLSerializedObjectSettings

Settings used to create a serialized object.

Public Members

IPLbyte *data

If non-NULL, the serialized object will contain the data in this buffer.

If NULL, the serialized object will start out empty.

IPLsize size

The number of bytes in the buffer pointed to by data.

Set to 0 if data is NULL.