@bharper/atv-js 0.2.6 → 0.3.4

package/pyatv/docs/api/pyatv.settings.html

@@ -0,0 +1,484 @@
+---
+layout: template
+title: API - pyatv.settings
+permalink: /api/settings/
+link_group: api
+---
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+This module has additional documentation
+<a title="test" href=/development/storage>here</a>.
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="pyatv" href="..">pyatv</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="pyatv.settings.AirPlaySettings" href="#pyatv.settings.AirPlaySettings">AirPlaySettings</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.AirPlaySettings.credentials" href="#pyatv.settings.AirPlaySettings.credentials">credentials</a></code></li>
+<li><code><a title="pyatv.settings.AirPlaySettings.identifier" href="#pyatv.settings.AirPlaySettings.identifier">identifier</a></code></li>
+<li><code><a title="pyatv.settings.AirPlaySettings.mrp_tunnel" href="#pyatv.settings.AirPlaySettings.mrp_tunnel">mrp_tunnel</a></code></li>
+<li><code><a title="pyatv.settings.AirPlaySettings.password" href="#pyatv.settings.AirPlaySettings.password">password</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.AirPlayVersion" href="#pyatv.settings.AirPlayVersion">AirPlayVersion</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.AirPlayVersion.Auto" href="#pyatv.settings.AirPlayVersion.Auto">Auto</a></code></li>
+<li><code><a title="pyatv.settings.AirPlayVersion.V1" href="#pyatv.settings.AirPlayVersion.V1">V1</a></code></li>
+<li><code><a title="pyatv.settings.AirPlayVersion.V2" href="#pyatv.settings.AirPlayVersion.V2">V2</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.CompanionSettings" href="#pyatv.settings.CompanionSettings">CompanionSettings</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.CompanionSettings.credentials" href="#pyatv.settings.CompanionSettings.credentials">credentials</a></code></li>
+<li><code><a title="pyatv.settings.CompanionSettings.identifier" href="#pyatv.settings.CompanionSettings.identifier">identifier</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.DmapSettings" href="#pyatv.settings.DmapSettings">DmapSettings</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.DmapSettings.credentials" href="#pyatv.settings.DmapSettings.credentials">credentials</a></code></li>
+<li><code><a title="pyatv.settings.DmapSettings.identifier" href="#pyatv.settings.DmapSettings.identifier">identifier</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.InfoSettings" href="#pyatv.settings.InfoSettings">InfoSettings</a></code></h4>
+<ul class="two-column">
+<li><code><a title="pyatv.settings.InfoSettings.device_id" href="#pyatv.settings.InfoSettings.device_id">device_id</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.fill_missing_rp_id" href="#pyatv.settings.InfoSettings.fill_missing_rp_id">fill_missing_rp_id</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.mac" href="#pyatv.settings.InfoSettings.mac">mac</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.mac_validator" href="#pyatv.settings.InfoSettings.mac_validator">mac_validator</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.model" href="#pyatv.settings.InfoSettings.model">model</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.name" href="#pyatv.settings.InfoSettings.name">name</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.os_build" href="#pyatv.settings.InfoSettings.os_build">os_build</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.os_name" href="#pyatv.settings.InfoSettings.os_name">os_name</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.os_version" href="#pyatv.settings.InfoSettings.os_version">os_version</a></code></li>
+<li><code><a title="pyatv.settings.InfoSettings.rp_id" href="#pyatv.settings.InfoSettings.rp_id">rp_id</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.MrpSettings" href="#pyatv.settings.MrpSettings">MrpSettings</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.MrpSettings.credentials" href="#pyatv.settings.MrpSettings.credentials">credentials</a></code></li>
+<li><code><a title="pyatv.settings.MrpSettings.identifier" href="#pyatv.settings.MrpSettings.identifier">identifier</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.MrpTunnel" href="#pyatv.settings.MrpTunnel">MrpTunnel</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.MrpTunnel.Auto" href="#pyatv.settings.MrpTunnel.Auto">Auto</a></code></li>
+<li><code><a title="pyatv.settings.MrpTunnel.Disable" href="#pyatv.settings.MrpTunnel.Disable">Disable</a></code></li>
+<li><code><a title="pyatv.settings.MrpTunnel.Force" href="#pyatv.settings.MrpTunnel.Force">Force</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.ProtocolSettings" href="#pyatv.settings.ProtocolSettings">ProtocolSettings</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.ProtocolSettings.airplay" href="#pyatv.settings.ProtocolSettings.airplay">airplay</a></code></li>
+<li><code><a title="pyatv.settings.ProtocolSettings.companion" href="#pyatv.settings.ProtocolSettings.companion">companion</a></code></li>
+<li><code><a title="pyatv.settings.ProtocolSettings.dmap" href="#pyatv.settings.ProtocolSettings.dmap">dmap</a></code></li>
+<li><code><a title="pyatv.settings.ProtocolSettings.mrp" href="#pyatv.settings.ProtocolSettings.mrp">mrp</a></code></li>
+<li><code><a title="pyatv.settings.ProtocolSettings.raop" href="#pyatv.settings.ProtocolSettings.raop">raop</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.RaopSettings" href="#pyatv.settings.RaopSettings">RaopSettings</a></code></h4>
+<ul class="two-column">
+<li><code><a title="pyatv.settings.RaopSettings.control_port" href="#pyatv.settings.RaopSettings.control_port">control_port</a></code></li>
+<li><code><a title="pyatv.settings.RaopSettings.credentials" href="#pyatv.settings.RaopSettings.credentials">credentials</a></code></li>
+<li><code><a title="pyatv.settings.RaopSettings.identifier" href="#pyatv.settings.RaopSettings.identifier">identifier</a></code></li>
+<li><code><a title="pyatv.settings.RaopSettings.password" href="#pyatv.settings.RaopSettings.password">password</a></code></li>
+<li><code><a title="pyatv.settings.RaopSettings.protocol_version" href="#pyatv.settings.RaopSettings.protocol_version">protocol_version</a></code></li>
+<li><code><a title="pyatv.settings.RaopSettings.timing_port" href="#pyatv.settings.RaopSettings.timing_port">timing_port</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="pyatv.settings.Settings" href="#pyatv.settings.Settings">Settings</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.settings.Settings.info" href="#pyatv.settings.Settings.info">info</a></code></li>
+<li><code><a title="pyatv.settings.Settings.protocols" href="#pyatv.settings.Settings.protocols">protocols</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+<article id="content">
+<header>
+<h1 class="title">Module <code>pyatv.settings</code></h1>
+</header>
+<section id="section-intro">
+<p>Settings for configuring pyatv.</p>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L1-L179" class="git-link">Browse git</a></div>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="pyatv.settings.AirPlaySettings"><code class="flex name class">
+<span>class <span class="ident">AirPlaySettings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Settings related to AirPlay.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L107-L114" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.AirPlaySettings.credentials"><code class="name">var <span class="ident">credentials</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.AirPlaySettings.identifier"><code class="name">var <span class="ident">identifier</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.AirPlaySettings.mrp_tunnel"><code class="name">var <span class="ident">mrp_tunnel</span> -> <a title="pyatv.settings.MrpTunnel" href="#pyatv.settings.MrpTunnel">MrpTunnel</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.AirPlaySettings.password"><code class="name">var <span class="ident">password</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.AirPlayVersion"><code class="flex name class">
+<span>class <span class="ident">AirPlayVersion</span></span>
+<span>(</span><span>*args, **kwds)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>AirPlay version to use.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L49-L59" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>builtins.str</li>
+<li>enum.Enum</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.AirPlayVersion.Auto"><code class="name">var <span class="ident">Auto</span> = auto</code></dt>
+<dd>
+<section class="desc"><p>Automatically determine what version to use.</p></section>
+</dd>
+<dt id="pyatv.settings.AirPlayVersion.V1"><code class="name">var <span class="ident">V1</span> = 1</code></dt>
+<dd>
+<section class="desc"><p>Use version 1 of AirPlay.</p></section>
+</dd>
+<dt id="pyatv.settings.AirPlayVersion.V2"><code class="name">var <span class="ident">V2</span> = 2</code></dt>
+<dd>
+<section class="desc"><p>Use version 2 of AirPlay.</p></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.CompanionSettings"><code class="flex name class">
+<span>class <span class="ident">CompanionSettings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Settings related to Companion.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L117-L121" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.CompanionSettings.credentials"><code class="name">var <span class="ident">credentials</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.CompanionSettings.identifier"><code class="name">var <span class="ident">identifier</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.DmapSettings"><code class="flex name class">
+<span>class <span class="ident">DmapSettings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Settings related to DMAP.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L124-L128" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.DmapSettings.credentials"><code class="name">var <span class="ident">credentials</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.DmapSettings.identifier"><code class="name">var <span class="ident">identifier</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.InfoSettings"><code class="flex name class">
+<span>class <span class="ident">InfoSettings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Information related settings.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L78-L104" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.InfoSettings.device_id"><code class="name">var <span class="ident">device_id</span> -> str</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.mac"><code class="name">var <span class="ident">mac</span> -> str</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.model"><code class="name">var <span class="ident">model</span> -> str</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.name"><code class="name">var <span class="ident">name</span> -> str</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.os_build"><code class="name">var <span class="ident">os_build</span> -> str</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.os_name"><code class="name">var <span class="ident">os_name</span> -> str</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.os_version"><code class="name">var <span class="ident">os_version</span> -> str</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.rp_id"><code class="name">var <span class="ident">rp_id</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+<h3>Static methods</h3>
+<dl>
+<dt id="pyatv.settings.InfoSettings.fill_missing_rp_id">
+<code class="name flex">
+<span>def <span class="ident">fill_missing_rp_id</span></span>(<span>v)</span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Generate a new random rp_id if it is missing.</p></section>
+</dd>
+<dt id="pyatv.settings.InfoSettings.mac_validator">
+<code class="name flex">
+<span>def <span class="ident">mac_validator</span></span>(<span>mac: str) -> str</span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Validate MAC address to be correct.</p></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.MrpSettings"><code class="flex name class">
+<span>class <span class="ident">MrpSettings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Settings related to MRP.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L131-L135" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.MrpSettings.credentials"><code class="name">var <span class="ident">credentials</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.MrpSettings.identifier"><code class="name">var <span class="ident">identifier</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.MrpTunnel"><code class="flex name class">
+<span>class <span class="ident">MrpTunnel</span></span>
+<span>(</span><span>*args, **kwds)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>How MRP tunneling over AirPlay is handled.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L62-L72" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>builtins.str</li>
+<li>enum.Enum</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.MrpTunnel.Auto"><code class="name">var <span class="ident">Auto</span> = auto</code></dt>
+<dd>
+<section class="desc"><p>Automatically set up MRP tunnel if supported by remote device.</p></section>
+</dd>
+<dt id="pyatv.settings.MrpTunnel.Disable"><code class="name">var <span class="ident">Disable</span> = disable</code></dt>
+<dd>
+<section class="desc"><p>Fully disable set up of MRP tunnel.</p></section>
+</dd>
+<dt id="pyatv.settings.MrpTunnel.Force"><code class="name">var <span class="ident">Force</span> = force</code></dt>
+<dd>
+<section class="desc"><p>Force set up of MRP tunnel even if remote device does not supports it.</p></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.ProtocolSettings"><code class="flex name class">
+<span>class <span class="ident">ProtocolSettings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Container for protocol specific settings.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L165-L172" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.ProtocolSettings.airplay"><code class="name">var <span class="ident">airplay</span> -> <a title="pyatv.settings.AirPlaySettings" href="#pyatv.settings.AirPlaySettings">AirPlaySettings</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.ProtocolSettings.companion"><code class="name">var <span class="ident">companion</span> -> <a title="pyatv.settings.CompanionSettings" href="#pyatv.settings.CompanionSettings">CompanionSettings</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.ProtocolSettings.dmap"><code class="name">var <span class="ident">dmap</span> -> <a title="pyatv.settings.DmapSettings" href="#pyatv.settings.DmapSettings">DmapSettings</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.ProtocolSettings.mrp"><code class="name">var <span class="ident">mrp</span> -> <a title="pyatv.settings.MrpSettings" href="#pyatv.settings.MrpSettings">MrpSettings</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.ProtocolSettings.raop"><code class="name">var <span class="ident">raop</span> -> <a title="pyatv.settings.RaopSettings" href="#pyatv.settings.RaopSettings">RaopSettings</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.RaopSettings"><code class="flex name class">
+<span>class <span class="ident">RaopSettings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Settings related to RAOP.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L138-L162" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.RaopSettings.control_port"><code class="name">var <span class="ident">control_port</span> -> int</code></dt>
+<dd>
+<section class="desc"><p>Server side (UDP) port used by control server.</p>
+<p>Set to 0 to use random free port.</p></section>
+</dd>
+<dt id="pyatv.settings.RaopSettings.credentials"><code class="name">var <span class="ident">credentials</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.RaopSettings.identifier"><code class="name">var <span class="ident">identifier</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.RaopSettings.password"><code class="name">var <span class="ident">password</span> -> str | None</code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.RaopSettings.protocol_version"><code class="name">var <span class="ident">protocol_version</span> -> <a title="pyatv.settings.AirPlayVersion" href="#pyatv.settings.AirPlayVersion">AirPlayVersion</a></code></dt>
+<dd>
+<section class="desc"><p>Protocol version used.</p>
+<p>In reality this corresponds to the AirPlay version used. Set to 0 for automatic
+mode (recommended), or 1 or 2 for AirPlay 1 or 2 respectively.</p></section>
+</dd>
+<dt id="pyatv.settings.RaopSettings.timing_port"><code class="name">var <span class="ident">timing_port</span> -> int</code></dt>
+<dd>
+<section class="desc"><p>Server side (UDP) port used by timing server.</p>
+<p>Set to 0 to use random free port.</p></section>
+</dd>
+</dl>
+</dd>
+<dt id="pyatv.settings.Settings"><code class="flex name class">
+<span>class <span class="ident">Settings</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Settings container class.</p>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises ValidationError if the input data cannot be parsed to form a valid model.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/settings.py#L175-L179" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.v1.main.BaseModel</li>
+<li>pydantic.v1.utils.Representation</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="pyatv.settings.Settings.info"><code class="name">var <span class="ident">info</span> -> <a title="pyatv.settings.InfoSettings" href="#pyatv.settings.InfoSettings">InfoSettings</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+<dt id="pyatv.settings.Settings.protocols"><code class="name">var <span class="ident">protocols</span> -> <a title="pyatv.settings.ProtocolSettings" href="#pyatv.settings.ProtocolSettings">ProtocolSettings</a></code></dt>
+<dd>
+<section class="desc"></section>
+</dd>
+</dl>
+</dd>
+</dl>
+</section>
+</article>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite>.</p>
+</footer>

