Wwise SDK

Computes gain matrix for decoding an SN3D-normalized ACN-ordered ambisonic signal of order sqrt(in_cfgAmbisonics.uNumChannels)-1, with max-RE weighting function, on a (regularly) sampled sphere whose samples in_samples are expressed in left-handed cartesian coordinates, with unitary norm. This decoding technique is optimal for regular sampling. The returned matrix has in_cfgAmbisonics.uNumChannels inputs (rows) and in_uNumSamples outputs (columns), and is normalized by the number of samples. You may use the returned volume matrix with IAkPluginServiceMixer::MixNinNChannels. Supported ambisonic configurations are full-sphere 1st to 5th order.

Returns

• AK_InvalidParameter if in_cfgAmbisonics is not an ambisonic configuration.
• AK_InvalidParameter if in_cfgAmbisonics does not have enough channel for a valid ambisonic configuration of the specified order.
• AK_InvalidParameter if in_samples contains non-normalized vectors (not unity length).
• AK_Success otherwise.

Parameters

in_samples	Array of vector samples expressed in left-handed cartesian coordinates, where (1,0,0) points towards the right and (0,1,0) points towards the top. Vectors must be normalized.
in_uNumSamples	Number of points in in_samples.
in_cfgAmbisonics	Ambisonic configuration. Supported configurations are 1st to 5th order. Determines number of rows (input channels) in matrix out_mxVolume.
out_mxVolume	Returned volume matrix of in_cfgAmbisonics.uNumChannels rows x in_uNumSamples colums. Must be allocated prior to calling this function with the size returned by AK::SpeakerVolumes::Matrix::GetRequiredSize() for the desired number of channels.