Version

menu_open
Wwise SDK 2023.1.4
AK.Wwise::Plugin::V1::DataWriter Class Reference

Interface used to write data during sound bank generation. More...

#include <HostDataWriter.h>

Inheritance diagram for AK.Wwise::Plugin::V1::DataWriter:
AK.Wwise::Plugin::CBaseInstanceGlue< CHostDataWriter > AK.Wwise::Plugin::CBaseInterfaceGlue< CHostDataWriter >

Public Types

enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_DATA_WRITER }
 The interface type, as requested by this plug-in. More...
 
enum  : InterfaceVersion { k_interfaceVersion = 1 }
 The interface version, as requested by this plug-in. More...
 
using Interface = CHostDataWriter
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInstanceGlue< CHostDataWriter >
using Instance = typename CInterface::Instance
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostDataWriter >
using GluedInterface = CHostDataWriter
 

Public Member Functions

bool WriteData (const void *in_pData, uint32_t in_cBytes, uint32_t &out_cWritten)
 Writes a block of data. More...
 
bool WriteString (const char *in_szString)
 Writes a string. More...
 
bool WriteInt64 (int64_t in_value)
 Writes a 64-bit signed integer value. More...
 
bool WriteInt32 (int32_t in_value)
 Writes a 32-bit signed integer value. More...
 
bool WriteInt16 (int16_t in_value)
 Writes a 16-bit signed integer value. More...
 
bool WriteInt8 (int8_t in_value)
 Writes an 8-bit signed integer value. More...
 
bool WriteUInt64 (uint64_t in_value)
 Writes a 64-bit unsigned integer value. More...
 
bool WriteUInt32 (uint32_t in_value)
 Writes a 32-bit unsigned integer value. More...
 
bool WriteUInt16 (uint16_t in_value)
 Writes a 16-bit unsigned integer value. More...
 
bool WriteUInt8 (uint8_t in_value)
 Writes an 8-bit unsigned integer value. More...
 
bool WriteReal64 (double in_value)
 Writes a 64-bit, double-precision floating point value. More...
 
bool WriteReal32 (float in_value)
 Writes a 32-bit, single-precision floating point value. More...
 
bool WriteBool (bool in_value)
 Writes a boolean value. More...
 

Additional Inherited Members

- Static Public Attributes inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostDataWriter >
static GluedInterfaceg_cinterface
 The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host once loaded. More...
 

Detailed Description

Interface used to write data during sound bank generation.

Note: All functions perform the appropriate platform-specific byte reordering, except where noted.
See also

Definition at line 244 of file HostDataWriter.h.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise