◆ GetMediaSourceFileName()

unsigned int AK.Wwise::Plugin::V1::ObjectMedia::GetMediaSourceFileName	(	AkOSChar *	out_pszFileName,
		unsigned int	in_uiBufferSize,
		unsigned int	in_Index
	)		const

inline

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

[out]	out_pszFileName	Buffer that will contain the file name.
[in]	in_uiBufferSize	Size of the provided string buffer.
[in]	in_Index	Media source index to query.

Returns: Number of characters written to the buffer. 0 means no file, or failure.

Definition at line 397 of file HostObjectMedia.h.

References AK.Wwise::Plugin::CBaseInterfaceGlue< CHostObjectMedia >::g_cinterface, and ak_wwise_plugin_host_object_media_v1::GetMediaSourceFileName.

Wwise SDK 2021.1.14

GetMediaSourceFileName

◆ GetMediaSourceFileName()

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.