From 7fcaf064707a2bf6114b81f590e9be413e6f7792 Mon Sep 17 00:00:00 2001 From: raivisdejus <raivisdejus@users.noreply.github.com> Date: Wed, 7 Aug 2024 18:57:47 +0000 Subject: [PATCH] deploy: 62eb2096f6313b44ea25e035d90fc114a5cb02a9 --- 404.html | 4 ++-- assets/js/{0480b142.192b5033.js => 0480b142.1f75987b.js} | 2 +- ...{runtime~main.bfc37002.js => runtime~main.23ac727b.js} | 2 +- docs.html | 4 ++-- docs/cli.html | 4 ++-- docs/faq.html | 8 +++----- docs/installation.html | 4 ++-- docs/preferences.html | 4 ++-- docs/usage/file_import.html | 4 ++-- docs/usage/live_recording.html | 4 ++-- docs/usage/translations.html | 4 ++-- index.html | 4 ++-- 12 files changed, 23 insertions(+), 25 deletions(-) rename assets/js/{0480b142.192b5033.js => 0480b142.1f75987b.js} (87%) rename assets/js/{runtime~main.bfc37002.js => runtime~main.23ac727b.js} (98%) diff --git a/404.html b/404.html index fa9da52cf..cd79f2dea 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">Page Not Found | 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/404.html"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | Buzz"><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/404.html"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/404.html" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.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 class="navbar__item navbar__link" 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"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/assets/js/0480b142.192b5033.js b/assets/js/0480b142.1f75987b.js similarity index 87% rename from assets/js/0480b142.192b5033.js rename to assets/js/0480b142.1f75987b.js index c88c9dc0b..77dbe842b 100644 --- a/assets/js/0480b142.192b5033.js +++ b/assets/js/0480b142.1f75987b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[836],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},o=Object.keys(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=l(r),d=n,h=u["".concat(p,".").concat(d)]||u[d]||m[d]||o;return r?a.createElement(h,i(i({ref:t},c),{},{components:r})):a.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:n,i[1]=s;for(var l=2;l<o;l++)i[l]=r[l];return a.createElement.apply(null,i)}return a.createElement.apply(null,r)}d.displayName="MDXCreateElement"},3584:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={title:"FAQ",sidebar_position:5},i=void 0,s={unversionedId:"faq",id:"faq",title:"FAQ",description:"1. Where are the models stored?",source:"@site/docs/faq.md",sourceDirName:".",slug:"/faq",permalink:"/buzz/docs/faq",draft:!1,tags:[],version:"current",sidebarPosition:5,frontMatter:{title:"FAQ",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"CLI",permalink:"/buzz/docs/cli"}},p={},l=[],c={toc:l},u="wrapper";function m(e){let{components:t,...r}=e;return(0,n.kt)(u,(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Where are the models stored?")),(0,n.kt)("p",{parentName:"li"},"The Whisper models are stored in ",(0,n.kt)("inlineCode",{parentName:"p"},"~/.cache/whisper"),". The Whisper.cpp models are stored in ",(0,n.kt)("inlineCode",{parentName:"p"},"~/Library/Caches/Buzz"),"\n(Mac OS), ",(0,n.kt)("inlineCode",{parentName:"p"},"~/.cache/Buzz")," (Unix), or ",(0,n.kt)("inlineCode",{parentName:"p"},"C:\\Users\\<username>\\AppData\\Local\\Buzz\\Buzz\\Cache")," (Windows).")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"What can I try if the transcription runs too slowly?")),(0,n.kt)("p",{parentName:"li"},"Speech recognition requires large amount of computation, so one option is to try using a lower Whisper model size or using a Whisper.cpp model to run speech recognition of your computer. If you have access to a computer with GPU that has at least 6GB of VRAM you can try using the Faster Whisper model."),(0,n.kt)("p",{parentName:"li"},"Buzz also supports using OpenAI API to do speech recognition on a remote server. To use this feature you need to set OpenAI API key in Preferences. See ",(0,n.kt)("a",{parentName:"p",href:"https://chidiwilliams.github.io/buzz/docs/preferences"},"Preferences")," section for more details.")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How to record system audio?")),(0,n.kt)("p",{parentName:"li"},"To transcribe system audio you need to configure virtual audio device and connect output from the applications you want to transcribe to this virtual speaker. After that you can select it as source in the Buzz. See ",(0,n.kt)("a",{parentName:"p",href:"https://chidiwilliams.github.io/buzz/docs/usage/live_recording"},"Usage")," section for more details."),(0,n.kt)("p",{parentName:"li"},"Relevant tools:"),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Mac OS - ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/ExistentialAudio/BlackHole"},"BlackHole"),"."),(0,n.kt)("li",{parentName:"ul"},"Windows - ",(0,n.kt)("a",{parentName:"li",href:"https://vb-audio.com/Cable/"},"VB CABLE")),(0,n.kt)("li",{parentName:"ul"},"Linux - ",(0,n.kt)("a",{parentName:"li",href:"https://wiki.ubuntu.com/record_system_sound"},"PulseAudio Volume Control")))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"What model should I use?")),(0,n.kt)("p",{parentName:"li"},"Model size to use will depend on your hardware and use case. Smaller models will work faster but will have more inaccuracies. Larger models will be more accurate but will require more powerful hardware or longer time to transcribe. "),(0,n.kt)("p",{parentName:"li"},'When choosing among large models consider the following. "Large" is the first released older model, "Large-V2" is later updated model with better accuracy, for some languages considered the most robust and stable. "Large-V3" is the latest model with the best accuracy in many cases, but some times can hallucinate or invent words that were never in the audio. The only sure way to know what model best suits your needs is to test them all in your language. ')),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How to get GPU acceleration for faster transcription?")),(0,n.kt)("p",{parentName:"li"},"On Linux GPU acceleration is supported out of the box on Nvidia GPUs. If you still get any issues install ",(0,n.kt)("a",{parentName:"p",href:"https://developer.nvidia.com/cuda-downloads"},"CUDA 12"),", ",(0,n.kt)("a",{parentName:"p",href:"https://developer.nvidia.com/cublas"},"cuBLASS")," and ",(0,n.kt)("a",{parentName:"p",href:"https://developer.nvidia.com/cudnn"},"cuDNN"),"."),(0,n.kt)("p",{parentName:"li"},"On Windows see ",(0,n.kt)("a",{parentName:"p",href:"https://github.com/chidiwilliams/buzz/blob/main/CONTRIBUTING.md#gpu-support"},"this note")," on enabling CUDA GPU support.")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How to fix ",(0,n.kt)("inlineCode",{parentName:"strong"},"Unanticipated host error[PaErrorCode-9999]"),"?")),(0,n.kt)("p",{parentName:"li"},"Check if there are any system settings preventing apps from accessing the microphone."),(0,n.kt)("p",{parentName:"li"},"On Windows, see if Buzz has permission to use the microphone in Settings -> Privacy -> Microphone.\nSee method 1 in this video ",(0,n.kt)("a",{parentName:"p",href:"https://www.youtube.com/watch?v=eRcCYgOuSYQ"},"https://www.youtube.com/watch?v=eRcCYgOuSYQ"),"\nFor method 2 there is no need to uninstall the antivirus, but see if you can temporarily disable it or if there are settings that may prevent Buzz from accessing the microphone."))))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[836],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},o=Object.keys(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=l(r),d=n,h=u["".concat(p,".").concat(d)]||u[d]||m[d]||o;return r?a.createElement(h,i(i({ref:t},c),{},{components:r})):a.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:n,i[1]=s;for(var l=2;l<o;l++)i[l]=r[l];return a.createElement.apply(null,i)}return a.createElement.apply(null,r)}d.displayName="MDXCreateElement"},3584:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={title:"FAQ",sidebar_position:5},i=void 0,s={unversionedId:"faq",id:"faq",title:"FAQ",description:"1. Where are the models stored?",source:"@site/docs/faq.md",sourceDirName:".",slug:"/faq",permalink:"/buzz/docs/faq",draft:!1,tags:[],version:"current",sidebarPosition:5,frontMatter:{title:"FAQ",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"CLI",permalink:"/buzz/docs/cli"}},p={},l=[],c={toc:l},u="wrapper";function m(e){let{components:t,...r}=e;return(0,n.kt)(u,(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Where are the models stored?")),(0,n.kt)("p",{parentName:"li"},"The Whisper models are stored in ",(0,n.kt)("inlineCode",{parentName:"p"},"~/.cache/whisper"),". The Whisper.cpp models are stored in ",(0,n.kt)("inlineCode",{parentName:"p"},"~/Library/Caches/Buzz"),"\n(Mac OS), ",(0,n.kt)("inlineCode",{parentName:"p"},"~/.cache/Buzz")," (Unix), or ",(0,n.kt)("inlineCode",{parentName:"p"},"C:\\Users\\<username>\\AppData\\Local\\Buzz\\Buzz\\Cache")," (Windows).")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"What can I try if the transcription runs too slowly?")),(0,n.kt)("p",{parentName:"li"},"Speech recognition requires large amount of computation, so one option is to try using a lower Whisper model size or using a Whisper.cpp model to run speech recognition of your computer. If you have access to a computer with GPU that has at least 6GB of VRAM you can try using the Faster Whisper model."),(0,n.kt)("p",{parentName:"li"},"Buzz also supports using OpenAI API to do speech recognition on a remote server. To use this feature you need to set OpenAI API key in Preferences. See ",(0,n.kt)("a",{parentName:"p",href:"https://chidiwilliams.github.io/buzz/docs/preferences"},"Preferences")," section for more details.")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How to record system audio?")),(0,n.kt)("p",{parentName:"li"},"To transcribe system audio you need to configure virtual audio device and connect output from the applications you want to transcribe to this virtual speaker. After that you can select it as source in the Buzz. See ",(0,n.kt)("a",{parentName:"p",href:"https://chidiwilliams.github.io/buzz/docs/usage/live_recording"},"Usage")," section for more details."),(0,n.kt)("p",{parentName:"li"},"Relevant tools:"),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Mac OS - ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/ExistentialAudio/BlackHole"},"BlackHole"),"."),(0,n.kt)("li",{parentName:"ul"},"Windows - ",(0,n.kt)("a",{parentName:"li",href:"https://vb-audio.com/Cable/"},"VB CABLE")),(0,n.kt)("li",{parentName:"ul"},"Linux - ",(0,n.kt)("a",{parentName:"li",href:"https://wiki.ubuntu.com/record_system_sound"},"PulseAudio Volume Control")))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"What model should I use?")),(0,n.kt)("p",{parentName:"li"},"Model size to use will depend on your hardware and use case. Smaller models will work faster but will have more inaccuracies. Larger models will be more accurate but will require more powerful hardware or longer time to transcribe. "),(0,n.kt)("p",{parentName:"li"},'When choosing among large models consider the following. "Large" is the first released older model, "Large-V2" is later updated model with better accuracy, for some languages considered the most robust and stable. "Large-V3" is the latest model with the best accuracy in many cases, but some times can hallucinate or invent words that were never in the audio. The only sure way to know what model best suits your needs is to test them all in your language. ')),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How to get GPU acceleration for faster transcription?")),(0,n.kt)("p",{parentName:"li"},"On Linux GPU acceleration is supported out of the box on Nvidia GPUs. If you still get any issues install ",(0,n.kt)("a",{parentName:"p",href:"https://developer.nvidia.com/cuda-downloads"},"CUDA 12"),", ",(0,n.kt)("a",{parentName:"p",href:"https://developer.nvidia.com/cublas"},"cuBLASS")," and ",(0,n.kt)("a",{parentName:"p",href:"https://developer.nvidia.com/cudnn"},"cuDNN"),"."),(0,n.kt)("p",{parentName:"li"},"On Windows see ",(0,n.kt)("a",{parentName:"p",href:"https://github.com/chidiwilliams/buzz/blob/main/CONTRIBUTING.md#gpu-support"},"this note")," on enabling CUDA GPU support."),(0,n.kt)("p",{parentName:"li"},"For Faster whisper CUDA 12 is required, computers with older CUDA versions will use CPU. ")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How to fix ",(0,n.kt)("inlineCode",{parentName:"strong"},"Unanticipated host error[PaErrorCode-9999]"),"?")),(0,n.kt)("p",{parentName:"li"},"Check if there are any system settings preventing apps from accessing the microphone."),(0,n.kt)("p",{parentName:"li"},"On Windows, see if Buzz has permission to use the microphone in Settings -> Privacy -> Microphone."),(0,n.kt)("p",{parentName:"li"},"See method 1 in this video ",(0,n.kt)("a",{parentName:"p",href:"https://www.youtube.com/watch?v=eRcCYgOuSYQ"},"https://www.youtube.com/watch?v=eRcCYgOuSYQ")),(0,n.kt)("p",{parentName:"li"},"For method 2 there is no need to uninstall the antivirus, but see if you can temporarily disable it or if there are settings that may prevent Buzz from accessing the microphone."))))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.bfc37002.js b/assets/js/runtime~main.23ac727b.js similarity index 98% rename from assets/js/runtime~main.bfc37002.js rename to assets/js/runtime~main.23ac727b.js index 2ebbeb1f7..20958740a 100644 --- a/assets/js/runtime~main.bfc37002.js +++ b/assets/js/runtime~main.23ac727b.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,o,a,n={},f={};function i(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,i),r.loaded=!0,r.exports}i.m=n,i.c=f,e=[],i.O=(t,r,o,a)=>{if(!r){var n=1/0;for(c=0;c<e.length;c++){r=e[c][0],o=e[c][1],a=e[c][2];for(var f=!0,d=0;d<r.length;d++)(!1&a||n>=a)&&Object.keys(i.O).every((e=>i.O[e](r[d])))?r.splice(d--,1):(f=!1,a<n&&(n=a));if(f){e.splice(c--,1);var b=o();void 0!==b&&(t=b)}}return t}a=a||0;for(var c=e.length;c>0&&e[c-1][2]>a;c--)e[c]=e[c-1];e[c]=[r,o,a]},i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,i.t=function(e,o){if(1&o&&(e=this(e)),8&o)return e;if("object"==typeof e&&e){if(4&o&&e.__esModule)return e;if(16&o&&"function"==typeof e.then)return e}var a=Object.create(null);i.r(a);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&o&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,i.d(a,n),a},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.f={},i.e=e=>Promise.all(Object.keys(i.f).reduce(((t,r)=>(i.f[r](e,t),t)),[])),i.u=e=>"assets/js/"+({34:"871e3331",53:"935f2afb",217:"3b8c55ea",237:"1df93b7f",355:"e53fa2b7",382:"1102fda7",468:"1a20bc57",514:"1be78505",542:"2d9f39b3",836:"0480b142",860:"3e407b54",918:"17896441",958:"6dbc2e00",971:"c377a04b"}[e]||e)+"."+{34:"b7e0063b",53:"ee4c5b72",217:"a80ecf58",237:"71d7b441",355:"270fcee2",382:"0e12deaa",468:"23883b0e",514:"131974b6",542:"0a265eb2",836:"192b5033",860:"987a7018",918:"0aaaf3b3",958:"24fcb0eb",971:"b0b8fe80",972:"d5cc17b1"}[e]+".js",i.miniCssF=e=>{},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o={},a="docs:",i.l=(e,t,r,n)=>{if(o[e])o[e].push(t);else{var f,d;if(void 0!==r)for(var b=document.getElementsByTagName("script"),c=0;c<b.length;c++){var u=b[c];if(u.getAttribute("src")==e||u.getAttribute("data-webpack")==a+r){f=u;break}}f||(d=!0,(f=document.createElement("script")).charset="utf-8",f.timeout=120,i.nc&&f.setAttribute("nonce",i.nc),f.setAttribute("data-webpack",a+r),f.src=e),o[e]=[t];var l=(t,r)=>{f.onerror=f.onload=null,clearTimeout(s);var a=o[e];if(delete o[e],f.parentNode&&f.parentNode.removeChild(f),a&&a.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),d&&document.head.appendChild(f)}},i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.p="/buzz/",i.gca=function(e){return e={17896441:"918","871e3331":"34","935f2afb":"53","3b8c55ea":"217","1df93b7f":"237",e53fa2b7:"355","1102fda7":"382","1a20bc57":"468","1be78505":"514","2d9f39b3":"542","0480b142":"836","3e407b54":"860","6dbc2e00":"958",c377a04b:"971"}[e]||e,i.p+i.u(e)},(()=>{var e={303:0,532:0};i.f.j=(t,r)=>{var o=i.o(e,t)?e[t]:void 0;if(0!==o)if(o)r.push(o[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var a=new Promise(((r,a)=>o=e[t]=[r,a]));r.push(o[2]=a);var n=i.p+i.u(t),f=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(o=e[t])&&(e[t]=void 0),o)){var a=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+a+": "+n+")",f.name="ChunkLoadError",f.type=a,f.request=n,o[1](f)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var o,a,n=r[0],f=r[1],d=r[2],b=0;if(n.some((t=>0!==e[t]))){for(o in f)i.o(f,o)&&(i.m[o]=f[o]);if(d)var c=d(i)}for(t&&t(r);b<n.length;b++)a=n[b],i.o(e,a)&&e[a]&&e[a][0](),e[a]=0;return i.O(c)},r=self.webpackChunkdocs=self.webpackChunkdocs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})(); \ No newline at end of file +(()=>{"use strict";var e,t,r,o,a,n={},f={};function i(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,i),r.loaded=!0,r.exports}i.m=n,i.c=f,e=[],i.O=(t,r,o,a)=>{if(!r){var n=1/0;for(c=0;c<e.length;c++){r=e[c][0],o=e[c][1],a=e[c][2];for(var f=!0,d=0;d<r.length;d++)(!1&a||n>=a)&&Object.keys(i.O).every((e=>i.O[e](r[d])))?r.splice(d--,1):(f=!1,a<n&&(n=a));if(f){e.splice(c--,1);var b=o();void 0!==b&&(t=b)}}return t}a=a||0;for(var c=e.length;c>0&&e[c-1][2]>a;c--)e[c]=e[c-1];e[c]=[r,o,a]},i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,i.t=function(e,o){if(1&o&&(e=this(e)),8&o)return e;if("object"==typeof e&&e){if(4&o&&e.__esModule)return e;if(16&o&&"function"==typeof e.then)return e}var a=Object.create(null);i.r(a);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&o&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,i.d(a,n),a},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.f={},i.e=e=>Promise.all(Object.keys(i.f).reduce(((t,r)=>(i.f[r](e,t),t)),[])),i.u=e=>"assets/js/"+({34:"871e3331",53:"935f2afb",217:"3b8c55ea",237:"1df93b7f",355:"e53fa2b7",382:"1102fda7",468:"1a20bc57",514:"1be78505",542:"2d9f39b3",836:"0480b142",860:"3e407b54",918:"17896441",958:"6dbc2e00",971:"c377a04b"}[e]||e)+"."+{34:"b7e0063b",53:"ee4c5b72",217:"a80ecf58",237:"71d7b441",355:"270fcee2",382:"0e12deaa",468:"23883b0e",514:"131974b6",542:"0a265eb2",836:"1f75987b",860:"987a7018",918:"0aaaf3b3",958:"24fcb0eb",971:"b0b8fe80",972:"d5cc17b1"}[e]+".js",i.miniCssF=e=>{},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o={},a="docs:",i.l=(e,t,r,n)=>{if(o[e])o[e].push(t);else{var f,d;if(void 0!==r)for(var b=document.getElementsByTagName("script"),c=0;c<b.length;c++){var u=b[c];if(u.getAttribute("src")==e||u.getAttribute("data-webpack")==a+r){f=u;break}}f||(d=!0,(f=document.createElement("script")).charset="utf-8",f.timeout=120,i.nc&&f.setAttribute("nonce",i.nc),f.setAttribute("data-webpack",a+r),f.src=e),o[e]=[t];var l=(t,r)=>{f.onerror=f.onload=null,clearTimeout(s);var a=o[e];if(delete o[e],f.parentNode&&f.parentNode.removeChild(f),a&&a.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),d&&document.head.appendChild(f)}},i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.p="/buzz/",i.gca=function(e){return e={17896441:"918","871e3331":"34","935f2afb":"53","3b8c55ea":"217","1df93b7f":"237",e53fa2b7:"355","1102fda7":"382","1a20bc57":"468","1be78505":"514","2d9f39b3":"542","0480b142":"836","3e407b54":"860","6dbc2e00":"958",c377a04b:"971"}[e]||e,i.p+i.u(e)},(()=>{var e={303:0,532:0};i.f.j=(t,r)=>{var o=i.o(e,t)?e[t]:void 0;if(0!==o)if(o)r.push(o[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var a=new Promise(((r,a)=>o=e[t]=[r,a]));r.push(o[2]=a);var n=i.p+i.u(t),f=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(o=e[t])&&(e[t]=void 0),o)){var a=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+a+": "+n+")",f.name="ChunkLoadError",f.type=a,f.request=n,o[1](f)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var o,a,n=r[0],f=r[1],d=r[2],b=0;if(n.some((t=>0!==e[t]))){for(o in f)i.o(f,o)&&(i.m[o]=f[o]);if(d)var c=d(i)}for(t&&t(r);b<n.length;b++)a=n[b],i.o(e,a)&&e[a]&&e[a][0](),e[a]=0;return i.O(c)},r=self.webpackChunkdocs=self.webpackChunkdocs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})(); \ No newline at end of file diff --git a/docs.html b/docs.html index af1d3bd58..b06df5d9f 100644 --- a/docs.html +++ b/docs.html @@ -4,7 +4,7 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">Introduction | 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"><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="Introduction | Buzz"><meta data-rh="true" name="description" content="Transcribe and translate audio offline on your personal computer. Powered by"><meta data-rh="true" property="og:description" content="Transcribe and translate audio offline on your personal computer. Powered by"><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/docs"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.js" as="script"> </head> <body class="navigation-with-keyboard"> @@ -20,7 +20,7 @@ <a href="https://github.com/ggerganov/whisper.cpp" target="_blank" rel="noopener noreferrer">Whisper.cpp</a>, <a href="https://github.com/guillaumekln/faster-whisper" target="_blank" rel="noopener noreferrer">Faster Whisper</a>, <a href="https://huggingface.co/models?other=whisper" target="_blank" rel="noopener noreferrer">Whisper-compatible Hugging Face models</a>, and the <a href="https://platform.openai.com/docs/api-reference/introduction" target="_blank" rel="noopener noreferrer">OpenAI Whisper API</a></li><li><a href="#command-line-interface">Command-Line Interface</a></li><li>Available on Mac, Windows, and Linux</li></ul></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/buzz/docs/installation"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Installation</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="#features" class="table-of-contents__link toc-highlight">Features</a></li></ul></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/docs/cli.html b/docs/cli.html index 7ecfe9839..8d3a47c7a 100644 --- a/docs/cli.html +++ b/docs/cli.html @@ -4,13 +4,13 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">CLI | 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/cli"><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="CLI | Buzz"><meta data-rh="true" name="description" content="Commands"><meta data-rh="true" property="og:description" content="Commands"><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/docs/cli"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/cli" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/cli" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.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-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/buzz/docs/usage/file_import">Usage</a></div></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/preferences">Preferences</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/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">CLI</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>CLI</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="commands">Commands<a href="#commands" class="hash-link" aria-label="Direct link to Commands" title="Direct link to Commands"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add"><code>add</code><a href="#add" class="hash-link" aria-label="Direct link to add" title="Direct link to add"></a></h3><p>Start a new transcription task.</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Usage: buzz add [options] [file file file...]</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Options:</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> -t, --task <task> The task to perform. Allowed: translate,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> transcribe. Default: transcribe.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> -m, --model-type <model-type> Model type. Allowed: whisper, whispercpp,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> huggingface, fasterwhisper, openaiapi. Default:</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> whisper.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> -s, --model-size <model-size> Model size. Use only when --model-type is</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> whisper, whispercpp, or fasterwhisper. Allowed:</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> tiny, base, small, medium, large. Default:</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> tiny.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --hfid <id> Hugging Face model ID. Use only when</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --model-type is huggingface. Example:</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "openai/whisper-tiny"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> -l, --language <code> Language code. Allowed: af (Afrikaans), am</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Amharic), ar (Arabic), as (Assamese), az</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Azerbaijani), ba (Bashkir), be (Belarusian),</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> bg (Bulgarian), bn (Bengali), bo (Tibetan), br</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Breton), bs (Bosnian), ca (Catalan), cs</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Czech), cy (Welsh), da (Danish), de (German),</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> el (Greek), en (English), es (Spanish), et</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Estonian), eu (Basque), fa (Persian), fi</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Finnish), fo (Faroese), fr (French), gl</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Galician), gu (Gujarati), ha (Hausa), haw</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Hawaiian), he (Hebrew), hi (Hindi), hr</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Croatian), ht (Haitian Creole), hu</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Hungarian), hy (Armenian), id (Indonesian), is</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Icelandic), it (Italian), ja (Japanese), jw</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Javanese), ka (Georgian), kk (Kazakh), km</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Khmer), kn (Kannada), ko (Korean), la (Latin),</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> lb (Luxembourgish), ln (Lingala), lo (Lao), lt</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Lithuanian), lv (Latvian), mg (Malagasy), mi</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Maori), mk (Macedonian), ml (Malayalam), mn</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Mongolian), mr (Marathi), ms (Malay), mt</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Maltese), my (Myanmar), ne (Nepali), nl</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Dutch), nn (Nynorsk), no (Norwegian), oc</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Occitan), pa (Punjabi), pl (Polish), ps</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Pashto), pt (Portuguese), ro (Romanian), ru</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Russian), sa (Sanskrit), sd (Sindhi), si</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Sinhala), sk (Slovak), sl (Slovenian), sn</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Shona), so (Somali), sq (Albanian), sr</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Serbian), su (Sundanese), sv (Swedish), sw</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Swahili), ta (Tamil), te (Telugu), tg (Tajik),</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> th (Thai), tk (Turkmen), tl (Tagalog), tr</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Turkish), tt (Tatar), uk (Ukrainian), ur</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Urdu), uz (Uzbek), vi (Vietnamese), yi</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> (Yiddish), yo (Yoruba), zh (Chinese). Leave</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> empty to detect language.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> -p, --prompt <prompt> Initial prompt</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --openai-token <token> OpenAI access token. Use only when</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --model-type is openaiapi. Defaults to your</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> previously saved access token, if one exists.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --srt Output result in an SRT file.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --vtt Output result in a VTT file.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --txt Output result in a TXT file.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> -h, --help Displays help on commandline options.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> --help-all Displays help including Qt specific options.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> -v, --version Displays version information.</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Arguments:</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> files Input file paths</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><p><strong>Examples</strong>:</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 comment" style="color:#999988;font-style:italic"># Translate two MP3 files from French to English using OpenAI Whisper API</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">buzz </span><span class="token function" style="color:#d73a49">add</span><span class="token plain"> --task translate --language fr --model-type openaiapi /Users/user/Downloads/1b3b03e4-8db5-ea2c-ace5-b71ff32e3304.mp3 /Users/user/Downloads/koaf9083k1lkpsfdi0.mp3</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># Transcribe an MP4 using Whisper.cpp "small" model and immediately export to SRT and VTT files</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">buzz </span><span class="token function" style="color:#d73a49">add</span><span class="token plain"> --task transcribe --model-type whispercpp --model-size small --prompt </span><span class="token string" style="color:#e3116c">"My initial prompt"</span><span class="token plain"> --srt --vtt /Users/user/Downloads/buzz/1b3b03e4-8db5-ea2c-ace5-b71ff32e3304.mp4</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></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/preferences"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Preferences</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/buzz/docs/faq"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">FAQ</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="#commands" class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href="#add" class="table-of-contents__link toc-highlight"><code>add</code></a></li></ul></li></ul></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/docs/faq.html b/docs/faq.html index 44d022d39..151cbcac8 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -4,16 +4,14 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">FAQ | 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/faq"><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="FAQ | Buzz"><meta data-rh="true" name="description" content="1. Where are the models stored?"><meta data-rh="true" property="og:description" content="1. Where are the models stored?"><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/docs/faq"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/faq" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/faq" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.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-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/buzz/docs/usage/file_import">Usage</a></div></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/preferences">Preferences</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 menu__link--active" aria-current="page" 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">FAQ</span><meta itemprop="position" content="1"></li></ul></nav><div class="theme-doc-markdown markdown"><header><h1>FAQ</h1></header><ol><li><p><strong>Where are the models stored?</strong></p><p>The Whisper models are stored in <code>~/.cache/whisper</code>. The Whisper.cpp models are stored in <code>~/Library/Caches/Buzz</code> -(Mac OS), <code>~/.cache/Buzz</code> (Unix), or <code>C:\Users\<username>\AppData\Local\Buzz\Buzz\Cache</code> (Windows).</p></li><li><p><strong>What can I try if the transcription runs too slowly?</strong></p><p>Speech recognition requires large amount of computation, so one option is to try using a lower Whisper model size or using a Whisper.cpp model to run speech recognition of your computer. If you have access to a computer with GPU that has at least 6GB of VRAM you can try using the Faster Whisper model.</p><p>Buzz also supports using OpenAI API to do speech recognition on a remote server. To use this feature you need to set OpenAI API key in Preferences. See <a href="https://chidiwilliams.github.io/buzz/docs/preferences" target="_blank" rel="noopener noreferrer">Preferences</a> section for more details.</p></li><li><p><strong>How to record system audio?</strong></p><p>To transcribe system audio you need to configure virtual audio device and connect output from the applications you want to transcribe to this virtual speaker. After that you can select it as source in the Buzz. See <a href="https://chidiwilliams.github.io/buzz/docs/usage/live_recording" target="_blank" rel="noopener noreferrer">Usage</a> section for more details.</p><p>Relevant tools:</p><ul><li>Mac OS - <a href="https://github.com/ExistentialAudio/BlackHole" target="_blank" rel="noopener noreferrer">BlackHole</a>.</li><li>Windows - <a href="https://vb-audio.com/Cable/" target="_blank" rel="noopener noreferrer">VB CABLE</a></li><li>Linux - <a href="https://wiki.ubuntu.com/record_system_sound" target="_blank" rel="noopener noreferrer">PulseAudio Volume Control</a></li></ul></li><li><p><strong>What model should I use?</strong></p><p>Model size to use will depend on your hardware and use case. Smaller models will work faster but will have more inaccuracies. Larger models will be more accurate but will require more powerful hardware or longer time to transcribe. </p><p>When choosing among large models consider the following. "Large" is the first released older model, "Large-V2" is later updated model with better accuracy, for some languages considered the most robust and stable. "Large-V3" is the latest model with the best accuracy in many cases, but some times can hallucinate or invent words that were never in the audio. The only sure way to know what model best suits your needs is to test them all in your language. </p></li><li><p><strong>How to get GPU acceleration for faster transcription?</strong></p><p>On Linux GPU acceleration is supported out of the box on Nvidia GPUs. If you still get any issues install <a href="https://developer.nvidia.com/cuda-downloads" target="_blank" rel="noopener noreferrer">CUDA 12</a>, <a href="https://developer.nvidia.com/cublas" target="_blank" rel="noopener noreferrer">cuBLASS</a> and <a href="https://developer.nvidia.com/cudnn" target="_blank" rel="noopener noreferrer">cuDNN</a>.</p><p>On Windows see <a href="https://github.com/chidiwilliams/buzz/blob/main/CONTRIBUTING.md#gpu-support" target="_blank" rel="noopener noreferrer">this note</a> on enabling CUDA GPU support.</p></li><li><p><strong>How to fix <code>Unanticipated host error[PaErrorCode-9999]</code>?</strong></p><p>Check if there are any system settings preventing apps from accessing the microphone.</p><p>On Windows, see if Buzz has permission to use the microphone in Settings -> Privacy -> Microphone. -See method 1 in this video <a href="https://www.youtube.com/watch?v=eRcCYgOuSYQ" target="_blank" rel="noopener noreferrer">https://www.youtube.com/watch?v=eRcCYgOuSYQ</a> -For method 2 there is no need to uninstall the antivirus, but see if you can temporarily disable it or if there are settings that may prevent Buzz from accessing the microphone.</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/cli"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">CLI</div></a></nav></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +(Mac OS), <code>~/.cache/Buzz</code> (Unix), or <code>C:\Users\<username>\AppData\Local\Buzz\Buzz\Cache</code> (Windows).</p></li><li><p><strong>What can I try if the transcription runs too slowly?</strong></p><p>Speech recognition requires large amount of computation, so one option is to try using a lower Whisper model size or using a Whisper.cpp model to run speech recognition of your computer. If you have access to a computer with GPU that has at least 6GB of VRAM you can try using the Faster Whisper model.</p><p>Buzz also supports using OpenAI API to do speech recognition on a remote server. To use this feature you need to set OpenAI API key in Preferences. See <a href="https://chidiwilliams.github.io/buzz/docs/preferences" target="_blank" rel="noopener noreferrer">Preferences</a> section for more details.</p></li><li><p><strong>How to record system audio?</strong></p><p>To transcribe system audio you need to configure virtual audio device and connect output from the applications you want to transcribe to this virtual speaker. After that you can select it as source in the Buzz. See <a href="https://chidiwilliams.github.io/buzz/docs/usage/live_recording" target="_blank" rel="noopener noreferrer">Usage</a> section for more details.</p><p>Relevant tools:</p><ul><li>Mac OS - <a href="https://github.com/ExistentialAudio/BlackHole" target="_blank" rel="noopener noreferrer">BlackHole</a>.</li><li>Windows - <a href="https://vb-audio.com/Cable/" target="_blank" rel="noopener noreferrer">VB CABLE</a></li><li>Linux - <a href="https://wiki.ubuntu.com/record_system_sound" target="_blank" rel="noopener noreferrer">PulseAudio Volume Control</a></li></ul></li><li><p><strong>What model should I use?</strong></p><p>Model size to use will depend on your hardware and use case. Smaller models will work faster but will have more inaccuracies. Larger models will be more accurate but will require more powerful hardware or longer time to transcribe. </p><p>When choosing among large models consider the following. "Large" is the first released older model, "Large-V2" is later updated model with better accuracy, for some languages considered the most robust and stable. "Large-V3" is the latest model with the best accuracy in many cases, but some times can hallucinate or invent words that were never in the audio. The only sure way to know what model best suits your needs is to test them all in your language. </p></li><li><p><strong>How to get GPU acceleration for faster transcription?</strong></p><p>On Linux GPU acceleration is supported out of the box on Nvidia GPUs. If you still get any issues install <a href="https://developer.nvidia.com/cuda-downloads" target="_blank" rel="noopener noreferrer">CUDA 12</a>, <a href="https://developer.nvidia.com/cublas" target="_blank" rel="noopener noreferrer">cuBLASS</a> and <a href="https://developer.nvidia.com/cudnn" target="_blank" rel="noopener noreferrer">cuDNN</a>.</p><p>On Windows see <a href="https://github.com/chidiwilliams/buzz/blob/main/CONTRIBUTING.md#gpu-support" target="_blank" rel="noopener noreferrer">this note</a> on enabling CUDA GPU support.</p><p>For Faster whisper CUDA 12 is required, computers with older CUDA versions will use CPU. </p></li><li><p><strong>How to fix <code>Unanticipated host error[PaErrorCode-9999]</code>?</strong></p><p>Check if there are any system settings preventing apps from accessing the microphone.</p><p>On Windows, see if Buzz has permission to use the microphone in Settings -> Privacy -> Microphone.</p><p>See method 1 in this video <a href="https://www.youtube.com/watch?v=eRcCYgOuSYQ" target="_blank" rel="noopener noreferrer">https://www.youtube.com/watch?v=eRcCYgOuSYQ</a></p><p>For method 2 there is no need to uninstall the antivirus, but see if you can temporarily disable it or if there are settings that may prevent Buzz from accessing the microphone.</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/cli"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">CLI</div></a></nav></div></div></div></div></main></div></div></div> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/docs/installation.html b/docs/installation.html index 5bc91d3e9..1a9cba567 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -4,7 +4,7 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">Installation | 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/installation"><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="Installation | Buzz"><meta data-rh="true" name="description" content="To install Buzz, download the latest version for your operating"><meta data-rh="true" property="og:description" content="To install Buzz, download the latest version for your operating"><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/docs/installation"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/installation" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/installation" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.js" as="script"> </head> <body class="navigation-with-keyboard"> @@ -14,7 +14,7 @@ the <a href="https://apps.apple.com/us/app/buzz-captions/id6446018936?mt=12&itsct=apps_box_badge&itscg=30200" target="_blank" rel="noopener noreferrer">App Store version</a>.)</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="macos-intel-macos-117-and-later">macOS (Intel, macOS 11.7 and later)<a href="#macos-intel-macos-117-and-later" class="hash-link" aria-label="Direct link to macOS (Intel, macOS 11.7 and later)" title="Direct link to macOS (Intel, macOS 11.7 and later)"></a></h2><p>Install via <a href="https://brew.sh/" target="_blank" rel="noopener noreferrer">brew</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"> --cask buzz</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><p>Alternatively, download and run the <code>Buzz-x.y.z.dmg</code> file.</p><p>For Mac Silicon (and for a better experience on Mac Intel), download <a href="https://apps.apple.com/us/app/buzz-captions/id6446018936?mt=12&itsct=apps_box_badge&itscg=30200" target="_blank" rel="noopener noreferrer">Buzz Captions</a> on the App Store.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="windows-windows-10-and-later">Windows (Windows 10 and later)<a href="#windows-windows-10-and-later" class="hash-link" aria-label="Direct link to Windows (Windows 10 and later)" title="Direct link to Windows (Windows 10 and later)"></a></h2><p>Download and run the <code>Buzz-x.y.z.exe</code> file.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="linux">Linux<a href="#linux" class="hash-link" aria-label="Direct link to Linux" title="Direct link to Linux"></a></h2><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 function" style="color:#d73a49">sudo</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">apt-get</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> libportaudio2 libcanberra-gtk-module libcanberra-gtk3-module</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">sudo</span><span class="token plain"> snap </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> buzz</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">sudo</span><span class="token plain"> snap connect buzz:audio-record</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">sudo</span><span class="token plain"> snap connect buzz:password-manager-service</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">sudo</span><span class="token plain"> snap connect buzz:pulseaudio</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">sudo</span><span class="token plain"> snap connect buzz:removable-media</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><p><a href="https://snapcraft.io/buzz" target="_blank" rel="noopener noreferrer"><img loading="lazy" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" alt="Get it from the Snap Store" class="img_ev3q"></a></p><p>Alternatively, on Ubuntu 20.04 and later, install the dependencies:</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 function" style="color:#d73a49">sudo</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">apt-get</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> libportaudio2</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><p>Then, download and extract the <code>Buzz-x.y.z-unix.tar.gz</code> file</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pypi">PyPI<a href="#pypi" class="hash-link" aria-label="Direct link to PyPI" title="Direct link to PyPI"></a></h2><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">pip </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> buzz-captions</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">python -m buzz</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></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"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/buzz/docs/usage/file_import"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">File Import</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="#macos-intel-macos-117-and-later" class="table-of-contents__link toc-highlight">macOS (Intel, macOS 11.7 and later)</a></li><li><a href="#windows-windows-10-and-later" class="table-of-contents__link toc-highlight">Windows (Windows 10 and later)</a></li><li><a href="#linux" class="table-of-contents__link toc-highlight">Linux</a></li><li><a href="#pypi" class="table-of-contents__link toc-highlight">PyPI</a></li></ul></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/docs/preferences.html b/docs/preferences.html index 87e858bf4..977108762 100644 --- a/docs/preferences.html +++ b/docs/preferences.html @@ -4,7 +4,7 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">Preferences | 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/preferences"><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="Preferences | Buzz"><meta data-rh="true" name="description" content="Open the Preferences window from the Menu bar, or click Ctrl/Cmd + ,."><meta data-rh="true" property="og:description" content="Open the Preferences window from the Menu bar, or click Ctrl/Cmd + ,."><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/docs/preferences"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/preferences" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/preferences" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.js" as="script"> </head> <body class="navigation-with-keyboard"> @@ -12,7 +12,7 @@ <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-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/buzz/docs/usage/file_import">Usage</a></div></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/preferences">Preferences</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">Preferences</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>Preferences</h1></header><p>Open the Preferences window from the Menu bar, or click <code>Ctrl/Cmd + ,</code>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="general-preferences">General Preferences<a href="#general-preferences" class="hash-link" aria-label="Direct link to General Preferences" title="Direct link to General Preferences"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="openai-api-preferences">OpenAI API preferences<a href="#openai-api-preferences" class="hash-link" aria-label="Direct link to OpenAI API preferences" title="Direct link to OpenAI API preferences"></a></h3><p><strong>API Key</strong> - key to authenticate your requests to OpenAI API. To get API key from OpenAI see <a href="https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key" target="_blank" rel="noopener noreferrer">this article</a>. </p><p><strong>Base Url</strong> - By default all requests are sent to API provided by OpenAI company. Their api url is <code>https://api.openai.com/v1/</code>. Compatible APIs are also provided by other companies. List of available API urls you can find on <a href="https://github.com/chidiwilliams/buzz/discussions/827" target="_blank" rel="noopener noreferrer">discussion page</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="default-export-file-name">Default export file name<a href="#default-export-file-name" class="hash-link" aria-label="Direct link to Default export file name" title="Direct link to Default export file name"></a></h3><p>Sets the default export file name for file transcriptions. For example, a value of <code>{{ input_file_name }} ({{ task }}d on {{ date_time }})</code> will save TXT exports as <code>Input Filename (transcribed on 19-Sep-2023 20-39-25).txt</code> by default.</p><p>Available variables:</p><table><thead><tr><th>Key</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>input_file_name</code></td><td>File name of the imported file</td><td><code>audio</code> (e.g. if the imported file path was <code>/path/to/audio.wav</code></td></tr><tr><td><code>task</code></td><td>Transcription task</td><td><code>transcribe</code>, <code>translate</code></td></tr><tr><td><code>language</code></td><td>Language code</td><td><code>en</code>, <code>fr</code>, <code>yo</code>, etc.</td></tr><tr><td><code>model_type</code></td><td>Model type</td><td><code>Whisper</code>, <code>Whisper.cpp</code>, <code>Faster Whisper</code>, etc.</td></tr><tr><td><code>model_size</code></td><td>Model size</td><td><code>tiny</code>, <code>base</code>, <code>small</code>, <code>medium</code>, <code>large</code>, etc.</td></tr><tr><td><code>date_time</code></td><td>Export time (format: <code>%d-%b-%Y %H-%M-%S</code>)</td><td><code>19-Sep-2023 20-39-25</code></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="live-transcript-exports">Live transcript exports<a href="#live-transcript-exports" class="hash-link" aria-label="Direct link to Live transcript exports" title="Direct link to Live transcript exports"></a></h3><p>Live transcription export can be used to integrate Buzz with other applications like OBS Studio. When enabled, live text transcripts will be exported to a text file as they get generated and translated.</p><p>If AI translation is enabled for live recordings, the translated text will also be exported to the text file. Filename for the translated text will end with <code>.translated.txt</code>.</p></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/usage/translations"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Translations</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="#general-preferences" class="table-of-contents__link toc-highlight">General Preferences</a><ul><li><a href="#openai-api-preferences" class="table-of-contents__link toc-highlight">OpenAI API preferences</a></li><li><a href="#default-export-file-name" class="table-of-contents__link toc-highlight">Default export file name</a></li><li><a href="#live-transcript-exports" class="table-of-contents__link toc-highlight">Live transcript exports</a></li></ul></li></ul></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/docs/usage/file_import.html b/docs/usage/file_import.html index cf8ef6b7f..72b326be1 100644 --- a/docs/usage/file_import.html +++ b/docs/usage/file_import.html @@ -4,14 +4,14 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">File Import | 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/file_import"><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="File Import | Buzz"><meta data-rh="true" name="description" content="To import a file:"><meta data-rh="true" property="og:description" content="To import a file:"><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/file_import"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage/file_import" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage/file_import" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.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-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/buzz/docs/usage/file_import">Usage</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/buzz/docs/usage/file_import">File Import</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/buzz/docs/usage/live_recording">Live Recording</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/buzz/docs/usage/translations">Translations</a></li></ul></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/preferences">Preferences</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 class="breadcrumbs__item"><span class="breadcrumbs__link">Usage</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">File Import</span><meta itemprop="position" content="2"></li></ul></nav><div class="theme-doc-markdown markdown"><header><h1>File Import</h1></header><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></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/usage/live_recording"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Live Recording</div></a></nav></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/docs/usage/live_recording.html b/docs/usage/live_recording.html index df0937eab..ef00a9936 100644 --- a/docs/usage/live_recording.html +++ b/docs/usage/live_recording.html @@ -4,7 +4,7 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">Live Recording | 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/live_recording"><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="Live Recording | Buzz"><meta data-rh="true" name="description" content="To start a live recording:"><meta data-rh="true" property="og:description" content="To start a live recording:"><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/live_recording"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage/live_recording" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage/live_recording" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.js" as="script"> </head> <body class="navigation-with-keyboard"> @@ -17,7 +17,7 @@ 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><h3 class="anchor anchorWithStickyNavbar_LWe7" id="record-audio-playing-from-computer-windows">Record audio playing from computer (Windows)<a href="#record-audio-playing-from-computer-windows" class="hash-link" aria-label="Direct link to Record audio playing from computer (Windows)" title="Direct link to Record audio playing from computer (Windows)"></a></h3><p>To transcribe system audio you need to configure virtual audio device and connect output from the applications you whant to transcribe to this virtual speaker. After that you can select it as source in the Buzz.</p><ol><li><p>Install <a href="https://vb-audio.com/Cable/" target="_blank" rel="noopener noreferrer">VB CABLE</a> as virtual audio device. </p></li><li><p>Configure using Windows Sound settings. Right-click on the speaker icon in the system tray and select "Open Sound settings". In the "Choose your output device" dropdown select "CABLE Input" to send all system sound to the virtual device or use "Advanced sound options" to select application that will output their sound to this device.</p></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="record-audio-playing-from-computer-linux">Record audio playing from computer (Linux)<a href="#record-audio-playing-from-computer-linux" class="hash-link" aria-label="Direct link to Record audio playing from computer (Linux)" title="Direct link to Record audio playing from computer (Linux)"></a></h3><p>As described on <a href="https://wiki.ubuntu.com/record_system_sound" target="_blank" rel="noopener noreferrer">Ubuntu Wiki</a> on any Linux with pulse audio you can redirect application audio to a virtual speaker. After that you can select it as source in Buzz.</p><p>Overall steps:</p><ol><li>Launch application that will produce the sound you want to transcribe and start the playback. For example start a video in a media player. </li><li>Launch Buzz and open Live recording screen, so you see the settings.</li><li>Configure sound routing from the application you want to transcribe sound from to Buzz in <code>Recording tab</code> of the PulseAudio Volume Control (<code>pavucontrol</code>).</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/usage/file_import"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">File Import</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/buzz/docs/usage/translations"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Translations</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="#record-audio-playing-from-computer-macos" class="table-of-contents__link toc-highlight">Record audio playing from computer (macOS)</a></li><li><a href="#record-audio-playing-from-computer-windows" class="table-of-contents__link toc-highlight">Record audio playing from computer (Windows)</a></li><li><a href="#record-audio-playing-from-computer-linux" class="table-of-contents__link toc-highlight">Record audio playing from computer (Linux)</a></li></ul></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/docs/usage/translations.html b/docs/usage/translations.html index 596f9dc1c..b5b683a0c 100644 --- a/docs/usage/translations.html +++ b/docs/usage/translations.html @@ -4,13 +4,13 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">Translations | 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/translations"><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="Translations | Buzz"><meta data-rh="true" name="description" content="Default Translation task uses Whisper model ability to translate to English. Since version 1.0.0 Buzz supports additional AI translations to any other language."><meta data-rh="true" property="og:description" content="Default Translation task uses Whisper model ability to translate to English. Since version 1.0.0 Buzz supports additional AI translations to any other language."><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/translations"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage/translations" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/usage/translations" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.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-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/buzz/docs/usage/file_import">Usage</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/buzz/docs/usage/file_import">File Import</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/buzz/docs/usage/live_recording">Live Recording</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/buzz/docs/usage/translations">Translations</a></li></ul></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/preferences">Preferences</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 class="breadcrumbs__item"><span class="breadcrumbs__link">Usage</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Translations</span><meta itemprop="position" content="2"></li></ul></nav><div class="theme-doc-markdown markdown"><header><h1>Translations</h1></header><p>Default <code>Translation</code> task uses Whisper model ability to translate to English. Since version <code>1.0.0</code> Buzz supports additional AI translations to any other language. </p><p>To use translation feature you will need to configure OpenAI API key and translation settings. Set OpenAI API ket in Preferences. Buzz also supports custom locally running translation AIs that support OpenAI API. For more information on locally running AIs see <a href="https://ollama.com/blog/openai-compatibility" target="_blank" rel="noopener noreferrer">ollama</a> or <a href="https://lmstudio.ai/" target="_blank" rel="noopener noreferrer">LM Studio</a>. </p><p>To configure translation for Live recordings enable it in Advances settings dialog of the Live Recording settings. Enter AI model to use and prompt with instructions for the AI on how to translate. Translation option is also available for files that already have speech recognised. Use Translate button on transcription viewer toolbar.</p><p>For AI to know how to translate enter translation instructions in the "Instructions for AI" section. In your instructions you should describe to what language you want it to translate the text to. Also, you may need to add additional instructions to not add any notes or comments as AIs tend to add them. Example instructions to translate English subtitles to Spanish:</p><blockquote><p>You are a professional translator, skilled in translating English to Spanish. You will only translate each sentence sent to you into Spanish and not add any notes or comments.</p></blockquote><p>If you enable "Enable live recording transcription export" in Preferences, Live text transcripts will be exported to a text file as they get generated and translated. This file can be used to further integrate Live transcripts with other applications like OBS Studio.</p><p>Approximate cost of translation for 1 hour long audio with ChatGPT <code>gpt-4o</code> model is around 0.50$</p></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/usage/live_recording"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Live Recording</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/buzz/docs/preferences"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Preferences</div></a></nav></div></div></div></div></main></div></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file diff --git a/index.html b/index.html index 92c2132d3..298efb569 100644 --- a/index.html +++ b/index.html @@ -4,13 +4,13 @@ <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">Buzz</title><meta data-rh="true" property="og:title" content="Buzz"><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/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/" hreflang="en"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/" hreflang="x-default"><script data-rh="true">function maybeInsertBanner(){window.__DOCUSAURUS_INSERT_BASEURL_BANNER&&insertBanner()}function insertBanner(){var n=document.getElementById("__docusaurus-base-url-issue-banner-container");if(n){n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/buzz/</span> </p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n';var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,r="/"===s.substr(-1)?s:s+"/";e.innerHTML=r}}window.__DOCUSAURUS_INSERT_BASEURL_BANNER=!0,document.addEventListener("DOMContentLoaded",maybeInsertBanner)</script><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css"> -<link rel="preload" href="/buzz/assets/js/runtime~main.bfc37002.js" as="script"> +<link rel="preload" href="/buzz/assets/js/runtime~main.23ac727b.js" as="script"> <link rel="preload" href="/buzz/assets/js/main.5fe13378.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 id="__docusaurus-base-url-issue-banner-container"></div></div> -<script src="/buzz/assets/js/runtime~main.bfc37002.js"></script> +<script src="/buzz/assets/js/runtime~main.23ac727b.js"></script> <script src="/buzz/assets/js/main.5fe13378.js"></script> </body> </html> \ No newline at end of file