3. Creating Plugin Files

To interact with external audio editing software, TranslationRecorder stores plugin metadata files in the user's ~/TranslationRecorder/plugins directory. The metadata is stored as YAML. The structure is as follows:

---
    name: <plugin name>
    version: <plugin version>
    canEdit: <true or false>
    canRecord: <true or false>
    executable:
        macos: <optional, path to binary on macOS>
        linux: <optional, path to binary on Linux>
        windows: <optional, path to binary on Windows>
    args: <list of command line arguments. if none, put []>

Notes

• version is not the version of the plugin binary, but the version of the plugin metadata YAML file
• canEdit and canRecord are currently not respected in the software as of 2018-10-17. Every plugin is assumed to be able to record and edit.
• The executable key must have at least one OS key inside it. Unexpected behavior may occur if no OS binary is specified.

Example: ocenaudio

---
    name: ocenaudio
    version: 0.0.1
    canEdit: true
    canRecord: true
    executable:
        macos: /Applications/ocenaudio.app/Contents/MacOS/ocenaudio
        windows: C:\Program Files (x86)\ocenaudio\ocenaudio.exe
    args: []

On macOS/Linux systems, place this YAML file in the ~/TranslationRecorder/plugins directory (you may create the directory if it does not yet exist). On Windows this folder should be C:\Users\<username>\TranslationRecorder\plugins.