Version

menu_open
Wwise SDK 2023.1.2
ak_wwise_plugin_host_object_media_v1 Struct Reference

#include <HostObjectMedia.h>

Inheritance diagram for ak_wwise_plugin_host_object_media_v1:
ak_wwise_plugin_interface_ptr

Public Types

using Instance = ak_wwise_plugin_host_object_media_instance_v1
 Base host-provided instance type for ak_wwise_plugin_host_object_media_v1. More...
 

Public Member Functions

 ak_wwise_plugin_host_object_media_v1 ()
 
- Public Member Functions inherited from ak_wwise_plugin_interface_ptr
constexpr ak_wwise_plugin_base_interface (decltype(m_interface) in_interface, decltype(m_version) in_version)
 
constexpr ak_wwise_plugin_base_interface ()
 
constexpr ak_wwise_plugin_base_interface (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
 

Public Attributes

bool(* SetMediaSource )(struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, unsigned int in_Index)
 Requests to remove the specified index file as data input file. More...
 
unsigned int(* GetMediaSourceCount )(const struct ak_wwise_plugin_host_object_media_instance_v1 *in_this)
 Retrieve the number of media source indexes. More...
 
unsigned int(* GetMediaSourceFileName )(const struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, AkOSChar *out_pszFileName, unsigned int in_uiBufferSize, unsigned int in_Index)
 Retrieve the file name of the source plug-in data at the specified index, as provided in SetMediaSource. More...
 
unsigned int(* GetMediaSourceOriginalFilePath )(const struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, AkOSChar *out_pszFilePath, unsigned int in_uiBufferSize, unsigned int in_Index)
 Retrieve the full file path of the source plug-in data at the specified index. More...
 
unsigned int(* GetMediaSourceConvertedFilePath )(const struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, AkOSChar *out_pszFilePath, unsigned int in_uiBufferSize, const GUID *in_guidPlatform, unsigned int in_Index)
 Retrieve the full file path of the converted plug-in data at the specified index. More...
 
void(* InvalidateMediaSource )(struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, unsigned int in_Index)
 Request Wwise to perform any required conversion on the data. More...
 
unsigned int(* GetOriginalDirectory )(const struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, AkOSChar *out_pszDirectory, unsigned int in_uiBufferSize)
 Obtain the Original directory for the plug-in. More...
 
unsigned int(* GetConvertedDirectory )(const struct ak_wwise_plugin_host_object_media_instance_v1 *in_this, AkOSChar *out_pszDirectory, unsigned int in_uiBufferSize, const GUID *in_guidPlatform)
 Obtain the Converted directory for the plug-in and platform. More...
 
- Public Attributes inherited from ak_wwise_plugin_interface_ptr
ak_wwise_plugin_interface_type m_interface: 32
 Interface type (see ak_wwise_plugin_interface_type) More...
 
uint32_t m_version: 32
 Version of the interface. More...
 

Detailed Description

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

Definition at line 41 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