Function steam_audio::ffi::iplCreateAmbisonicsBinauralEffect [−] [src]

pub unsafe extern "C" fn iplCreateAmbisonicsBinauralEffect(
    renderer: IPLhandle, 
    inputFormat: IPLAudioFormat, 
    outputFormat: IPLAudioFormat, 
    effect: *mut IPLhandle
) -> IPLerror

Creates an Ambisonics Binaural Effect object. This can be used to render higher-order Ambisonics data using HRTF-based binaural rendering.

\param renderer Handle to a Binaural Renderer object. \param inputFormat The format of the audio buffers that will be passed as input to this effect. All subsequent calls to \c ::iplApplyAmbisonicsBinauralEffect for this effect object must use \c IPLAudioBuffer objects with the same format as specified here. The input format must be Ambisonics. \param outputFormat The format of the audio buffers which will be used to retrieve the output from this effect. All subsequent calls to \c ::iplApplyAmbisonicsBinauralEffect for this effect object must use \c IPLAudioBuffer objects with the same format as specified here. The output format must be stereo (2 channels). \param effect [out] Handle to the created Ambisonics Binaural Effect object.

\return Status code indicating whether or not the operation succeeded.