deblan-mirror/buzz
1
0
Fork 0
mirror of https://github.com/chidiwilliams/buzz.git synced 2024-06-07 18:52:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs with preferences (#602)

Browse source
This commit is contained in:
Chidi Williams 2023-09-19 20:53:56 +01:00 committed by GitHub
parent 775bb4a0f2
commit a3b54891e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 50 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/cli.md
View file

@ -1,6 +1,6 @@
---
title: CLI
sidebar_position: 4
sidebar_position: 5
---
## Commands

25
docs/docs/preferences.md Normal file
View file

@ -0,0 +1,25 @@
---
title: Preferences
sidebar_position: 4
---
Open the Preferences window from the Menu bar, or click `Ctrl/Cmd + ,`.
## General Preferences
### Default export file name
Sets the default export file name for file transcriptions. For
example, a value of `{{ input_file_name }} ({{ task }}d on {{ date_time }})` will save TXT exports
as `Input Filename (transcribed on 19-Sep-2023 20-39-25).txt` by default.
Available variables:
| Key | Description | Example |
|-------------------|-------------------------------------------|------------------------------------------------------------------|
| `input_file_name` | File name of the imported file | `audio` (e.g. if the imported file path was `/path/to/audio.wav` |
| `task` | Transcription task | `transcribe`, `translate` |
| `language` | Language code | `en`, `fr`, `yo`, etc. |
| `model_type` | Model type | `Whisper`, `Whisper.cpp`, `Faster Whisper`, etc. |
| `model_size` | Model size | `tiny`, `base`, `small`, `medium`, `large`, etc. |
| `date_time` | Export time (format: `%d-%b-%Y %H-%M-%S`) | `19-Sep-2023 20-39-25` |

2
docs/docs/usage/_category_.yml Normal file
View file

@ -0,0 +1,2 @@
label: Usage
position: 3

21
docs/docs/usage/file_import.md Normal file
View file

@ -0,0 +1,21 @@
---
title: File Import
---
To import a file:
- Click Import Media File on the File menu (or the '+' icon on the toolbar, or **Command/Ctrl + O**).
- Choose an audio or video file.
- Select a task, language, and the model settings.
- Click Run.
- When the transcription status shows 'Completed', double-click on the row (or select the row and click the '⤢' icon) to
open the transcription.
| Field | Options | Default | Description |
|--------------------|---------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| Export As | "TXT", "SRT", "VTT" | "TXT" | Export file format |
| Word-Level Timings | Off / On | Off | If checked, the transcription will generate a separate subtitle line for each word in the audio. Enabled only when "Export As" is set to "SRT" or "VTT". |
(See the [Live Recording section](#live-recording) for more information about the task, language, and quality settings.)
[![Media File Import on Buzz](https://cdn.loom.com/sessions/thumbnails/cf263b099ac3481082bb56d19b7c87fe-with-play.gif)](https://www.loom.com/share/cf263b099ac3481082bb56d19b7c87fe "Media File Import on Buzz")

25
docs/docs/usage.md → docs/docs/usage/live_recording.md
View file

@ -1,30 +1,7 @@
---
title: Usage
sidebar_position: 3
title: Live Recording
---
## File import
To import a file:
- Click Import Media File on the File menu (or the '+' icon on the toolbar, or **Command/Ctrl + O**).
- Choose an audio or video file.
- Select a task, language, and the model settings.
- Click Run.
- When the transcription status shows 'Completed', double-click on the row (or select the row and click the '⤢' icon) to
open the transcription.
| Field | Options | Default | Description |
|--------------------|---------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| Export As | "TXT", "SRT", "VTT" | "TXT" | Export file format |
| Word-Level Timings | Off / On | Off | If checked, the transcription will generate a separate subtitle line for each word in the audio. Enabled only when "Export As" is set to "SRT" or "VTT". |
(See the [Live Recording section](#live-recording) for more information about the task, language, and quality settings.)
[![Media File Import on Buzz](https://cdn.loom.com/sessions/thumbnails/cf263b099ac3481082bb56d19b7c87fe-with-play.gif)](https://www.loom.com/share/cf263b099ac3481082bb56d19b7c87fe "Media File Import on Buzz")
## Live recording
To start a live recording:
- Select a recording task, language, quality, and microphone.