Version
menu_open
Attention : vous avez été redirigé vers la plus récente documentation correspondant à votre version générale ( 2023.1.8.8601 ). Si vous souhaitez accéder à la documentation de votre version précise, veuillez télécharger la documentation hors ligne depuis l'Audiokinetic Launcher et sélectionner l'option de documentation Offline dans l'application de création Wwise.
Wwise SDK 2023.1.8
HostObjectMedia.h
Go to the documentation of this file.
ak_wwise_plugin_host_object_media_v1::ak_wwise_plugin_host_object_media_v1
ak_wwise_plugin_host_object_media_v1()
Definition: HostObjectMedia.h:54
AK.Wwise::Plugin::V1::ObjectMedia::RemoveMediaSource
void RemoveMediaSource(unsigned int in_Index)
Requests to remove the specified index file as data input file.
Definition: HostObjectMedia.h:363
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::Interface
The C interface, fulfilled by your plug-in.
Definition: HostObjectMedia.h:553
AK.Wwise::Plugin::V1::ObjectMedia::GetMediaSourceConvertedFilePath
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
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::k_interfaceVersion
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: HostObjectMedia.h:546
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::GetInterfacePointer
InterfacePtr GetInterfacePointer()
Definition: HostObjectMedia.h:565
ak_wwise_plugin_notifications_object_media_v1::NotifyPluginMediaChanged
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
AK.Wwise::Plugin::V1::ObjectMedia::GetConvertedDirectory
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
ak_wwise_plugin_host_object_media_v1::GetMediaSourceFileName
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
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_
Definition: HostObjectMedia.h:521
ak_wwise_plugin_host_object_media_instance_v1
Base host-provided instance type for ak_wwise_plugin_host_object_media_v1.
Definition: PluginDef.h:642
AK.Wwise::Plugin::CBaseInterfaceGlue< CHostObjectMedia >::g_cinterface
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:89
ak_wwise_plugin_host_object_media_v1::RemoveMediaSource
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
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::ObjectMedia_
ObjectMedia_()
Definition: HostObjectMedia.h:576
AK.Wwise::Plugin::InterfaceVersion
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:50
AK.Wwise::Plugin::V1::ObjectMedia::InvalidateMediaSource
void InvalidateMediaSource(unsigned int in_Index)
Request Wwise to perform any required conversion on the data.
Definition: HostObjectMedia.h:463
AK.Wwise::Plugin::V1::ObjectMedia::GetOriginalDirectory
unsigned int GetOriginalDirectory(AkOSChar *out_pszDirectory, unsigned int in_uiBufferSize) const
Obtain the Original directory for the plug-in.
Definition: HostObjectMedia.h:483
ak_wwise_plugin_host_object_media_v1::SetMediaSource
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
AkOSChar
char AkOSChar
Generic character string.
Definition: AkTypes.h:60
ak_wwise_plugin_notifications_object_media_v1::Instance
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
AK.Wwise::Plugin::V1::ObjectMedia::k_interfaceVersion
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: HostObjectMedia.h:321
AK.Wwise::Plugin::V1::ObjectMedia::GetMediaSourceCount
unsigned int GetMediaSourceCount() const
Retrieve the number of media source indexes.
Definition: HostObjectMedia.h:375
ak_wwise_plugin_host_object_media_v1::GetMediaSourceOriginalFilePath
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
PluginInfoGenerator.h
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
AK.Wwise::Plugin::CBaseInstanceGlue
PluginInfoGenerator: Associates an existing C Interface with a variable that can be used....
Definition: PluginInfoGenerator.h:104
AK.Wwise::Plugin::InterfacePtr
CInterfacePtr InterfacePtr
Definition: PluginDef.h:995
ak_wwise_plugin_host_object_media_v1::GetOriginalDirectory
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
ak_wwise_plugin_host_object_media_v1::GetConvertedDirectory
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
AK.Wwise::Plugin::V1::ObjectMedia::SetMediaSource
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
AK.Wwise::Plugin::V1::RequestObjectMedia
RequestedHostInterface< ObjectMedia > RequestObjectMedia
Requests a ObjectMedia interface, provided as m_objectMedia variable.
Definition: HostObjectMedia.h:603
AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_MEDIA
@ 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::V1::Notifications::CObjectMedia_
ak_wwise_plugin_notifications_object_media_v1 CObjectMedia_
Definition: HostObjectMedia.h:517
AK.Wwise::Plugin::V1::CHostObjectMedia
ak_wwise_plugin_host_object_media_v1 CHostObjectMedia
Definition: HostObjectMedia.h:295
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::NotifyPluginMediaChanged
virtual void NotifyPluginMediaChanged()
This function is called by Wwise when any of the plug-in media changes.
Definition: HostObjectMedia.h:591
AK.Wwise::Plugin::InterfaceTypeValue
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:49
ak_wwise_plugin_host_object_media_v1
Definition: HostObjectMedia.h:45
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::Interface::Interface
Interface()
Definition: HostObjectMedia.h:555
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::GetInstancePointer
CObjectMedia_::Instance * GetInstancePointer()
Definition: HostObjectMedia.h:569
AK.Wwise::Plugin::AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
ak_wwise_plugin_base_interface
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::k_interfaceType
@ k_interfaceType
The interface type, as provided by this plug-in.
Definition: HostObjectMedia.h:536
ak_wwise_plugin_notifications_object_media_v1::ak_wwise_plugin_notifications_object_media_v1
ak_wwise_plugin_notifications_object_media_v1()
Definition: HostObjectMedia.h:256
ak_wwise_plugin_host_object_media_v1::GetMediaSourceConvertedFilePath
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
AK.Wwise::Plugin::V1::ObjectMedia::k_interfaceType
@ k_interfaceType
The interface type, as requested by this plug-in.
Definition: HostObjectMedia.h:311
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::GetInstancePointer
const CObjectMedia_::Instance * GetInstancePointer() const
Definition: HostObjectMedia.h:572
MKBOOL
#define MKBOOL(cond)
Definition: PluginHelpers.h:74
ak_wwise_plugin_notifications_object_media_instance_v1
Base instance type for receiving notifications on related object media's changes.
Definition: PluginDef.h:837
ak_wwise_plugin_host_object_media_v1::GetMediaSourceCount
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
ak_wwise_plugin_host_object_media_v1::InvalidateMediaSource
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
AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE
#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
AK.Wwise::Plugin::V1::Notifications::ObjectMedia_::~ObjectMedia_
virtual ~ObjectMedia_()
Definition: HostObjectMedia.h:581
ak_wwise_plugin_notifications_object_media_v1
Definition: HostObjectMedia.h:247
AK.Wwise::Plugin::Notifications::ObjectMedia
V1::Notifications::ObjectMedia_ ObjectMedia
Latest version of the C++ ObjectMedia notification interface.
Definition: HostObjectMedia.h:619
AK.Wwise::Plugin::V1::ObjectMedia::GetMediaSourceFileName
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::AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_MEDIA
@ 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
AK.Wwise::Plugin::V1::ObjectMedia::GetMediaSourceOriginalFilePath
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

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise