Wwise Audio Tools  0.5.2
Tools for working with Wwise file types
wwtools::bnk Namespace Reference

contains helper functions for Wwise Soundbank files More...

Functions

void extract (const std::string &indata, std::vector< std::string > &outdata)
 Extract BNK to array of WEMS. More...
 
std::string get_info (const std::string &indata)
 get the info string More...
 
std::string get_event_id_info (const std::string &indata, const std::string &in_event_id)
 get WEMs correlating to a BNK and an optional event ID More...
 
std::string get_wem_id_at_index (const std::string &indata, const int &index)
 get the ID of a WEM at an index More...
 
std::string get_event_name_from_id (const std::uint32_t &event_id)
 
std::string get_event_action_type (bnk_t::action_type_t action_type)
 get a string with the action type from the enum More...
 

Detailed Description

contains helper functions for Wwise Soundbank files

Function Documentation

◆ extract()

void wwtools::bnk::extract ( const std::string &  indata,
std::vector< std::string > &  outdata 
)

Extract BNK to array of WEMS.

Parameters
indatastd::string with the BNK content
outdatavector of std::string that has all the embedded WEM files

◆ get_event_action_type()

std::string wwtools::bnk::get_event_action_type ( bnk_t::action_type_t  action_type)

get a string with the action type from the enum

Parameters
action_typean action type to be converted to string
Returns
the string name of the action type

◆ get_event_id_info()

std::string wwtools::bnk::get_event_id_info ( const std::string &  indata,
const std::string &  in_event_id 
)

get WEMs correlating to a BNK and an optional event ID

Parameters
indatastd::string with the file data
in_event_idthe input event ID
Returns
a printable info string

◆ get_info()

std::string wwtools::bnk::get_info ( const std::string &  indata)

get the info string

Parameters
indatastd::string with the file data
Returns
a printable info string

◆ get_wem_id_at_index()

std::string wwtools::bnk::get_wem_id_at_index ( const std::string &  indata,
const int &  index 
)

get the ID of a WEM at an index

Parameters
indatastd::string with the file data
indexthe index to get the ID from
Returns
the ID as a string