Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8
ak_wwise_plugin_host_data_writer_v1 Struct Reference

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

#include <HostDataWriter.h>

Inheritance diagram for ak_wwise_plugin_host_data_writer_v1:
ak_wwise_plugin_interface_ptr

Public Types

using Instance = ak_wwise_plugin_host_data_writer_instance_v1
 Base host-provided instance type for ak_wwise_plugin_host_data_writer_v1. More...
 

Public Member Functions

 ak_wwise_plugin_host_data_writer_v1 ()
 
- Public Member Functions inherited from ak_wwise_plugin_interface_ptr
constexpr ak_wwise_plugin_base_interface (decltype(m_interface) in_interface, decltype(m_version) in_version)
 
constexpr ak_wwise_plugin_base_interface ()
 
constexpr ak_wwise_plugin_base_interface (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
 

Public Attributes

bool(* WriteData )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, const void *in_pData, uint32_t in_cBytes, uint32_t *out_cWritten)
 Writes a block of data. More...
 
bool(* WriteString )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, const char *in_szString)
 Writes a string. More...
 
bool(* WriteInt64 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, int64_t in_value)
 Writes a 64-bit signed integer value. More...
 
bool(* WriteInt32 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, int32_t in_value)
 Writes a 32-bit signed integer value. More...
 
bool(* WriteInt16 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, int16_t in_value)
 Writes a 16-bit signed integer value. More...
 
bool(* WriteInt8 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, int8_t in_value)
 Writes an 8-bit signed integer value. More...
 
bool(* WriteUInt64 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, uint64_t in_value)
 Writes a 64-bit unsigned integer value. More...
 
bool(* WriteUInt32 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, uint32_t in_value)
 Writes a 32-bit unsigned integer value. More...
 
bool(* WriteUInt16 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, uint16_t in_value)
 Writes a 16-bit unsigned integer value. More...
 
bool(* WriteUInt8 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, uint8_t in_value)
 Writes an 8-bit unsigned integer value. More...
 
bool(* WriteReal64 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, double in_value)
 Writes a 64-bit, double-precision floating point value. More...
 
bool(* WriteReal32 )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, float in_value)
 Writes a 32-bit, single-precision floating point value. More...
 
bool(* WriteBool )(struct ak_wwise_plugin_host_data_writer_instance_v1 *in_this, bool in_value)
 Writes a boolean value. More...
 
- Public Attributes inherited from ak_wwise_plugin_interface_ptr
ak_wwise_plugin_interface_type m_interface: 32
 Interface type (see ak_wwise_plugin_interface_type) More...
 
uint32_t m_version: 32
 Version of the interface. 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 47 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