The command-line agent sends your room's sound to InterScribe from a machine that stays in the venue and runs on its own, with nobody at it.
Before you start
- You need an admin or organizer role to see the install command.
- Decide how the machine signs in. If a person will sign in on it, use your InterScribe account. If nobody will, create an agent key: on the Agents tab, select New key, name the machine and select Create key.
Steps
- STEP 1Copy the install command
In the Portal, go to Rooms & audio → Agents, select Set up an agent, then Command line. Under For, choose macOS (Apple Silicon) and select Copy install command.
- STEP 2Install
On the Mac, open Terminal in an empty folder, paste the command and run it. It checks the download against our published checksum and that Apple notarized it, and installs it only once every check passes. Rather not pipe a script to your shell? Use Install manually instead.
- STEP 3Sign inRun
interscribe-agent login. Sign in with your account, or choose the agent key method and paste the key. - STEP 4Choose the channel and microphone
Run
interscribe-agent setup. It guides you through choosing the room's channel and the microphone. - STEP 5Run itRun
interscribe-agent runand leave that terminal open, or install it as a service (below).
Check it worked
The machine appears on the Agents tab as soon as it checks in. Select Test audio on its card, speak at the desk and watch the meter move.
On the machine, interscribe-agent status shows the saved settings, the sign-in and whether the agent is running.
Keep it running on its own
sudo interscribe-agent install-serviceinstalls the agent as a service that starts when the Mac starts and runs as your account, never as root.interscribe-agent start,stopandrestartcontrol the service.interscribe-agent keep-awake while-signed-inkeeps the Mac from idle-sleeping whenever it is signed in. The default,while-broadcasting, keeps it awake while an event broadcasts.- macOS may ask once to allow the microphone for the service. If the sound is silent, allow
interscribe-agentunder System Settings → Privacy & Security → Microphone.
Useful commands
interscribe-agent status: shows the saved settings and the agent's local status.interscribe-agent audio-devices: lists the microphones the machine can see.interscribe-agent set-audio-device: chooses the microphone.interscribe-agent select-av-channel: chooses the channel.interscribe-agent logs --lines 50: shows the last lines of the agent's log.interscribe-agent update --check: checks for a newer version without installing it.interscribe-agent update: installs a newer version after asking you.interscribe-agent logout: signs the agent out.
An update never restarts the sound capture by itself. Restart the agent after you update it.
If something goes wrong
- If the machine was signed out by an administrator, removed from your workspace or its agent key was switched off, the agent stops at once.
interscribe-agent statusgives the reason. Runinterscribe-agent loginto sign it in again. - The agent shows offline
