Extract Audio

extract_audio

Extract the audio track of a media file to its own file (mp3, aac, wav, or copy). Returns the output path.

audiowritesdestructivesince v0.3.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the source media.
`format` required	`"mp3" \| "aac" \| "wav" \| "copy"`	Audio output codec. copy keeps the source codec without re-encoding.
`output`	`string`	Optional output path. Defaults under SCREENCAST_HOME/edits.
`overwrite`	`boolean`	Allow replacing an existing file at the output path (default false).

00:05A MINIMAL CALL

extract_audio { "input": "recording.mp4", "format": "mp3" }

The required arguments only, with placeholder values. Everything else takes its default.

00:10WHAT COMES BACK

Structured content (structuredContent), alongside a text summary:

Field	Type	Description
`outputPath` always	`string`	Path of the file written.