Skip to content

Commit

Permalink
Minor documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sgretscher committed Jun 13, 2024
1 parent c718222 commit 045c71e
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion ChangeLog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Changes since previous releases:

=== ARA SDK 2.1 release (aka 2.1.001) (2022/01/06) ===
- finalized ARM support for Apple Silicon
- enable ARA audio file chunk authoring directly in the host
- enabled ARA audio file chunk authoring directly in the host
- fixed crashes in archiving test cases with certain compilers


Expand Down
2 changes: 1 addition & 1 deletion MiniHost/MiniHost.c
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
#endif


// Companion API includes
// companion API includes
#if PLUGIN_FORMAT == PLUGIN_FORMAT_AU
#include "ExamplesCommon/PlugInHosting/AudioUnitLoader.h"

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ concise long-term change history, any changes since the last tagged release may
## Companion APIs

Creating ARA-enabled products relies on using at least one of the various established audio plug-in
formats as "Companion APIs". The CMake code allows for setting path variables to your local copies
formats as "companion APIs". The CMake code allows for setting path variables to your local copies
of these SDKs: `ARA_VST3_SDK_DIR` and `ARA_AUDIO_UNIT_SDK_DIR`. If needed, installing the SDKs
can be done using the [ARA SDK Installer](https://github.com/Celemony/ARA_SDK).

Expand Down
4 changes: 2 additions & 2 deletions TestHost/CompanionAPIs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ class IPCPlugInInstance : public PlugInInstance, protected ARA::IPC::RemoteCalle

void bindToDocumentControllerWithRoles (ARA::ARADocumentControllerRef documentControllerRef, ARA::ARAPlugInInstanceRoleFlags assignedRoles) override
{
// \todo these are the roles that our Companion API Loaders implicitly assume - they should be published properly
// \todo these are the roles that our companion API Loaders implicitly assume - they should be published properly
const ARA::ARAPlugInInstanceRoleFlags knownRoles { ARA::kARAPlaybackRendererRole | ARA::kARAEditorRendererRole | ARA::kARAEditorViewRole };
auto plugInExtension { ARA::IPC::ARAIPCProxyPlugInBindToDocumentController (_remoteRef, documentControllerRef, knownRoles, assignedRoles) };
validateAndSetPlugInExtensionInstance (plugInExtension, assignedRoles);
Expand Down Expand Up @@ -767,7 +767,7 @@ int main (std::unique_ptr<PlugInEntry> plugInEntry, const std::string& channelID
ARA::ARAPlugInInstanceRoleFlags knownRoles, ARA::ARAPlugInInstanceRoleFlags assignedRoles)
-> const ARA::ARAPlugInExtensionInstance*
{
// \todo these are the roles that our Companion API Loaders implicitly assume - they should be published properly
// \todo these are the roles that our companion API Loaders implicitly assume - they should be published properly
ARA_INTERNAL_ASSERT (knownRoles == (ARA::kARAPlaybackRendererRole | ARA::kARAEditorRendererRole | ARA::kARAEditorViewRole) );
reinterpret_cast<PlugInInstance*> (plugInInstanceRef)->bindToDocumentControllerWithRoles (controllerRef, assignedRoles);
return reinterpret_cast<PlugInInstance*> (plugInInstanceRef)->getARAPlugInExtensionInstance ();
Expand Down

0 comments on commit 045c71e

Please sign in to comment.