<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/rust-obs-plugins @ master</title>
<meta name="description" content="README.md in fork/rust-obs-plugins at master.">
<meta property="og:title" content="README.md - fork/rust-obs-plugins @ master">
<meta property="og:description" content="README.md in fork/rust-obs-plugins at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="4f3ec5468e257ba278ee94ab1f764aaed48b30db">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust-obs-plugins</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust-obs-plugins</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Bennett Hardwick</span><span class="commit-message" data-commit="6d32c5cdfa12a4b6e8756b3b2509a8dbba813c1f">Update README.md</span><span class="snapshot-sha sha" data-commit="6d32c5cdfa12a4b6e8756b3b2509a8dbba813c1f">6d32c5c</span><time datetime="2021-12-06T21:15:00+10:00" title="2021-12-06 21:15:00 +1000">2021-12-06</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a href="/fork/rust-obs-plugins/ref/feature/try-add-rofi/">feature/try-add-rofi</a><a class="current" href="/fork/rust-obs-plugins/ref/master/">master</a><a class="all" href="/fork/rust-obs-plugins/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust-obs-plugins/">rust-obs-plugins</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>3.9 KiB</span><span>131 lines</span></span><span class="actions"><a class="raw" href="/fork/rust-obs-plugins/raw/2b5bf37fe13be0c55601b8682405ac5d5741515b/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Rust OBS Wrapper</h1>
<p><a href="https://travis-ci.org/bennetthardwick/rust-obs-plugins"><img src="https://travis-ci.org/bennetthardwick/rust-obs-plugins.svg?branch=master" alt="Build Status" /></a>
<a href="https://docs.rs/obs-wrapper"><img src="https://docs.rs/obs-wrapper/badge.svg" alt="Wrapper Docs" /></a></p>
<p>A safe wrapper around the OBS API, useful for creating OBS sources, filters and effects. The wrapper is quite incomplete and will most likely see dramatic API changes in the future.</p>
<p>This repo also includes plugins creating using the wrapper in the <code>/plugins</code> folder.</p>
<h2>Plugins</h2>
<table><thead><tr><th>Folder</th><th>Description</th></tr></thead><tbody>
<tr><td>/scroll-focus-filter</td><td>an OBS filter that will zoom into the currently focused X window</td></tr>
<tr><td>/rnnoise-denoiser-filter</td><td>an OBS filter for removing background noise from your Mic</td></tr>
</tbody></table>
<h2>Usage</h2>
<p>In your <code>Cargo.toml</code> file add the following section, substituting <code>&lt;module-name&gt;</code> for the name of
the module:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>dependencies</a-pr><a-p>]</a-p>
<a-pr>obs-wrapper</a-pr> <a-o>=</a-o> <a-s>&quot;0.3&quot;</a-s>

<a-p>[</a-p><a-pr>lib</a-pr><a-p>]</a-p>
<a-pr>name</a-pr> <a-o>=</a-o> <a-s>&quot;&lt;module-name&gt;&quot;</a-s>
<a-pr>crate-type</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;cdylib&quot;</a-s><a-p>]</a-p></pre>
<p>The process for creating a plugin is:</p>
<ol>
<li>Create a struct that implements Module</li>
<li>Create a struct that will store the plugin state</li>
<li>Implement the required traits for the module</li>
<li>Enable the traits which have been enabled in the module <code>load</code> method</li>
</ol>
<pre class="language-rust"><a-k>use</a-k> obs_wrapper<a-p>::{</a-p>
    <a-c>// Everything required for modules</a-c>
    prelude<a-p>::</a-p><a-o>*</a-o><a-p>,</a-p>
    <a-c>// Everything required for creating a source</a-c>
    source<a-p>::</a-p><a-o>*</a-o><a-p>,</a-p>
    <a-c>// Macro for registering modules</a-c>
    obs_register_module<a-p>,</a-p>
    <a-c>// Macro for creating strings</a-c>
    obs_string<a-p>,</a-p>
<a-p>};</a-p>

<a-c>// The module that will handle creating the source.</a-c>
<a-k>struct</a-k> <a-t>TestModule</a-t> <a-p>{</a-p>
    <a-pr>context</a-pr><a-p>:</a-p> <a-t>ModuleContext</a-t>
<a-p>};</a-p>

