◆ ConvertFile

AK::Wwise::Plugin::ConversionResult(* ak_wwise_plugin_media_converter_v1::ConvertFile) (const struct ak_wwise_plugin_media_converter_instance_v1 *in_this, const GUID *in_guidPlatform, const BasePlatformID *in_basePlatform, const AkOSChar *in_szSourceFile, const AkOSChar *in_szDestFile, AkUInt32 in_uSampleRate, AkUInt32 in_uBlockLength, AK::Wwise::Plugin::IProgress *in_pProgress, AK::Wwise::Plugin::IWriteString *io_pError)

Converts a file.

Note: If the conversion failed the function is responsible for deleting any files that may have been created, even the destination file in case of error. If the function returns false we will use the string put in io_pError to display an error message.

Parameters

[in]	in_this	Current instance of this interface.
[in]	in_guidPlatform	The unique ID of the custom platform being converted for.
[in]	in_basePlatform	The unique ID of the base platform being converted for.
[in]	in_szSourceFile	Source File to convert data from.
[in]	in_szDestFile	Destination File, must be created by the plug-in.
[in]	in_uSampleRate	The target sample rate for the converted file, passing 0 will default to the platform default.
[in]	in_uBlockLength	The block length, passing 0 will default to the platform default.
[in]	in_pProgress	Optional Progress Bar controller.
	io_pError	Optional error string that can be displayed if ConversionResult is not successful.

Returns: Whether the conversion was successful or not.

Definition at line 77 of file MediaConverter.h.

Referenced by AK.Wwise::Plugin::V1::MediaConverter::Interface::Interface().

Wwise SDK

ConvertFile

◆ ConvertFile

Was this page helpful?

Need Support?

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