Orlaeg plugins

Contribute

Contribute a plugin: build your own

A plugin is an Android app that holds recordings and lets Orlaeg take them. You write the recorder; Orlaeg takes the recordings to the person's own Google Drive and from there to transcripts and named speakers. The whole interface is one content provider and one set-up screen. This page is a summary; the interface document has every detail.

The door is open; this directory is not. Anyone can build a recorder plugin with the documented import door and distribute it themselves. This directory is curated: it lists only the plugins Orlaeg makes, and it takes no submissions.

The import doorDistribution is yours

The import door

The door is one ContentProvider of your plugin. Orlaeg reads it; nothing else may.

1. Be found

Declare the provider, exported, with the action com.orlaeg.plugin.RECORDINGS and a meta-data naming your kind of recorder. Orlaeg finds plugins by that action; there is no search and no list to be added to on the phone. The label is what the person is shown. The person sees the plugin listed at once, and nothing of it is read until they approve it.

<provider android:name=".MyProvider" android:authorities="${applicationId}.recordings" android:exported="true">
    <intent-filter><action android:name="com.orlaeg.plugin.RECORDINGS" /></intent-filter>
    <meta-data android:name="com.orlaeg.plugin.LABEL" android:value="My recorder" />
</provider>

2. The contract: the Row

Your authority, one path, recordings. Nothing else is part of the interface; every other call is refused.

CallURIAnswer
querycontent://<authority>/recordingsone row per finished recording
openFile(uri, "r")content://<authority>/recordings/<date>/<name>the recording's audio, read-only
deletethe same URIthe plugin removes its copy; 1 if it held it, else 0
ColumnTypeMeaning
keystringthe recording's stable id, <date>/<name>: the date is yyyy-MM-dd (UTC), the name letters, digits, ., - and _. It never changes while you hold the recording, and it is the recording's name in the person's Drive.
start_mslongwhen it began, epoch milliseconds; 0 when unknown
duration_sintits length in seconds; 0 when you do not know
extstringmp3 or aac (a stream of frames with no index at the end: ADTS for aac)
byteslongthe file's size; Orlaeg checks what it reads against it
sidecarstringhow it was captured, a JSON object as text, or an empty string for none

Only whole, finished recordings are rows. A row whose key or ext does not fit is ignored. The sidecar travels with the audio and describes the capture (source, start time, sample rate, channels, codec, whether the recording continues in the next file); it holds none of the person's own data, no contacts, no calendar, no location. A plugin that copies from a device that has no capture information leaves it empty. When the person's Drive holds the same file and Orlaeg has taken it in, Orlaeg calls delete, and your plugin removes its copy.

3. The caller check

At every call, check Binder.getCallingUid(): the caller's package must be Orlaeg's (com.orlaeg) and be signed with the certificate of the installed Orlaeg (PackageManager.hasSigningCertificate, a SHA-256 digest, which is public). A caller that fails gets a SecurityException and nothing else: no rows, no file, no hint whether a recording exists. A plugin with no allowed caller refuses everyone. Never hard-code a key.

4. The set-up screen, and no launcher icon

A plugin keeps no icon of its own on the home screen, so the phone has one Orlaeg icon. Instead, declare your one set-up activity (your consent, your pairing) with the action com.orlaeg.plugin.SETTINGS, exported, in the default category. Orlaeg opens it from Settings, External recorders, on the Set up button of your plugin's row.

<activity android:name=".MyActivity" android:exported="true">
    <intent-filter>
        <action android:name="com.orlaeg.plugin.SETTINGS" />
        <category android:name="android.intent.category.DEFAULT" />
    </intent-filter>
</activity>

5. What the person sees and decides

Orlaeg lists every plugin it finds under Settings, External recorders, Add. Before it reads one, the person approves it in Orlaeg's own dialog: what the plugin is, its package, and that its recordings will be copied to their Google Drive. The approval is kept for that package and that signing certificate (a plugin signed by another key is another plugin) and ends when the person removes the plugin. From then on, every 15 minutes and when the plugin is added, Orlaeg lists the rows, reads each recording it does not have, uploads it to Drive, and asks the plugin to delete its copy.

Distribution is yours

  • You make it, you ship it. You build the plugin, sign the APK with your own key and distribute it yourself, however you choose. Orlaeg does not build, sign, host, list or change a plugin made by someone else.
  • You are responsible for it. The author of a plugin is responsible for what it does and for how it is used. A plugin that records should record the conversations its person takes part in, and the people they talk with should know.
  • The person decides, in Orlaeg. Orlaeg lists any plugin it finds on the phone that follows the interface, and reads nothing from it until the person approves it.