<a-c>// The source that will be shown inside OBS.</a-c>
<a-k>struct</a-k> <a-t>TestSource</a-t><a-p>;</a-p>

<a-c>// The state of the source that is managed by OBS and used in each trait method.</a-c>
<a-k>struct</a-k> <a-t>SourceData</a-t><a-p>;</a-p>

<a-c>// Implement the Sourceable trait for TestSource, this is required for each source.</a-c>
<a-c>// It allows you to specify the source ID and type.</a-c>
<a-k>impl</a-k> <a-t>Sourceable</a-t> <a-k>for</a-k> <a-t>TestSource</a-t> <a-p>{</a-p>
    <a-k>fn</a-k> <a-f>get_id</a-f><a-p>()</a-p> -&gt; <a-t>ObsString</a-t> <a-p>{</a-p>
        <a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;test_source&quot;</a-s><a-p>)</a-p>
    <a-p>}</a-p>

    <a-k>fn</a-k> <a-f>get_type</a-f><a-p>()</a-p> -&gt; <a-t>SourceType</a-t> <a-p>{</a-p>
        <a-t>SourceType</a-t><a-p>::</a-p><a-cr>FILTER</a-cr>
    <a-p>}</a-p>
<a-p>}</a-p>

<a-c>// Allow OBS to show a name for the source</a-c>
<a-k>impl</a-k> <a-t>GetNameSource</a-t><a-p>&lt;</a-p><a-t>SourceData</a-t><a-p>&gt;</a-p> <a-k>for</a-k> <a-t>TestSource</a-t> <a-p>{</a-p>
    <a-k>fn</a-k> <a-f>get_name</a-f><a-p>()</a-p> -&gt; <a-t>ObsString</a-t> <a-p>{</a-p>
        <a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;Test Source&quot;</a-s><a-p>)</a-p>
    <a-p>}</a-p>
<a-p>}</a-p>

<a-c>// Implement the Module trait for TestModule. This will handle the creation of the source and</a-c>
<a-c>// has some methods for telling OBS a bit about itself.</a-c>
<a-k>impl</a-k> <a-t>Module</a-t> <a-k>for</a-k> <a-t>TestModule</a-t> <a-p>{</a-p>
    <a-k>fn</a-k> <a-f>new</a-f><a-p>(</a-p><a-v>context</a-v><a-p>:</a-p> <a-t>ModuleContext</a-t><a-p>)</a-p> -&gt; <a-t>Self</a-t> <a-p>{</a-p>
        <a-t>Self</a-t> <a-p>{</a-p> context <a-p>}</a-p>
    <a-p>}</a-p>

    <a-k>fn</a-k> <a-f>get_ctx</a-f><a-p>(</a-p><a-o>&amp;</a-o><a-v>self</a-v><a-p>)</a-p> -&gt; <a-o>&amp;</a-o><a-t>ModuleContext</a-t> <a-p>{</a-p>
        <a-o>&amp;</a-o><a-v>self</a-v><a-p>.</a-p><a-pr>context</a-pr>
    <a-p>}</a-p>

    <a-c>// Load the module - create all sources, returning true if all went well.</a-c>
    <a-k>fn</a-k> <a-f>load</a-f><a-p>(</a-p><a-o>&amp;</a-o><a-k>mut</a-k> <a-v>self</a-v><a-p>,</a-p> <a-v>load_context</a-v><a-p>:</a-p> <a-o>&amp;</a-o><a-k>mut</a-k> <a-t>LoadContext</a-t><a-p>)</a-p> -&gt; <a-t>bool</a-t> <a-p>{</a-p>
        <a-c>// Create the source</a-c>
        <a-k>let</a-k> source = load_context
            <a-p>.</a-p><a-f>create_source_builder</a-f><a-p>::&lt;</a-p><a-t>TestSource</a-t><a-p>,</a-p> <a-t>SourceData</a-t><a-p>&gt;()</a-p>
            <a-c>// Since GetNameSource is implemented, this method needs to be called to</a-c>
            <a-c>// enable it.</a-c>
            <a-p>.</a-p><a-f>enable_get_name</a-f><a-p>()</a-p>
            <a-p>.</a-p><a-f>build</a-f><a-p>();</a-p>

        <a-c>// Tell OBS about the source so that it will show it.</a-c>
        load_context<a-p>.</a-p><a-f>register_source</a-f><a-p>(</a-p>source<a-p>);</a-p>

        <a-c>// Nothing could have gone wrong, so return true.</a-c>
        <a-co>true</a-co>
    <a-p>}</a-p>

    <a-k>fn</a-k> <a-f>description</a-f><a-p>()</a-p> -&gt; <a-t>ObsString</a-t> <a-p>{</a-p>
        <a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;A great test module.&quot;</a-s><a-p>)</a-p>
    <a-p>}</a-p>

    <a-k>fn</a-k> <a-f>name</a-f><a-p>()</a-p> -&gt; <a-t>ObsString</a-t> <a-p>{</a-p>
        <a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;Test Module&quot;</a-s><a-p>)</a-p>
    <a-p>}</a-p>

    <a-k>fn</a-k> <a-f>author</a-f><a-p>()</a-p> -&gt; <a-t>ObsString</a-t> <a-p>{</a-p>
        <a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;Bennett&quot;</a-s><a-p>)</a-p>
    <a-p>}</a-p>
