audaspace / audaspace

A high level and feature rich audio library written in C++ with language bindings.
Apache License 2.0
19 stars 6 forks source link

C API AUD_readSound() the param #14

Closed DJLinux closed 2 years ago

DJLinux commented 2 years ago

I wrote a FreeBASIC binding for the audaspace C-API the last param "interrupt" short* is not documented in the include or sourcode file how to use it ?

by the way i'm blind or isn't there a C-API documentation ?

Thank you

Joshy

neXyon commented 2 years ago

There kind of is - see the main paragraph here: https://audaspace.github.io/bindings/index.html

AUD_readSound() is part of AUD_Special.h a header that is basically containing specialized functions to be used by Blender. Thus the API can change any time and it's not considered part of the official API. That's why there is also no Python binding for it and no documentation.

But if you're still curious about interrupt: It must point to a short that equals 0. If it is set to a non-zero value, the method will be interrupted and return 0. This can be used in multi-threaded applications to interrupt reading if it takes too long.