Version

    Other Documentation

menu_open

◆ SetMediaSource

bool(* ak_wwise_plugin_host_object_media_v1::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.

This will copy the file in the project under the file name specified in in_pszFilePathToImport, and create or replace a Media Source at the given index.

Note: You must add up indexes sequentially. If you have 0-14 indexes, adding a new one at 40 will create it at 15. If you want to have empty spaces for indexes, add empty media sources with a nullptr in_pszFilePathToImport sequentially. Pass (unsigned int)-1 as the in_Index to insert at the end of the list.
Warning: You should not put the same file in two different indexes.
Parameters
[in] in_this Current instance of this interface.
[in] in_pszFilePathToImport (Optional) File path. Can be nullptr if the plug-in generates this file, or if the file is not yet available.
[in] in_Index Media source index. If higher than or equal to the current media source count, will add a new index.
[in] in_bReplace True to replace a file under the same name. False will succeed if the file already exists.
Returns
true if succeeded.

Definition at line 84 of file HostObjectMedia.h.

Referenced by AK.Wwise::Plugin::V1::ObjectMedia::SetMediaSource().


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