<a-p>}</a-p></pre>
<h3>Installation</h3>
<ol>
<li>Run <code>cargo build --release</code></li>
<li>Copy <code>/target/release/&lt;module-name&gt;.so</code> to your OBS plugins folder (<code>/usr/lib/obs-plugins/</code>)</li>
<li>The plugin should be available for use from inside OBS</li>
</ol>
<h2>License</h2>
<p>Like <a href="https://github.com/obsproject/obs-studio">obs-studio</a>, <code>obs-wrapper</code> is licensed under GNU General Public License v2.0.</p>
<p>See <a href="/fork/rust-obs-plugins/ref/master/blob/LICENSE">LICENSE</a> for details.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Rust OBS Wrapper</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">[![Build Status](https://travis-ci.org/bennetthardwick/rust-obs-plugins.svg?branch=master)](https://travis-ci.org/bennetthardwick/rust-obs-plugins)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[![Wrapper Docs](https://docs.rs/obs-wrapper/badge.svg)](https://docs.rs/obs-wrapper)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">A safe wrapper around the OBS API, useful for creating OBS sources, filters and effects. The wrapper is quite incomplete and will most likely see dramatic API changes in the future.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">This repo also includes plugins creating using the wrapper in the `/plugins` folder.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>##</a-p> <a-tt>Plugins</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">| Folder                    | Description                                                      |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">|---------------------------|------------------------------------------------------------------|</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">| /scroll-focus-filter      | an OBS filter that will zoom into the currently focused X window |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">| /rnnoise-denoiser-filter  | an OBS filter for removing background noise from your Mic        |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>##</a-p> <a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">In your `Cargo.toml` file add the following section, substituting `&lt;module-name&gt;` for the name of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">the module:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>[</a-p><a-pr>dependencies</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>obs-wrapper </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0.3&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>[</a-p><a-pr>lib</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>name </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;&lt;module-name&gt;&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>crate-type </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;cdylib&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>The process for creating a plugin is:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>1. Create a struct that implements Module</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>1. Create a struct that will store the plugin state</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>1. Implement the required traits for the module</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>1. Enable the traits which have been enabled in the module `load` method</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>use obs_wrapper::{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>    </a-p><a-c>// Everything required for modules</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>    prelude::</a-p><a-o>*</a-o><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>    </a-p><a-c>// Everything required for creating a source</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>    source::</a-p><a-o>*</a-o><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>    </a-p><a-c>// Macro for registering modules</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>    obs_register_module,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>    </a-p><a-c>// Macro for creating strings</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>    obs_string,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>// The module that will handle creating the source.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>struct </a-p><a-t>TestModule</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>    </a-p><a-pr>context</a-pr><a-p>: </a-p><a-t>ModuleContext</a-t></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>// The source that will be shown inside OBS.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>struct </a-p><a-t>TestSource</a-t><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>// The state of the source that is managed by OBS and used in each trait method.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>struct </a-p><a-t>SourceData</a-t><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>// Implement the Sourceable trait for TestSource, this is required for each source.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>// It allows you to specify the source ID and type.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>impl </a-p><a-t>Sourceable</a-t><a-p> </a-p><a-k>for</a-k><a-p> </a-p><a-t>TestSource</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>get_id</a-f><a-p>() -&gt; </a-p><a-t>ObsString</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>        </a-p><a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;test_source&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>get_type</a-f><a-p>() -&gt; </a-p><a-t>SourceType</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>        </a-p><a-t>SourceType</a-t><a-p>::</a-p><a-cr>FILTER</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>// Allow OBS to show a name for the source</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>impl </a-p><a-t>GetNameSource</a-t><a-p>&lt;</a-p><a-t>SourceData</a-t><a-p>&gt; </a-p><a-k>for</a-k><a-p> </a-p><a-t>TestSource</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>get_name</a-f><a-p>() -&gt; </a-p><a-t>ObsString</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>        </a-p><a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;Test Source&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>// Implement the Module trait for TestModule. This will handle the creation of the source and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>// has some methods for telling OBS a bit about itself.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>impl </a-p><a-t>Module</a-t><a-p> </a-p><a-k>for</a-k><a-p> </a-p><a-t>TestModule</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>new</a-f><a-p>(</a-p><a-v>context</a-v><a-p>: </a-p><a-t>ModuleContext</a-t><a-p>) -&gt; </a-p><a-t>Self</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>        </a-p><a-t>Self</a-t><a-p> { context }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>get_ctx</a-f><a-p>(</a-p><a-o>&amp;</a-o><a-v>self</a-v><a-p>) -&gt; </a-p><a-o>&amp;</a-o><a-t>ModuleContext</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>        </a-p><a-o>&amp;</a-o><a-v>self</a-v><a-p>.</a-p><a-pr>context</a-pr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>    </a-p><a-c>// Load the module - create all sources, returning true if all went well.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>load</a-f><a-p>(</a-p><a-o>&amp;</a-o><a-k>mut</a-k><a-p> </a-p><a-v>self</a-v><a-p>, </a-p><a-v>load_context</a-v><a-p>: </a-p><a-o>&amp;</a-o><a-k>mut</a-k><a-p> </a-p><a-t>LoadContext</a-t><a-p>) -&gt; </a-p><a-t>bool</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>        </a-p><a-c>// Create the source</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>        </a-p><a-k>let</a-k><a-p> source = load_context</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>            .</a-p><a-f>create_source_builder</a-f><a-p>::&lt;</a-p><a-t>TestSource</a-t><a-p>, </a-p><a-t>SourceData</a-t><a-p>&gt;()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>            </a-p><a-c>// Since GetNameSource is implemented, this method needs to be called to</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>            </a-p><a-c>// enable it.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>            .</a-p><a-f>enable_get_name</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>            .</a-p><a-f>build</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>        </a-p><a-c>// Tell OBS about the source so that it will show it.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>        load_context.</a-p><a-f>register_source</a-f><a-p>(source);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>        </a-p><a-c>// Nothing could have gone wrong, so return true.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>        </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>description</a-f><a-p>() -&gt; </a-p><a-t>ObsString</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>        </a-p><a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;A great test module.&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>name</a-f><a-p>() -&gt; </a-p><a-t>ObsString</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>        </a-p><a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;Test Module&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>    </a-p><a-k>fn</a-k><a-p> </a-p><a-f>author</a-f><a-p>() -&gt; </a-p><a-t>ObsString</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>        </a-p><a-m>obs_string!</a-m><a-p>(</a-p><a-s>&quot;Bennett&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>### </a-p><a-tt>Installation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>1. Run `cargo build --release`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>2. Copy `/target/release/&lt;module-name&gt;.so` to your OBS plugins folder (`/usr/lib/obs-plugins/`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>3. The plugin should be available for use from inside OBS</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>## </a-p><a-tt>License</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text">Like [obs-studio](https://github.com/obsproject/obs-studio), `obs-wrapper` is licensed under GNU General Public License v2.0.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text">See [LICENSE](./LICENSE) for details.</span></span></pre></div></div>
</main>
</body>
</html>
