mirror of
https://github.com/chidiwilliams/buzz.git
synced 2026-03-16 15:45:49 +01:00
24 lines
No EOL
17 KiB
HTML
24 lines
No EOL
17 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-usage">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.1">
|
||
<title data-rh="true">Usage | Buzz</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://chidiwilliams.github.io/buzz/img/favicon.ico"><meta data-rh="true" name="twitter:image" content="https://chidiwilliams.github.io/buzz/img/favicon.ico"><meta data-rh="true" property="og:url" content="https://chidiwilliams.github.io/buzz/docs/usage"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Usage | Buzz"><meta data-rh="true" name="description" content="File import"><meta data-rh="true" property="og:description" content="File import"><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/docs/usage"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css">
|
||
<link rel="preload" href="/buzz/assets/js/runtime~main.276c3843.js" as="script">
|
||
<link rel="preload" href="/buzz/assets/js/main.866997c5.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/buzz/"><div class="navbar__logo"><img src="/buzz/img/favicon.ico" alt="Buzz" class="themedImage_ToTc themedImage--light_HNdA"><img src="/buzz/img/favicon.ico" alt="Buzz" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Buzz</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/buzz/docs">Docs</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/chidiwilliams/buzz" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/buzz/docs/usage">Usage</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs/cli">CLI</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs/faq">FAQ</a></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/buzz/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Usage</span><meta itemprop="position" content="1"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Usage</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="file-import">File import<a href="#file-import" class="hash-link" aria-label="Direct link to File import" title="Direct link to File import"></a></h2><p>To import a file:</p><ul><li>Click Import Media File on the File menu (or the '+' icon on the toolbar, or <strong>Command/Ctrl + O</strong>).</li><li>Choose an audio or video file.</li><li>Select a task, language, and the model settings.</li><li>Click Run.</li><li>When the transcription status shows 'Completed', double-click on the row (or select the row and click the '⤢' icon) to
|
||
open the transcription.</li></ul><table><thead><tr><th>Field</th><th>Options</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>Export As</td><td>"TXT", "SRT", "VTT"</td><td>"TXT"</td><td>Export file format</td></tr><tr><td>Word-Level Timings</td><td>Off / On</td><td>Off</td><td>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".</td></tr></tbody></table><p>(See the <a href="#live-recording">Live Recording section</a> for more information about the task, language, and quality settings.)</p><p><a href="https://www.loom.com/share/cf263b099ac3481082bb56d19b7c87fe" target="_blank" rel="noopener noreferrer" title="Media File Import on Buzz"><img loading="lazy" src="https://cdn.loom.com/sessions/thumbnails/cf263b099ac3481082bb56d19b7c87fe-with-play.gif" alt="Media File Import on Buzz" class="img_ev3q"></a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="live-recording">Live recording<a href="#live-recording" class="hash-link" aria-label="Direct link to Live recording" title="Direct link to Live recording"></a></h2><p>To start a live recording:</p><ul><li>Select a recording task, language, quality, and microphone.</li><li>Click Record.</li></ul><blockquote><p><strong>Note:</strong> Transcribing audio using the default Whisper model is resource-intensive. Consider using the Whisper.cpp
|
||
Tiny model to get real-time performance.</p></blockquote><table><thead><tr><th>Field</th><th>Options</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>Task</td><td>"Transcribe", "Translate"</td><td>"Transcribe"</td><td>"Transcribe" converts the input audio into text in the selected language, while "Translate" converts it into text in English.</td></tr><tr><td>Language</td><td>See <a href="https://github.com/openai/whisper#available-models-and-languages" target="_blank" rel="noopener noreferrer">Whisper's documentation</a> for the full list of supported languages</td><td>"Detect Language"</td><td>"Detect Language" will try to detect the spoken language in the audio based on the first few seconds. However, selecting a language is recommended (if known) as it will improve transcription quality in many cases.</td></tr><tr><td>Quality</td><td>"Very Low", "Low", "Medium", "High"</td><td>"Very Low"</td><td>The transcription quality determines the Whisper model used for transcription. "Very Low" uses the "tiny" model; "Low" uses the "base" model; "Medium" uses the "small" model; and "High" uses the "medium" model. The larger models produce higher-quality transcriptions, but require more system resources. See <a href="https://github.com/openai/whisper#available-models-and-languages" target="_blank" rel="noopener noreferrer">Whisper's documentation</a> for more information about the models.</td></tr><tr><td>Microphone</td><td>[Available system microphones]</td><td>[Default system microphone]</td><td>Microphone for recording input audio.</td></tr></tbody></table><p><a href="https://www.loom.com/share/564b753eb4d44b55b985b8abd26b55f7" target="_blank" rel="noopener noreferrer" title="Live Recording on Buzz"><img loading="lazy" src="https://cdn.loom.com/sessions/thumbnails/564b753eb4d44b55b985b8abd26b55f7-with-play.gif" alt="Live Recording on Buzz" class="img_ev3q"></a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="record-audio-playing-from-computer-macos">Record audio playing from computer (macOS)<a href="#record-audio-playing-from-computer-macos" class="hash-link" aria-label="Direct link to Record audio playing from computer (macOS)" title="Direct link to Record audio playing from computer (macOS)"></a></h3><p>To record audio playing from an application on your computer, you may install an audio loopback driver (a program that
|
||
lets you create virtual audio devices). The rest of this guide will
|
||
use <a href="https://github.com/ExistentialAudio/BlackHole" target="_blank" rel="noopener noreferrer">BlackHole</a> on Mac, but you can use other alternatives for your
|
||
operating system (
|
||
see <a href="https://nerds.de/en/loopbeaudio.html" target="_blank" rel="noopener noreferrer">LoopBeAudio</a>, <a href="https://rogueamoeba.com/loopback/" target="_blank" rel="noopener noreferrer">LoopBack</a>,
|
||
and <a href="https://vac.muzychenko.net/en/" target="_blank" rel="noopener noreferrer">Virtual Audio Cable</a>).</p><ol><li><p>Install <a href="https://github.com/ExistentialAudio/BlackHole#option-2-install-via-homebrew" target="_blank" rel="noopener noreferrer">BlackHole via Homebrew</a></p><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">brew </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> blackhole-2ch</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li><li><p>Open Audio MIDI Setup from Spotlight or from <code>/Applications/Utilities/Audio Midi Setup.app</code>.</p><p><img loading="lazy" src="https://existential.audio/howto/img/spotlight.png" alt="Open Audio MIDI Setup from Spotlight" class="img_ev3q"></p></li><li><p>Click the '+' icon at the lower left corner and select 'Create Multi-Output Device'.</p><p><img loading="lazy" src="https://existential.audio/howto/img/createmulti-output.png" alt="Create multi-output device" class="img_ev3q"></p></li><li><p>Add your default speaker and BlackHole to the multi-output device.</p><p><img loading="lazy" src="https://existential.audio/howto/img/multi-output.png" alt="Screenshot of multi-output device" class="img_ev3q"></p></li><li><p>Select this multi-output device as your speaker (application or system-wide) to play audio into BlackHole.</p></li><li><p>Open Buzz, select BlackHole as your microphone, and record as before to see transcriptions from the audio playing
|
||
through BlackHole.</p></li></ol></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/buzz/docs/installation"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Installation</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/buzz/docs/cli"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">CLI</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#file-import" class="table-of-contents__link toc-highlight">File import</a></li><li><a href="#live-recording" class="table-of-contents__link toc-highlight">Live recording</a><ul><li><a href="#record-audio-playing-from-computer-macos" class="table-of-contents__link toc-highlight">Record audio playing from computer (macOS)</a></li></ul></li></ul></div></div></div></div></main></div></div></div>
|
||
<script src="/buzz/assets/js/runtime~main.276c3843.js"></script>
|
||
<script src="/buzz/assets/js/main.866997c5.js"></script>
|
||
</body>
|
||
</html> |