Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.3
ak_wwise_plugin_host_xml_v1 Struct Reference

API interface for XML-based plug-in persistence. More...

#include <HostXml.h>

Inheritance diagram for ak_wwise_plugin_host_xml_v1:
ak_wwise_plugin_interface_ptr

Public Types

using  ReaderInstance = ak_wwise_plugin_host_xml_reader_instance_v1
 
using  WriterInstance = ak_wwise_plugin_host_xml_writer_instance_v1
 

Public Member Functions

  ak_wwise_plugin_host_xml_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

const char *(*  GetName )(const struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Returns the name of the current node being read. More...
 
AK::Wwise::Plugin::XmlNodeType::NodeType(*  GetNodeType )(const struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Returns the type of the current node being read. More...
 
bool(*  IsEmptyElement )(const struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Tests whether the current node being read is empty. More...
 
const char *(*  GetValue )(const struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Returns the value of the current node being read. More...
 
bool(*  IsEOF )(const struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Tests whether the end of file is reached while reading the XML. More...
 
int(*  GetLineNumber )(const struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Retrieves the line number that contains the start of the current node being read. More...
 
int(*  GetLinePosition )(const struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Retrieves the column in the line that contains the start of the current node being read. More...
 
AK::Wwise::Plugin::XmlNodeType::NodeType(*  MoveToContent )(struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Makes sure the cursor points to a content-type entity while reading XML. More...
 
bool(*  Read )(struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Sets the reading pointer to the next node, recursively. More...
 
const char *(*  ReadElementString )(struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Reads simple text-only elements, and increments the pointer. More...
 
void(*  ReadInnerXml )(struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this, const char **out_csXml)
  Reads all the contents of an Element or Attribute as a string, including markup. Increments the pointer. More...
 
void(*  ReadOuterXml )(struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this, const char **out_csXml)
  Reads the Element or Attribute as a string, including markup. Increments the pointer. More...
 
void(*  Skip )(struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)
  Sets the reading pointer past the current node, skipping any inner content. More...
 
bool(*  GetAttribute )(struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this, const char *in_rcsAttributeName, const char **out_rcsValue)
  Reads the value of a particular attribute under the current node. More...
 
bool(*  IsReady )(const struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this)
  Determines if the writer is ready to be used. More...
 
AK::Wwise::Plugin::XmlWriteReady::WriteReady(*  GetReadyState )(const struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this)
  Determines the state of readiness of the writer. More...
 
bool(*  Append )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this, struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_pWriterToAppend)
  Appending a first XML writer to a second XML writer. More...
 
AK::Wwise::Plugin::XmlWriteState::WriteState(*  GetWriteState )(const struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this)
  Retrieves the state of the node the writer is currently populating. More...
 
void(*  WriteStartDocument )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this)
  Starts a new XML document. More...
 
void(*  WriteEndDocument )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this)
  Ends a completed XML document. More...
 
void(*  WriteStartElement )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this, const char *in_rcsElementName, AK::Wwise::Plugin::XmlElementType::ElementType in_eType)
  Creates a new inner node. More...
 
void(*  WriteEndElement )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this)
  Closes the previous node. More...
 
void(*  WriteAttributeString )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this, const char *in_rcsAttribute, const char *in_rcsValue)
  Adds an attribute to the current node. More...
 
void(*  WriteString )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this, const char *in_rcsValue)
  Appends a string as value to the current node. More...
 
void(*  WriteCData )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this, const char *in_rcsValue)
  Appends a raw CDATA string as value to the current node. More...
 
void(*  WriteRaw )(struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_this, const char *in_rcsValue)
  Appends a raw string at this precise point of the XML file. 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

API interface for XML-based plug-in persistence.

The XML plug-in persistence is useful when a plug-in provides custom data handling. Normally, plug-in data is stored through the property sets (see PropertySet and ObjectStore). However, a plug-in might provide its own custom handling. For complex interfaces, it might be worthwhile to use the CustomData interface. Loading and saving can then be done through this XML interface.

The XML interface represents a cursor pointing to a node (element), alongside methods to navigate through the hierarchy.

Note: One unique XML interface is provided for both reading and writing XML. Depending on the instance being provided, it will allow reading or writing through this interface.

It can either be a ak_wwise_plugin_host_xml_reader_instance_v1 or a ak_wwise_plugin_host_xml_writer_instance_v1.

Definition at line 142 of file HostXml.h.