Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

AudioSampleProvider.SampleFramesEventNativeFunction

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public delegate void SampleFramesEventNativeFunction(IntPtr userData, uint providerId, uint sampleFrameCount);

Parameters

userDataUser data specified when the handler was set. The actual C type is void*.
providerIdId of the provider. See AudioSampleProvider.id.
sampleFrameCountNumber of sample frames available or overflowed, depending on event type.

Description

Type that represents the native function pointer for handling sample frame events.

Sample frames events are AudioSampleProvider.sampleFramesAvailable and AudioSampleProvider.sampleFramesOverflow.

Importing such a function from a native plug-in would be done this way:

[DllImport(pluginName, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
private static extern void SampleFramesAvailable(IntPtr userData, uint id, uint sampleFrameCount);

Did you find this page useful? Please give it a rating: