Current section
Files
Jump to
Current section
Files
doc/YoutubeCaptions.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="modules" class="page-module">
<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/lib/youtube_captions.ex#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 translate="no">YoutubeCaptions</span>
<small class="app-vsn" translate="no">(YoutubeCaptions v0.1.0)</small>
</h1>
<section id="moduledoc">
<p>Youtube captions downloader. Exposes a single function <a href="#get_subtitles/3"><code class="inline">get_subtitles/3</code></a>.</p><p>Fetching is done using library Req. You can pass additional options to <a href="https://hexdocs.pm/req/0.4.8/Req.html#get/2"><code class="inline">Req.get/2</code></a> as 3rd argument.</p><h2 id="module-examples" class="section-heading">
<a href="#module-examples" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Examples</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex> </span><span class="nc">YoutubeCaptions</span><span class="o">.</span><span class="n">get_subtitles</span><span class="p" data-group-id="3484363362-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="3484363362-1">)</span><span class="w">
</span><span class="p" data-group-id="3484363362-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-3">[</span><span class="w">
</span><span class="p" data-group-id="3484363362-4">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">0.99</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"[Music]"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">6.87</span><span class="p" data-group-id="3484363362-4">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-5">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">14.42</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"thank you so hello everyone and thank"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">3.66</span><span class="p" data-group-id="3484363362-5">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-6">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">16.67</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"you for joining me in this talk where"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">3.93</span><span class="p" data-group-id="3484363362-6">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-7">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">18.08</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"we're going to explore the legacy of Joe"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">3.99</span><span class="p" data-group-id="3484363362-7">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-8">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">20.6</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"Armstrong the principal inventor of"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">4.74</span><span class="p" data-group-id="3484363362-8">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-9">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">22.07</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"Erlang who unfortunately recently passed"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">5.82</span><span class="p" data-group-id="3484363362-9">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-10">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">25.34</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"away and so Joe sadly will not be with"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">3.18</span><span class="p" data-group-id="3484363362-10">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="3484363362-11">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">27.89</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"us anymore"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">2.88</span><span class="p" data-group-id="3484363362-11">}</span><span class="p">,</span><span class="w">
</span><span class="n">...</span><span class="w">
</span><span class="p" data-group-id="3484363362-3">]</span><span class="p" data-group-id="3484363362-2">}</span></code></pre>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:caption/0" translate="no">caption()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:lang/0" translate="no">lang()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:req_options/0" translate="no">req_options()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:video_id/0" translate="no">video_id()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_subtitles/3" translate="no">get_subtitles(video_id, lang \\ "en", req_options \\ [])</a>
</div>
<div class="summary-synopsis"><p>Downloads subtitles of YouTube video. You have to specify <code class="inline">video_id</code> and optionally language. Defaults to <code class="inline">en</code>.</p></div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Types</span>
</h1>
<div class="types-list">
<section class="detail" id="t:caption/0">
<div class="detail-header">
<a href="#t:caption/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">caption()</h1>
<a href="https://github.com/Valian/youtube_captions/blob/v0.1.0/lib/youtube_captions.ex#L29" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> caption() :: %{start: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">float</a>(), duration: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">float</a>(), text: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()}</pre>
</div>
</section>
</section>
<section class="detail" id="t:lang/0">
<div class="detail-header">
<a href="#t:lang/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">lang()</h1>
<a href="https://github.com/Valian/youtube_captions/blob/v0.1.0/lib/youtube_captions.ex#L28" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> lang() :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="t:req_options/0">
<div class="detail-header">
<a href="#t:req_options/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">req_options()</h1>
<a href="https://github.com/Valian/youtube_captions/blob/v0.1.0/lib/youtube_captions.ex#L30" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> req_options() :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">keyword</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="t:video_id/0">
<div class="detail-header">
<a href="#t:video_id/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">video_id()</h1>
<a href="https://github.com/Valian/youtube_captions/blob/v0.1.0/lib/youtube_captions.ex#L27" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> video_id() :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()</pre>
</div>
</section>
</section>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="get_subtitles/3">
<span id="get_subtitles/1"></span>
<span id="get_subtitles/2"></span>
<div class="detail-header">
<a href="#get_subtitles/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_subtitles(video_id, lang \\ "en", req_options \\ [])</h1>
<a href="https://github.com/Valian/youtube_captions/blob/v0.1.0/lib/youtube_captions.ex#L56" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> get_subtitles(<a href="#t:video_id/0">video_id</a>(), <a href="#t:lang/0">lang</a>(), <a href="#t:req_options/0">req_options</a>()) ::
{:ok, [<a href="#t:caption/0">caption</a>()]} | {:error, <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()}</pre>
</div>
<p>Downloads subtitles of YouTube video. You have to specify <code class="inline">video_id</code> and optionally language. Defaults to <code class="inline">en</code>.</p><p>Fetching is done using library Req. If you want, you can pass additional params to <a href="https://hexdocs.pm/req/0.4.8/Req.html#get/2"><code class="inline">Req.get/2</code></a> using 3rd argument.</p><h2 id="get_subtitles/3-examples" class="section-heading">
<a href="#get_subtitles/3-examples" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Examples</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex> </span><span class="nc">YoutubeCaptions</span><span class="o">.</span><span class="n">get_subtitles</span><span class="p" data-group-id="6196922167-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="6196922167-1">)</span><span class="w">
</span><span class="p" data-group-id="6196922167-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="6196922167-3">[</span><span class="w">
</span><span class="p" data-group-id="6196922167-4">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">0.99</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"[Music]"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">6.87</span><span class="p" data-group-id="6196922167-4">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="6196922167-5">%{</span><span class="ss">start</span><span class="p">:</span><span class="w"> </span><span class="mf">14.42</span><span class="p">,</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="s">"thank you so hello everyone and thank"</span><span class="p">,</span><span class="w"> </span><span class="ss">duration</span><span class="p">:</span><span class="w"> </span><span class="mf">3.66</span><span class="p" data-group-id="6196922167-5">}</span><span class="p">,</span><span class="w">
</span><span class="n">...</span><span class="w">
</span><span class="p" data-group-id="6196922167-3">]</span><span class="p" data-group-id="6196922167-2">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">YoutubeCaptions</span><span class="o">.</span><span class="n">get_subtitles</span><span class="p" data-group-id="6196922167-6">(</span><span class="s">"JvBT4XBdoUE"</span><span class="p">,</span><span class="w"> </span><span class="s">"de"</span><span class="p" data-group-id="6196922167-6">)</span><span class="w">
</span><span class="p" data-group-id="6196922167-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="s">"Unable to find transcript for language de"</span><span class="p" data-group-id="6196922167-7">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">YoutubeCaptions</span><span class="o">.</span><span class="n">get_subtitles</span><span class="p" data-group-id="6196922167-8">(</span><span class="s">"invalid"</span><span class="p">,</span><span class="w"> </span><span class="s">"en"</span><span class="p" data-group-id="6196922167-8">)</span><span class="w">
</span><span class="p" data-group-id="6196922167-9">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="s">"Could not find captions for video"</span><span class="p" data-group-id="6196922167-9">}</span></code></pre>
</section>
</section>
</div>
</section>
<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/lib/youtube_captions.ex">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>