<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>webrtc-sys/libwebrtc/README.md - fork/rust-sdks @ livekit/livekit-ffi@0.13.0</title>
<meta name="description" content="webrtc-sys/libwebrtc/README.md in fork/rust-sdks at livekit/livekit-ffi@0.13.0.">
<meta property="og:title" content="webrtc-sys/libwebrtc/README.md - fork/rust-sdks @ livekit/livekit-ffi@0.13.0">
<meta property="og:description" content="webrtc-sys/libwebrtc/README.md in fork/rust-sdks at livekit/livekit-ffi@0.13.0.">
<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="livekit/livekit-ffi@0.13.0" data-tip="aea9f4e47dbcb0d34d146bfe315f75e5bfd63cc2">
<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-sdks</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust-sdks</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Michael Sloan</span><span class="commit-message" data-commit="755b4359b24f2700efb5370eb9b270e5e89905c8">Add libwebrtc/README.md explaining how to build and use it (#499)</span><span class="snapshot-sha sha" data-commit="755b4359b24f2700efb5370eb9b270e5e89905c8">755b435</span><time datetime="2024-11-30T00:01:40-07:00" title="2024-11-30 00:01:40 -0700">2024-11-30</time></p>
<header class="topbar"><details class="switcher"><summary>livekit/livekit-ffi@0.13.0</summary><div class="menu"><strong>branches</strong><a href="/fork/rust-sdks/ref/main/">main</a><strong>tags</strong><a class="current" href="/fork/rust-sdks/ref/livekit/livekit-ffi%400.13.0/">livekit/livekit-ffi@0.13.0</a><a href="/fork/rust-sdks/ref/rust-sdks/livekit-ffi%400.12.15/">rust-sdks/livekit-ffi@0.12.15</a><a href="/fork/rust-sdks/ref/rust-sdks/livekit-ffi%400.12.16/">rust-sdks/livekit-ffi@0.12.16</a><a href="/fork/rust-sdks/ref/rust-sdks/livekit-ffi%400.12.17/">rust-sdks/livekit-ffi@0.12.17</a><a href="/fork/rust-sdks/ref/rust-sdks/livekit-ffi%400.12.18/">rust-sdks/livekit-ffi@0.12.18</a><a href="/fork/rust-sdks/ref/rust-sdks/livekit-ffi%400.12.19/">rust-sdks/livekit-ffi@0.12.19</a><a href="/fork/rust-sdks/ref/rust-sdks/livekit%400.7.7/">rust-sdks/livekit@0.7.7</a><a href="/fork/rust-sdks/ref/rust-sdks/livekit%400.7.8/">rust-sdks/livekit@0.7.8</a><a class="all" href="/fork/rust-sdks/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust-sdks/">rust-sdks</a> / <a href="/fork/rust-sdks/ref/livekit/livekit-ffi%400.13.0/tree/webrtc-sys/">webrtc-sys</a> / <a href="/fork/rust-sdks/ref/livekit/livekit-ffi%400.13.0/tree/webrtc-sys/libwebrtc/">libwebrtc</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.0 KiB</span><span>28 lines</span></span><span class="actions"><a class="raw" href="/fork/rust-sdks/raw/222db631746990fb531ceb1828c28670d45fc6aa/webrtc-sys/libwebrtc/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"><p>This directory can contain a checkout of WebRTC. The build scripts
here will install dependencies, checkout the version that LiveKit
currently uses, apply some patches to it, and build it. For example to
do a Linux debug build on x64:</p>
<pre class="language-bash"><a-o>$</a-o> <a-f>./build-linux.sh</a-f> <a-co>--arch</a-co> x64 <a-co>--profile</a-co> release</pre>
<p>After running this, <code>linux-x64-debug/lib/libwebrtc.a</code> should
exist. This can be rerun to rebuild it, but will complain about
patches not applying as they have already been applied.</p>
<p>If something goes wrong it may be helpful to consult the <a href="https://webrtc.googlesource.com/src/+/main/docs/native-code/development/">WebRTC native
development documentation</a>.</p>
<h1>Building LiveKit Rust SDK with custom WebRTC checkout</h1>
<p>Add the following environment variable to <code>/.config/config.toml</code>, to
specify use of a custom WebRTC build:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>env</a-pr><a-p>]</a-p>
<a-pr>LK_CUSTOM_WEBRTC</a-pr> <a-o>=</a-o> <a-p>{</a-p> <a-pr>value</a-pr> <a-o>=</a-o> <a-s>&quot;webrtc-sys/libwebrtc/linux-x64-release&quot;</a-s><a-p>,</a-p> <a-pr>relative</a-pr> <a-o>=</a-o> <a-co>true</a-co> <a-p>}</a-p></pre>
<p>Note that <code>linux-x64-debug</code> should be replaced with the artifact
directory appropriate for your configuration.</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">This directory can contain a checkout of WebRTC. The build scripts</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">here will install dependencies, checkout the version that LiveKit</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">currently uses, apply some patches to it, and build it. For example to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">do a Linux debug build on x64:</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-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>$ ./build-linux.sh --arch x64 --profile release</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>```</a-p></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>After running this, `linux-x64-debug/lib/libwebrtc.a` should</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>exist. This can be rerun to rebuild it, but will complain about</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>patches not applying as they have already been applied.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>If something goes wrong it may be helpful to consult the [WebRTC native</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>development documentation](https://webrtc.googlesource.com/src/+/main/docs/native-code/development/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p># </a-p><a-tt>Building LiveKit Rust SDK with custom WebRTC checkout</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>Add the following environment variable to `/.config/config.toml`, to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>specify use of a custom WebRTC build:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></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-tl>toml</a-tl></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>[</a-p><a-pr>env</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>LK_CUSTOM_WEBRTC </a-p><a-o>=</a-o><a-p> { </a-p><a-pr>value</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;webrtc-sys/libwebrtc/linux-x64-release&quot;</a-s><a-p>, </a-p><a-pr>relative</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co><a-p> }</a-p></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">Note that `linux-x64-debug` should be replaced with the artifact</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">directory appropriate for your configuration.</span></span></pre></div></div>
</main>
</body>
</html>
