Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

◆ GetMediaSourceFileName

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

Used to allow the plug-in to display this information. This is the file name, and doesn't include any path.

Warning: If you do not provide a buffer big enough to write the full string, the function will fail and return 0. Make sure to use a buffer big enough to write the entire string, such as your platform's max path size.
Parameters
[in]in_thisCurrent instance of this interface.
[out]out_pszFileNameBuffer that will contain the file name.
[in]in_uiBufferSizeSize of the provided string buffer.
[in]in_IndexMedia source index to query.
Returns
Number of characters written to the buffer. 0 means no file, or failure.

Definition at line 130 of file HostObjectMedia.h.

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

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