zoom-narrator

Play audio while streaming its closed captions to Zoom.

Prerequisites

The user is responsible for providing a working Python environment for this application. If you need help with this step, see the PythonWiki beginner's guide.

Additionally, this application relies on ffmpeg (specifically, ffplay) to play audio at the command line. The user is responsible for ensuring this utility is installed and on the PATH.

Installing

At the command line, type pip install zoom-narrator.

Using

• Enable closed captioning for your Zoom account.
• Start your zoom meeting and share your computer audio.
• Start closed captioning and copy the API token.
• Invoke this application: zoom-narrator path/to/audio.
  • You can optionally specify the path to a captions file at the command line with -c / --captions. If not specified, the application will look for a file with the same name as the audio and a known captioning file extension.
  • You can optionally provide the API key at the command line with -k / --key.

Developing

Environment and prerequisites are managed by poetry. See https://python-poetry.org/docs/#installation to get started with poetry.

• To create an environment and install prerequisites, run poetry install in the top level of the repository.
• Invoke the application with poetry run zoom-narrator.
• Build packages with poetry build.