WwiseItem.h File Reference

#include <stdint.h>
#include <string>
#include <vector>
#include <memory>
#include <initializer_list>

Go to the source code of this file.

Classes
struct	WwiseItem
struct	WwiseSoundbank
struct	WwiseEvent
struct	WwiseSwitchGroup
struct	WwiseSwitch
struct	WwiseStateGroup
struct	WwiseState
struct	WwiseGameParameter
struct	WwiseBus
struct	WwiseAuxBus

Macros
#define	CREATE_STRUCT_PTR_TYPES(x)

Enumerations
enum class	WwiseType : uint8_t {   Unknown , None , TreeRoot , RootDirectory ,   WorkUnit , VirtualFolder , Event , Bus ,   AuxBus , SwitchGroup , Switch , StateGroup ,   State , GameParameter , Effect , Trigger ,   AudioDevice , SoundBank }

Macro Definition Documentation

CREATE_STRUCT_PTR_TYPES

#define CREATE_STRUCT_PTR_TYPES

(

x

)

Value:

struct x; \
typedef std::shared_ptr<x> x##Ptr; \
typedef std::weak_ptr<x> x##WeakPtr;

Definition at line 36 of file WwiseItem.h.

{
    std::string Name;
    std::string Path;
    std::string GUID;
    uint32_t ShortID;
    WwiseType Type;
    std::vector<WwiseItemPtr> Children;
 
    bool IsOnDisk = false;  // true if this item existsa in one of the xml files.
    bool IsInBank = false;  // true if the item exists is one of the bank (.bnk)
    bool IsInWwise = false; // true if the item exits in the Wwise project (availible via WAAPI)
 
    static WwiseItemPtr Create();
 
    bool HasValidShortID();
    bool IsAnyOfType(std::initializer_list<WwiseType> types) const;
    bool IsDirectory() const;
    void AddChildren(std::shared_ptr<WwiseItem> newChild);
    bool HasChildren() const;
    bool IsEvent() const;
 
    WwiseType GetContainerType() const;
 
    std::string GetTypeName() const;
};
 
CREATE_STRUCT_PTR_TYPES(WwiseSoundbank)
struct WwiseSoundbank : public WwiseItem
{
    std::string Language;
    std::string ObjectPath;
    bool IsUserBank;
    bool IsInitBank;
    bool IsValid;
 
    static WwiseSoundbankPtr Create()
    {
        auto item = std::make_shared<WwiseSoundbank>();
        item->Type = WwiseType::SoundBank;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseEvent)
struct WwiseEvent : public WwiseItem
{
    float MaxAttenuation;
    float MinDuration;
    float MaxDuration;
 
    uint32_t SoundbankShortId;
 
    static WwiseEventPtr Create()
    {
        auto item = std::make_shared<WwiseEvent>();
        item->Type = WwiseType::Event;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseSwitchGroup)
struct WwiseSwitchGroup : public WwiseItem
{
    static WwiseSwitchGroupPtr Create()
    {
        auto item = std::make_shared<WwiseSwitchGroup>();
        item->Type = WwiseType::SwitchGroup;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseSwitch)
struct WwiseSwitch : public WwiseItem
{
    uint32_t GroupShortId;
 
    static WwiseSwitchPtr Create()
    {
        auto item = std::make_shared<WwiseSwitch>();
        item->Type = WwiseType::Switch;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseStateGroup)
struct WwiseStateGroup : public WwiseItem
{
    static WwiseStateGroupPtr Create()
    {
        auto item = std::make_shared<WwiseStateGroup>();
        item->Type = WwiseType::StateGroup;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseState)
struct WwiseState : public WwiseItem
{
    uint32_t GroupShortId;
 
    static WwiseStatePtr Create()
    {
        auto item = std::make_shared<WwiseState>();
        item->Type = WwiseType::State;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseGameParameter)
struct WwiseGameParameter : public WwiseItem
{
    double InitialValue;
    double Min;
    double Max;
 
    static WwiseGameParameterPtr Create()
    {
        auto item = std::make_shared<WwiseGameParameter>();
        item->Type = WwiseType::GameParameter;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseBus)
struct WwiseBus : public WwiseItem
{
    static WwiseBusPtr Create()
    {
        auto item = std::make_shared<WwiseBus>();
        item->Type = WwiseType::Bus;
        return item;
    }
};
 
CREATE_STRUCT_PTR_TYPES(WwiseAuxBus)
struct WwiseAuxBus : public WwiseItem
{
    static WwiseAuxBusPtr Create()
    {
        auto item = std::make_shared<WwiseAuxBus>();
        item->Type = WwiseType::AuxBus;
        return item;
    }
};
 
#pragma warning(pop)

Enumeration Type Documentation

WwiseType

enum class WwiseType : uint8_t

strong

Enumerator
Unknown
None
TreeRoot
RootDirectory
WorkUnit
VirtualFolder
Event
Bus
AuxBus
SwitchGroup
Switch
StateGroup
State
GameParameter
Effect
Trigger
AudioDevice
SoundBank

Definition at line 9 of file WwiseItem.h.

{
    Unknown,
    None,
 
    TreeRoot,
    RootDirectory,
    WorkUnit,
    VirtualFolder,
 
    Event,
    Bus,
    AuxBus,
    SwitchGroup,
    Switch,
    StateGroup,
    State,
    GameParameter,
    Effect,
    Trigger,
    AudioDevice,
    SoundBank,
};