Version

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

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

#include <HostXml.h>

Inheritance diagram for AK.Wwise::Plugin::V1::XmlReader:
AK.Wwise::Plugin::CBaseInstanceGlue< CHostXml, CHostXml::ReaderInstance > ak_wwise_plugin_host_xml_reader_instance_v1 AK.Wwise::Plugin::CBaseInterfaceGlue< CHostXml > ak_wwise_plugin_cpp_base_instance ak_wwise_plugin_instance_ptr

Public Types

enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_XML }
 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 = CHostXml
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInstanceGlue< CHostXml, CHostXml::ReaderInstance >
using Instance = CHostXml::ReaderInstance
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostXml >
using GluedInterface = CHostXml
 

Public Member Functions

const char * GetName () const
 Returns the name of the current node being read. More...
 
AK::Wwise::Plugin::XmlNodeType::NodeType GetNodeType () const
 Returns the type of the current node being read. More...
 
bool IsEmptyElement () const
 Tests whether the current node being read is empty. More...
 
const char * GetValue () const
 Returns the value of the current node being read. More...
 
bool IsEOF () const
 Tests whether the end of file is reached while reading the XML. More...
 
int GetLineNumber () const
 Retrieves the line number that contains the start of the current node being read. More...
 
int GetLinePosition () const
 Retrieves the column in the line that contains the start of the current node being read. More...
 
AK::Wwise::Plugin::XmlNodeType::NodeType MoveToContent ()
 Makes sure the cursor points to a content-type entity while reading XML. More...
 
bool Read ()
 Sets the reading pointer to the next node, recursively. More...
 
const char * ReadElementString ()
 Reads simple text-only elements, and increments the pointer. More...
 
void ReadInnerXml (const char *&out_csXml)
 Reads all the contents of an Element or Attribute as a string, including markup. Increments the pointer. More...
 
void ReadOuterXml (const char *&out_csXml)
 Reads the Element or Attribute as a string, including markup. Increments the pointer. More...
 
void Skip ()
 Sets the reading pointer past the current node, skipping any inner content. More...
 
bool GetAttribute (const char *in_rcsAttributeName, const char *&out_rcsValue)
 Reads the value of a particular attribute under the current node. More...
 
- Public Member Functions inherited from ak_wwise_plugin_cpp_base_instance
virtual ~ak_wwise_plugin_cpp_base_instance ()
 

Additional Inherited Members

- Static Public Attributes inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostXml >
static GluedInterfaceg_cinterface
 The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host once loaded. 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 529 of file HostXml.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