Unity-Technologies / Unity-Technologies/NativeAudioPlugins

iOS build instructions

Open
#16 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
169
Forks
33
PR merge metrics
No merged PRs in 30d

Description

The provided documentation is lacking detail on how to load a Spatializer Plugin on a Unity app that target iOS.

The only working solution has been provided by the community: (via: https://discussions.unity.com/t/native-audio-plugin-bundle-does-not-work-on-ios/767945/3)

extern "C" {
// We have to manually register the Unity Audio Effect plugin.
struct UnityAudioEffectDefinition;
typedef int (*UnityPluginGetAudioEffectDefinitionsFunc)(
struct UnityAudioEffectDefinition*** descptr);
extern void UnityRegisterAudioPlugin(
UnityPluginGetAudioEffectDefinitionsFunc getAudioEffectDefinitions);
extern int UnityGetAudioEffectDefinitions(UnityAudioEffectDefinition*** definitionptr);

} // extern "C"

- (void)shouldAttachRenderDelegate {}
- (void)preStartUnity {
UnityRegisterAudioPlugin(UnityGetAudioEffectDefinitions);
}

Is this the recommended approach by Unity?

Earlier documentation suggests that the prefix audioplugin is sufficient for the plugins to be loaded, but this does not seem to the the case on embedded platforms.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No documentation file or test is named. Start by reviewing the existing guidance on Unity audio plugin loading for embedded platforms and the linked Unity discussion, then document the recommended iOS setup and clarify whether the audioplugin prefix is sufficient. Done means the iOS loading steps and the prefix limitation are clearly recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, ios, unity
Domain
documentation, mobile
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.