Current section
Files
Jump to
Current section
Files
doc/readme.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.31.0">
<meta name="project" content="YoutubeCaptions v0.1.0">
<title>YoutubeCaptions — YoutubeCaptions v0.1.0</title>
<link rel="stylesheet" href="dist/html-elixir-3ZLIM5JF.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
<script src="dist/sidebar_items-0BF83355.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-CILPWI2Q.js"></script>
</head>
<body data-type="extras" class="page-extra">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<div>
<a href="readme.html" class="sidebar-projectName" translate="no">
YoutubeCaptions
</a>
<div class="sidebar-projectVersion" translate="no">
v0.1.0
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of YoutubeCaptions</span>
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<div class="autocomplete">
</div>
<h1>
<a href="https://github.com/Valian/youtube_captions/blob/v0.1.0/README.md#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span>YoutubeCaptions</span>
</h1>
<p><a href="https://hex.pm/packages/youtube_captions"><img src="https://img.shields.io/hexpm/v/youtube_captions.svg" alt="Module Version"/></a>
<a href="https://hexdocs.pm/youtube_captions/"><img src="https://img.shields.io/badge/hex-docs-lightgreen.svg" alt="Hex Docs"/></a>
<a href="https://hex.pm/packages/youtube_captions"><img src="https://img.shields.io/hexpm/dt/youtube_captions.svg" alt="Total Download"/></a>
<a href="https://github.com/Valian/youtube_captions/blob/main/LICENSE.md"><img src="https://img.shields.io/hexpm/l/youtube_captions.svg" alt="License"/></a></p><p>An elixir library for fetching Youtube Captions without API key. Uses <a href="https://github.com/wojtekmach/req">Req</a> under the hood.</p><h2 id="installation" class="section-heading">
<a href="#installation" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Installation</span>
</h2>
<p>The package can be installed by adding <code class="inline">youtube_captions</code> to your list of dependencies in <code class="inline">mix.exs</code>:</p><pre><code class="makeup elixir" translate="no"><span class="kd">def</span><span class="w"> </span><span class="nf">deps</span><span class="w"> </span><span class="k" data-group-id="1410703989-1">do</span><span class="w">
</span><span class="p" data-group-id="1410703989-2">[</span><span class="w">
</span><span class="p" data-group-id="1410703989-3">{</span><span class="ss">:youtube_captions</span><span class="p">,</span><span class="w"> </span><span class="s">"~> 0.1.0"</span><span class="p" data-group-id="1410703989-3">}</span><span class="w">
</span><span class="p" data-group-id="1410703989-2">]</span><span class="w">
</span><span class="k" data-group-id="1410703989-1">end</span></code></pre><p>And run <a href="https://hexdocs.pm/mix/Mix.Tasks.Deps.Get.html"><code class="inline">mix deps.get</code></a>.</p><h2 id="usage" class="section-heading">
<a href="#usage" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Usage</span>
</h2>
<p>First find video identifier. You can find it in the YouTube URL <code class="inline">?v=VIDEO_ID</code>.</p><p>Then you can download captions by calling <code class="inline">YoutubeCaptions.get_subtitles(video_id, language)</code>. Language is optional and defaults to <code class="inline">en</code>. </p><p>If successfull, you'll get list of subtitles in format <code class="inline">%{start: float(), duration: float(), text: String.t()}</code></p><h3 id="examples" class="section-heading">
<a href="#examples" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Examples</span>
</h3>
<pre><code class="makeup elixir" translate="no"><span class="nc">YoutubeCaptions</span><span class="o">.</span><span class="n">get_subtitles</span><span class="p" data-group-id="1180671906-1">(</span><span class="s">"JvBT4XBdoUE"</span><span class="p">,</span><span class="w"> </span><span class="s">"en"</span><span class="p" data-group-id="1180671906-1">)</span><span class="w">
</span><span class="c1">#=> {:ok,</span><span class="w">
</span><span class="c1">#=> [</span><span class="w">
</span><span class="c1">#=> %{start: 0.99, text: "[Music]", duration: 6.87},</span><span class="w">
</span><span class="c1">#=> %{start: 14.42, text: "thank you so hello everyone and thank", duration: 3.66},</span><span class="w">
</span><span class="c1">#=> ...</span><span class="w">
</span><span class="c1">#=> ]}</span><span class="w">
</span><span class="c1"># You can customize Req options by passing third parameter</span><span class="w">
</span><span class="nc">YoutubeCaptions</span><span class="o">.</span><span class="n">get_subtitles</span><span class="p" data-group-id="1180671906-2">(</span><span class="s">"JvBT4XBdoUE"</span><span class="p">,</span><span class="w"> </span><span class="s">"en"</span><span class="p">,</span><span class="w"> </span><span class="ss">receive_timeout</span><span class="p">:</span><span class="w"> </span><span class="mi">10_000</span><span class="p" data-group-id="1180671906-2">)</span><span class="w">
</span></code></pre><h2 id="credits" class="section-heading">
<a href="#credits" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Credits</span>
</h2>
<p>Heavily inspired by <a href="https://github.com/algolia/youtube-captions-scraper">youtube-captions-scraper</a>.</p><h2 id="license" class="section-heading">
<a href="#license" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">License</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="nc">Copyright</span><span class="w"> </span><span class="err">©</span><span class="w"> </span><span class="mi">2023</span><span class="o">-</span><span class="n">present</span><span class="w"> </span><span class="nc">Jakub</span><span class="w"> </span><span class="nc">Ska</span><span class="n">łecki</span><span class="w">
</span><span class="nc">This</span><span class="w"> </span><span class="n">work</span><span class="w"> </span><span class="n">is</span><span class="w"> </span><span class="n">free</span><span class="o">.</span><span class="w"> </span><span class="nc">You</span><span class="w"> </span><span class="n">can</span><span class="w"> </span><span class="n">redistribute</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="ow">and</span><span class="o">/</span><span class="ow">or</span><span class="w"> </span><span class="n">modify</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="n">under</span><span class="w"> </span><span class="n">the</span><span class="w">
</span><span class="n">terms</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="nc">MIT</span><span class="w"> </span><span class="nc">License</span><span class="o">.</span><span class="w"> </span><span class="nc">See</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="nc">LICENSE</span><span class="o">.</span><span class="n">md</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">more</span><span class="w"> </span><span class="n">details</span><span class="o">.</span></code></pre>
<div class="bottom-actions">
<div class="bottom-actions-item">
<a href="api-reference.html" class="bottom-actions-button" rel="prev">
<span class="subheader">
← Previous Page
</span>
<span class="title">
API Reference
</span>
</a>
</div>
<div class="bottom-actions-item">
</div>
</div>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/youtube_captions/0.1.0" class="footer-hex-package">Hex Package</a>
<a href="https://preview.hex.pm/preview/youtube_captions/0.1.0">Hex Preview</a>
(<a href="https://preview.hex.pm/preview/youtube_captions/0.1.0/show/README.md">current file</a>)
</span>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="YoutubeCaptions.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.0) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
</body>
</html>