Version

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

More...

#include <HostObjectMedia.h>

Inheritance diagram for AK.Wwise::Plugin::V1::ObjectMedia:
AK.Wwise::Plugin::CBaseInstanceGlue< CHostObjectMedia > AK.Wwise::Plugin::CBaseInterfaceGlue< CHostObjectMedia >

Public Types

enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_MEDIA }
 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 = CHostObjectMedia
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInstanceGlue< CHostObjectMedia >
using Instance = typename CInterface::Instance
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostObjectMedia >
using GluedInterface = CHostObjectMedia
 

Public Member Functions

bool SetMediaSource (const AkOSChar *in_pszFilePathToImport, unsigned int in_Index, bool in_bReplace)
 Requests to set the specified file as a data input file. More...
 
void RemoveMediaSource (unsigned int in_Index)
 Requests to remove the specified index file as data input file. More...
 
unsigned int GetMediaSourceCount () const
 Retrieve the number of media source indexes. More...
 
unsigned int GetMediaSourceFileName (AkOSChar *out_pszFileName, unsigned int in_uiBufferSize, unsigned int in_Index) const
 Retrieve the file name of the source plug-in data at the specified index, as provided in SetMediaSource. More...
 
unsigned int GetMediaSourceOriginalFilePath (AkOSChar *out_pszFilePath, unsigned int in_uiBufferSize, unsigned int in_Index) const
 Retrieve the full file path of the source plug-in data at the specified index. More...
 
unsigned int GetMediaSourceConvertedFilePath (AkOSChar *out_pszFilePath, unsigned int in_uiBufferSize, const GUID &in_guidPlatform, unsigned int in_Index) const
 Retrieve the full file path of the converted plug-in data at the specified index. More...
 
void InvalidateMediaSource (unsigned int in_Index)
 Request Wwise to perform any required conversion on the data. More...
 
unsigned int GetOriginalDirectory (AkOSChar *out_pszDirectory, unsigned int in_uiBufferSize) const
 Obtain the Original directory for the plug-in. More...
 
unsigned int GetConvertedDirectory (AkOSChar *out_pszDirectory, unsigned int in_uiBufferSize, const GUID &in_guidPlatform) const
 Obtain the Converted directory for the plug-in and platform. More...
 

Additional Inherited Members

- Static Public Attributes inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostObjectMedia >
static GluedInterfaceg_cinterface
 The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host once loaded. More...
 

Detailed Description

Plug-in object media interface. Can be used to normalize media file handling inside the project.

Definition at line 298 of file HostObjectMedia.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