Version
menu_open
Wwise SDK 2024.1.1
Classes | Namespaces | Macros | Typedefs | Enumerations | Functions
HostXml.h File Reference

Wwise Authoring Plug-ins - API for XML-based persistence, as used in CustomData. More...

#include "PluginInfoGenerator.h"

Go to the source code of this file.

Classes

struct  ak_wwise_plugin_host_xml_v1
 API interface for XML-based plug-in persistence. More...
 
class  AK.Wwise::Plugin::V1::XmlReader
 API interface for XML-based plug-in persistence. More...
 
class  AK.Wwise::Plugin::V1::XmlWriter
 API interface for XML-based plug-in persistence. More...
 
class  AK.Wwise::Plugin::V1::XmlWriter::AutoStartEndElement
 Use this class to handle the WriteStartElement/WriteEndElement pair automatically in a C++ scope. More...
 
class  AK.Wwise::Plugin::RequestedHostInterface< XmlReader >
 
class  AK.Wwise::Plugin::RequestedHostInterface< XmlWriter >
 

Namespaces

namespace  AK
 Definition of data structures for AkAudioObject.
 
namespace  AK.Wwise
 
 AK::Wwise::Plugin
 
 AK::Wwise::Plugin::XmlWhiteSpaceHandling
 
 AK::Wwise::Plugin::XmlNodeType
 Types of possible XML elements. See MSDN documentation topics for XmlNodeType.
 
 AK::Wwise::Plugin::XmlWriteState
 
 AK::Wwise::Plugin::XmlWriteReady
 Possible error codes when writing XML.
 
 AK::Wwise::Plugin::XmlElementType
 
 AK::Wwise::Plugin::V1
 

Macros

#define AK_WWISE_PLUGIN_HOST_XML_V1_ID()    AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_XML, 1)
 
#define AK_WWISE_PLUGIN_HOST_XML_V1_CTOR()
 

Typedefs

using AK::Wwise::Plugin::V1::CHostXml = ak_wwise_plugin_host_xml_v1
 
using AK::Wwise::Plugin::V1::RequestXml = RequestedHostInterface< XmlReader >
 Requests the XML processing interface. More...
 
using AK::Wwise::Plugin::CHostXml = V1::CHostXml
 Latest version of the C XML interface. More...
 
using AK::Wwise::Plugin::XmlReader = V1::XmlReader
 Latest version of the C++ XmlReader interface. More...
 
using AK::Wwise::Plugin::XmlWriter = V1::XmlWriter
 Latest version of the C++ XmlWriter interface. More...
 
using AK::Wwise::Plugin::RequestXml = V1::RequestXml
 Latest version of the requested C++ XML interface. More...
 

Enumerations

enum  AK::Wwise::Plugin::XmlWhiteSpaceHandling::WhiteSpaceHandling { AK::Wwise::Plugin::XmlWhiteSpaceHandling::All, AK::Wwise::Plugin::XmlWhiteSpaceHandling::None, AK::Wwise::Plugin::XmlWhiteSpaceHandling::Significant }
 See MSDN documentation. More...
 
enum  AK::Wwise::Plugin::XmlNodeType::NodeType {
  AK::Wwise::Plugin::XmlNodeType::Attribute = 2, AK::Wwise::Plugin::XmlNodeType::CDATA = 4, AK::Wwise::Plugin::XmlNodeType::Comment = 8, AK::Wwise::Plugin::XmlNodeType::Document = 9,
  AK::Wwise::Plugin::XmlNodeType::DocumentFragment = 11, AK::Wwise::Plugin::XmlNodeType::DocumentType = 10, AK::Wwise::Plugin::XmlNodeType::Element = 1, AK::Wwise::Plugin::XmlNodeType::EndElement = 15,
  AK::Wwise::Plugin::XmlNodeType::EndEntity = 16, AK::Wwise::Plugin::XmlNodeType::Entity = 6, AK::Wwise::Plugin::XmlNodeType::EntityReference = 5, AK::Wwise::Plugin::XmlNodeType::None = 0,
  AK::Wwise::Plugin::XmlNodeType::Notation = 12, AK::Wwise::Plugin::XmlNodeType::ProcessingInstruction = 7, AK::Wwise::Plugin::XmlNodeType::SignificantWhitespace = 14, AK::Wwise::Plugin::XmlNodeType::Text = 3,
  AK::Wwise::Plugin::XmlNodeType::Whitespace = 13, AK::Wwise::Plugin::XmlNodeType::XmlDeclaration = 17
}
 
enum  AK::Wwise::Plugin::XmlWriteState::WriteState {
  AK::Wwise::Plugin::XmlWriteState::Attribute, AK::Wwise::Plugin::XmlWriteState::Closed, AK::Wwise::Plugin::XmlWriteState::Content, AK::Wwise::Plugin::XmlWriteState::Element,
  AK::Wwise::Plugin::XmlWriteState::Prolog, AK::Wwise::Plugin::XmlWriteState::Start
}
 WriteState. More...
 
enum  AK::Wwise::Plugin::XmlWriteReady::WriteReady { AK::Wwise::Plugin::XmlWriteReady::Ready, AK::Wwise::Plugin::XmlWriteReady::ErrorPathTooLong, AK::Wwise::Plugin::XmlWriteReady::ErrorAccessDenied, AK::Wwise::Plugin::XmlWriteReady::ErrorUnknown }
 Possible error codes when writing XML. More...
 
enum  AK::Wwise::Plugin::XmlElementType::ElementType { AK::Wwise::Plugin::XmlElementType::Map, AK::Wwise::Plugin::XmlElementType::Array, AK::Wwise::Plugin::XmlElementType::MultiMap }
 These element types have an impact when outputting in alternate formats such as JSON. More...
 

Functions

 AK::Wwise::Plugin::AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS (XmlReader)
 
 AK::Wwise::Plugin::AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION (XmlReader)
 

Detailed Description

Wwise Authoring Plug-ins - API for XML-based persistence, as used in CustomData.

Definition in 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