package/pyatv/docs/api/pyatv.storage.file_storage.html

@@ -0,0 +1,102 @@
+---
+layout: template
+title: API - pyatv.storage.file_storage
+permalink: /api/storage/file_storage/
+link_group: api
+---
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+This module has additional documentation
+<a title="test" href=/development/storage>here</a>.
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="pyatv.storage" href="..">pyatv.storage</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="pyatv.storage.file_storage.FileStorage" href="#pyatv.storage.file_storage.FileStorage">FileStorage</a></code></h4>
+<ul class="">
+<li><code><a title="pyatv.storage.file_storage.FileStorage.default_storage" href="#pyatv.storage.file_storage.FileStorage.default_storage">default_storage</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+<article id="content">
+<header>
+<h1 class="title">Module <code>pyatv.storage.file_storage</code></h1>
+</header>
+<section id="section-intro">
+<p>File based storage module.</p>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/storage/file_storage.py#L1-L70" class="git-link">Browse git</a></div>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="pyatv.storage.file_storage.FileStorage"><code class="flex name class">
+<span>class <span class="ident">FileStorage</span></span>
+<span>(</span><span>filename: str, loop: asyncio.events.AbstractEventLoop)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Storage module storing settings in a file.</p>
+<p>Initialize a new FileStorage instance.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/storage/file_storage.py#L16-L70" class="git-link">Browse git</a></div>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="pyatv.storage.AbstractStorage" href="#pyatv.storage.AbstractStorage">AbstractStorage</a></li>
+<li><a title="pyatv.interface.Storage" href="../../interface#pyatv.interface.Storage">Storage</a></li>
+<li>abc.ABC</li>
+</ul>
+<h3>Static methods</h3>
+<dl>
+<dt id="pyatv.storage.file_storage.FileStorage.default_storage">
+<code class="name flex">
+<span>def <span class="ident">default_storage</span></span>(<span>loop: asyncio.events.AbstractEventLoop) -> <a title="pyatv.storage.file_storage.FileStorage" href="#pyatv.storage.file_storage.FileStorage">FileStorage</a></span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Return file storage with default path.</p>
+<p>This corresponds to the default file storage path that pyatv uses internally,
+e.g. in atvremote. Use this if you want to hook into that storage in your own
+applications.</p>
+<p>The path used for this file is $HOME/.pyatv.conf (C:\Users\<user>.pyatv.conf
+on Windows).</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/storage/file_storage.py#L25-L36" class="git-link">Browse git</a></div>
+</dd>
+</dl>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="pyatv.storage.AbstractStorage" href="#pyatv.storage.AbstractStorage">AbstractStorage</a></b></code>:
+<ul class="hlist">
+<li><code><a title="pyatv.storage.AbstractStorage.get_settings" href="#pyatv.storage.AbstractStorage.get_settings">get_settings</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.has_changed" href="#pyatv.storage.AbstractStorage.has_changed">has_changed</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.load" href="../../interface#pyatv.interface.Storage.load">load</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.remove_settings" href="../../interface#pyatv.interface.Storage.remove_settings">remove_settings</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.save" href="../../interface#pyatv.interface.Storage.save">save</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.settings" href="../../interface#pyatv.interface.Storage.settings">settings</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.storage_model" href="#pyatv.storage.AbstractStorage.storage_model">storage_model</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.update_hash" href="#pyatv.storage.AbstractStorage.update_hash">update_hash</a></code></li>
+<li><code><a title="pyatv.storage.AbstractStorage.update_settings" href="../../interface#pyatv.interface.Storage.update_settings">update_settings</a></code></li>
+</ul>
+</li>
+</ul>
+</dd>
+</dl>
+</section>
+</article>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite>.</p>
+</footer>