Wwise SDK
_host_object_media_8h_source
版本
menu_open
link
HostObjectMedia.h
浏览该文件的文档.
28 * \brief Wwise Authoring Plug-ins - API for retrieving and handling data files, as used in the plug-in.
39 * Plug-in object media interface. Can be used to normalize media file handling inside the project.
62 * This will copy the file in the project under the file name specified in in_pszFilePathToImport, and
66 * You must add up indexes sequentially. If you have 0-14 indexes, adding a new one at 40 will create it at 15.
67 * If you want to have empty spaces for indexes, add empty media sources with a nullptr in_pszFilePathToImport
68 * sequentially. Pass <code>(unsigned int)-1</code> as the in_Index to insert at the end of the list.
76 * \param[in] in_pszFilePathToImport (Optional) File path. Can be nullptr if the plug-in generates this file, or
78 * \param[in] in_Index Media source index. If higher than or equal to the current media source count, will
80 * \param[in] in_bReplace True to replace a file under the same name. False will succeed if the file already exists.
93 * This will not renumber the supplemental index, it will merely remove the file from that index, if existing.
114 * \brief Retrieve the file name of the source plug-in data at the specified index, as provided in SetMediaSource.
116 * Used to allow the plug-in to display this information. This is the file name, and doesn't include any path.
119 * If you do not provide a buffer big enough to write the full string, the function will fail and return
143 * If you do not provide a buffer big enough to write the full string, the function will fail and return
165 * If you do not provide a buffer big enough to write the full string, the function will fail and return
203 * If you do not provide a buffer big enough to write the full string, the function will fail and return
223 * If you do not provide a buffer big enough to write the full string, the function will fail and return
264 * It is called when plugin media is added, removed or changes. This function is also called during undo or redo operations.
271 void(*NotifyPluginMediaChanged)(struct ak_wwise_plugin_notifications_object_media_instance_v1* in_this);
283 AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_MEDIA, 1)
284 #define AK_WWISE_PLUGIN_NOTIFICATIONS_OBJECT_MEDIA_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
286 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_NOTIFICATIONS_OBJECT_MEDIA_V1_ID(), in_pluginInfo, in_data) \
312 };
322 };
327 * This will copy the file in the project under the file name specified in in_pszFilePathToImport, and
331 * You must add up indexes sequentially. If you have 0-14 indexes, adding a new one at 40 will create it at 15.
332 * If you want to have empty spaces for indexes, add empty media sources with a nullptr in_pszFilePathToImport
333 * sequentially. Pass <code>(unsigned int)-1</code> as the in_Index to insert at the end of the list.
340 * \param[in] in_pszFilePathToImport (Optional) File path. Can be nullptr if the plug-in generates this file, or
342 * \param[in] in_Index Media source index. If higher than or equal to the current media source count, will
344 * \param[in] in_bReplace True to replace a file under the same name. False will succeed if the file already exists.
353 return MKBOOL(g_cinterface->SetMediaSource(this, in_pszFilePathToImport, in_Index, in_bReplace));
359 * This will not renumber the supplemental index, it will merely remove the file from that index, if existing.
381 * \brief Retrieve the file name of the source plug-in data at the specified index, as provided in SetMediaSource.
383 * Used to allow the plug-in to display this information. This is the file name, and doesn't include any path.
386 * If you do not provide a buffer big enough to write the full string, the function will fail and return
411 * If you do not provide a buffer big enough to write the full string, the function will fail and return
427 return g_cinterface->GetMediaSourceOriginalFilePath(this, out_pszFilePath, in_uiBufferSize, in_Index);
434 * If you do not provide a buffer big enough to write the full string, the function will fail and return
452 return g_cinterface->GetMediaSourceConvertedFilePath(this, out_pszFilePath, in_uiBufferSize, &in_guidPlatform, in_Index);
474 * If you do not provide a buffer big enough to write the full string, the function will fail and return
495 * If you do not provide a buffer big enough to write the full string, the function will fail and return
511 return g_cinterface->GetConvertedDirectory(this, out_pszDirectory, in_uiBufferSize, &in_guidPlatform);
537 };
547 };
586 * It is called when plugin media is added, removed or changes. This function is also called during undo or redo operations.
598 * Deriving your plug-in class from RequestObjectMedia will automatically request both ObjectMedia and
599 * Notifications::ObjectMedia_ interfaces. From this point, you will be able to derive from the virtual
600 * functions as defined in Notifications::ObjectMedia_, and access the host-provided functions in the
622 AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(ObjectMedia, objectMedia,, public Notifications::ObjectMedia);
ak_wwise_plugin_host_object_media_v1()
Definition: HostObjectMedia.h:54
void RemoveMediaSource(unsigned int in_Index)
Requests to remove the specified index file as data input file.
Definition: HostObjectMedia.h:363
The C interface, fulfilled by your plug-in.
Definition: HostObjectMedia.h:553
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.
Definition: HostObjectMedia.h:445
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: HostObjectMedia.h:546
InterfacePtr GetInterfacePointer()
Definition: HostObjectMedia.h:565
void(* NotifyPluginMediaChanged)(struct ak_wwise_plugin_notifications_object_media_instance_v1 *in_this)
This function is called by Wwise when any of the plug-in media changes.
Definition: HostObjectMedia.h:271
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.
Definition: HostObjectMedia.h:505
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 SetMediaSour...
Definition: HostObjectMedia.h:130
Base host-provided instance type for ak_wwise_plugin_host_object_media_v1.
Definition: PluginDef.h:642
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:89
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.
Definition: HostObjectMedia.h:98
ObjectMedia_()
Definition: HostObjectMedia.h:576
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface
Definition: PluginInfoGenerator.h:50
void InvalidateMediaSource(unsigned int in_Index)
Request Wwise to perform any required conversion on the data.
Definition: HostObjectMedia.h:463
unsigned int GetOriginalDirectory(AkOSChar *out_pszDirectory, unsigned int in_uiBufferSize) const
Obtain the Original directory for the plug-in.
Definition: HostObjectMedia.h:483
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.
Definition: HostObjectMedia.h:83
ak_wwise_plugin_notifications_object_media_instance_v1 Instance
Base instance type for receiving notifications on related object media's changes.
Definition: HostObjectMedia.h:254
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: HostObjectMedia.h:321
unsigned int GetMediaSourceCount() const
Retrieve the number of media source indexes.
Definition: HostObjectMedia.h:375
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.
Definition: HostObjectMedia.h:154
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
PluginInfoGenerator: Associates an existing C Interface with a variable that can be used....
Definition: PluginInfoGenerator.h:104
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.
Definition: HostObjectMedia.h:213
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.
Definition: HostObjectMedia.h:234
bool SetMediaSource(const AkOSChar *in_pszFilePathToImport, unsigned int in_Index, bool in_bReplace)
Requests to set the specified file as a data input file.
Definition: HostObjectMedia.h:347
RequestedHostInterface< ObjectMedia > RequestObjectMedia
Requests a ObjectMedia interface, provided as m_objectMedia variable.
Definition: HostObjectMedia.h:603
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_MEDIA
2021.1 Object Media host service. ak_wwise_plugin_host_object_media_v1
Definition: PluginBaseInterface.h:78
ak_wwise_plugin_notifications_object_media_v1 CObjectMedia_
Definition: HostObjectMedia.h:517
ak_wwise_plugin_host_object_media_v1 CHostObjectMedia
Definition: HostObjectMedia.h:295
virtual void NotifyPluginMediaChanged()
This function is called by Wwise when any of the plug-in media changes.
Definition: HostObjectMedia.h:591
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface
Definition: PluginInfoGenerator.h:49
Interface()
Definition: HostObjectMedia.h:555
CObjectMedia_::Instance * GetInstancePointer()
Definition: HostObjectMedia.h:569
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
ak_wwise_plugin_notifications_object_media_v1()
Definition: HostObjectMedia.h:256
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.
Definition: HostObjectMedia.h:177
const CObjectMedia_::Instance * GetInstancePointer() const
Definition: HostObjectMedia.h:572
Base instance type for receiving notifications on related object media's changes.
Definition: PluginDef.h:837
unsigned int(* GetMediaSourceCount)(const struct ak_wwise_plugin_host_object_media_instance_v1 *in_this)
Retrieve the number of media source indexes.
Definition: HostObjectMedia.h:109
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.
Definition: HostObjectMedia.h:194
#define AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(in_name, in_varname,...)
PluginInfoGenerator: Creates a C++ host specialization for interface class specified in in_name,...
Definition: PluginInfoGenerator.h:237
virtual ~ObjectMedia_()
Definition: HostObjectMedia.h:581
V1::Notifications::ObjectMedia_ ObjectMedia
Latest version of the C++ ObjectMedia notification interface.
Definition: HostObjectMedia.h:619
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 SetMediaSour...
Definition: HostObjectMedia.h:396
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
Definition: PluginHelpers.h:45
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_MEDIA
2021.1 Object Media modification notification. ak_wwise_plugin_notifications_object_media_v1
Definition: PluginBaseInterface.h:65
Definition: AudioPlugin.h:111
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.
Definition: HostObjectMedia.h:421