@bharper/atv-js 0.2.6 → 0.3.4

package/pyatv/docs/api/pyatv.helpers.html

@@ -0,0 +1,102 @@
+---
+layout: template
+title: API - pyatv.helpers
+permalink: /api/helpers/
+link_group: api
+---
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<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-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="pyatv.helpers.auto_connect" href="#pyatv.helpers.auto_connect">auto_connect</a></code></li>
+<li><code><a title="pyatv.helpers.get_unique_id" href="#pyatv.helpers.get_unique_id">get_unique_id</a></code></li>
+<li><code><a title="pyatv.helpers.is_device_supported" href="#pyatv.helpers.is_device_supported">is_device_supported</a></code></li>
+<li><code><a title="pyatv.helpers.is_streamable" href="#pyatv.helpers.is_streamable">is_streamable</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+<article id="content">
+<header>
+<h1 class="title">Module <code>pyatv.helpers</code></h1>
+</header>
+<section id="section-intro">
+<p>Various helper methods.</p>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/helpers.py#L1-L122" class="git-link">Browse git</a></div>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="pyatv.helpers.auto_connect">
+<code class="name flex">
+<span>async def <span class="ident">auto_connect</span></span>(<span>handler: Callable[[<a title="pyatv.interface.AppleTV" href="../interface#pyatv.interface.AppleTV">AppleTV</a>], None], timeout: int = 5, not_found: Callable[[], None] | None = None, loop: asyncio.events.AbstractEventLoop | None = None) -> None</span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Connect to first discovered device.</p>
+<p>This is a convenience method that auto discovers devices, picks the first
+device found, connects to it and passes it to a user provided handler. An
+optional error handler can be provided that is called when no device was found.
+Very inflexible in many cases, but can be handys sometimes when trying things.</p>
+<p>Note: both handler and not_found must be coroutines</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/helpers.py#L19-L51" class="git-link">Browse git</a></div>
+</dd>
+<dt id="pyatv.helpers.get_unique_id">
+<code class="name flex">
+<span>def <span class="ident">get_unique_id</span></span>(<span>service_type: str, service_name: str, properties: Mapping[str, str]) -> str | None</span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Return unique identifier from a Zeroconf service.</p>
+<p><code>service_type</code> is the Zeroconf service type (e.g. <em>_mediaremotetv._tcp.local</em>),
+<code>service_name</code> name of the service (e.g. <em>Office</em> or <em>Living Room</em>) and
+<code>properties</code> all key-value properties belonging to the service.</p>
+<p>The unique identifier is returned if available, otherwise <code>None</code> is returned.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/helpers.py#L54-L87" class="git-link">Browse git</a></div>
+</dd>
+<dt id="pyatv.helpers.is_device_supported">
+<code class="name flex">
+<span>def <span class="ident">is_device_supported</span></span>(<span>conf: <a title="pyatv.interface.BaseConfig" href="../interface#pyatv.interface.BaseConfig">BaseConfig</a>) -> bool</span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Return if pyatv supports this device.</p>
+<p>This method will return False if all of its services are either
+PairingRequirement.Unsupported or PairingRequirement.Disabled. In all other cases
+it will return True. Do note that even if this method returns True, pairing (or
+that existing credentials are provided) might still be needed.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/helpers.py#L105-L122" class="git-link">Browse git</a></div>
+</dd>
+<dt id="pyatv.helpers.is_streamable">
+<code class="name flex">
+<span>async def <span class="ident">is_streamable</span></span>(<span>filename: str) -> bool</span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Return if a file is streamable by pyatv.</p>
+<p>This method will return if the file format of the given file is supported
+and streamable by pyatv. It will never raise an exception, e.g. because the
+file is missing or lack of permissions.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/helpers.py#L90-L102" class="git-link">Browse git</a></div>
+</dd>
+</dl>
+</section>
+<section>
+</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.html

@@ -0,0 +1,120 @@
+---
+layout: template
+title: API - pyatv
+permalink: /api//
+link_group: api
+---
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3><a href="#header-submodules">Sub-modules</a></h3>
+<ul>
+<li><code><a title="pyatv.conf" href="conf/">pyatv.conf</a></code></li>
+<li><code><a title="pyatv.const" href="const/">pyatv.const</a></code></li>
+<li><code><a title="pyatv.convert" href="convert/">pyatv.convert</a></code></li>
+<li><code><a title="pyatv.exceptions" href="exceptions/">pyatv.exceptions</a></code></li>
+<li><code><a title="pyatv.helpers" href="helpers/">pyatv.helpers</a></code></li>
+<li><code><a title="pyatv.interface" href="interface/">pyatv.interface</a></code></li>
+<li><code><a title="pyatv.settings" href="settings/">pyatv.settings</a></code></li>
+<li><code><a title="pyatv.storage" href="storage/">pyatv.storage</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="pyatv.connect" href="#pyatv.connect">connect</a></code></li>
+<li><code><a title="pyatv.pair" href="#pyatv.pair">pair</a></code></li>
+<li><code><a title="pyatv.scan" href="#pyatv.scan">scan</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+<article id="content">
+<header>
+<h1 class="title">Module <code>pyatv</code></h1>
+</header>
+<section id="section-intro">
+<p>Main routines for interacting with an Apple TV.</p>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/__init__.py#L1-L196" class="git-link">Browse git</a></div>
+</section>
+<section>
+<h2 class="section-title" id="header-submodules">Sub-modules</h2>
+<dl>
+<dt><code class="name"><a title="pyatv.conf" href="conf/">pyatv.conf</a></code></dt>
+<dd>
+<section class="desc"><p>Configuration used when connecting to a device …</p></section>
+</dd>
+<dt><code class="name"><a title="pyatv.const" href="const/">pyatv.const</a></code></dt>
+<dd>
+<section class="desc"><p>Constants used in the public API.</p></section>
+</dd>
+<dt><code class="name"><a title="pyatv.convert" href="convert/">pyatv.convert</a></code></dt>
+<dd>
+<section class="desc"><p>Various types of extraction and conversion functions.</p></section>
+</dd>
+<dt><code class="name"><a title="pyatv.exceptions" href="exceptions/">pyatv.exceptions</a></code></dt>
+<dd>
+<section class="desc"><p>Local exceptions used by library.</p></section>
+</dd>
+<dt><code class="name"><a title="pyatv.helpers" href="helpers/">pyatv.helpers</a></code></dt>
+<dd>
+<section class="desc"><p>Various helper methods.</p></section>
+</dd>
+<dt><code class="name"><a title="pyatv.interface" href="interface/">pyatv.interface</a></code></dt>
+<dd>
+<section class="desc"><p>Public interface exposed by library …</p></section>
+</dd>
+<dt><code class="name"><a title="pyatv.settings" href="settings/">pyatv.settings</a></code></dt>
+<dd>
+<section class="desc"><p>Settings for configuring pyatv.</p></section>
+</dd>
+<dt><code class="name"><a title="pyatv.storage" href="storage/">pyatv.storage</a></code></dt>
+<dd>
+<section class="desc"><p>Storage module.</p></section>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="pyatv.connect">
+<code class="name flex">
+<span>async def <span class="ident">connect</span></span>(<span>config: <a title="pyatv.interface.BaseConfig" href="../interface#pyatv.interface.BaseConfig">BaseConfig</a>, loop: asyncio.events.AbstractEventLoop, protocol: <a title="pyatv.const.Protocol" href="../const#pyatv.const.Protocol">Protocol</a> | None = None, session: aiohttp.client.ClientSession | None = None, storage: <a title="pyatv.interface.Storage" href="../interface#pyatv.interface.Storage">Storage</a> | None = None) -> <a title="pyatv.interface.AppleTV" href="../interface#pyatv.interface.AppleTV">AppleTV</a></span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Connect to a device based on a configuration.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/__init__.py#L101-L159" class="git-link">Browse git</a></div>
+</dd>
+<dt id="pyatv.pair">
+<code class="name flex">
+<span>async def <span class="ident">pair</span></span>(<span>config: <a title="pyatv.interface.BaseConfig" href="../interface#pyatv.interface.BaseConfig">BaseConfig</a>, protocol: <a title="pyatv.const.Protocol" href="../const#pyatv.const.Protocol">Protocol</a>, loop: asyncio.events.AbstractEventLoop, session: aiohttp.client.ClientSession = None, storage: <a title="pyatv.interface.Storage" href="../interface#pyatv.interface.Storage">Storage</a> | None = None, **kwargs) -> <a title="pyatv.interface.PairingHandler" href="../interface#pyatv.interface.PairingHandler">PairingHandler</a></span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Pair a protocol for an Apple TV.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/__init__.py#L162-L196" class="git-link">Browse git</a></div>
+</dd>
+<dt id="pyatv.scan">
+<code class="name flex">
+<span>async def <span class="ident">scan</span></span>(<span>loop: asyncio.events.AbstractEventLoop, timeout: int = 5, identifier: str | Set[str] | None = None, protocol: <a title="pyatv.const.Protocol" href="../const#pyatv.const.Protocol">Protocol</a> | Set[<a title="pyatv.const.Protocol" href="../const#pyatv.const.Protocol">Protocol</a>] | None = None, hosts: List[str] | None = None, aiozc: zeroconf.asyncio.AsyncZeroconf | None = None, storage: <a title="pyatv.interface.Storage" href="../interface#pyatv.interface.Storage">Storage</a> | None = None) -> List[<a title="pyatv.interface.BaseConfig" href="../interface#pyatv.interface.BaseConfig">BaseConfig</a>]</span>
+</code>
+</dt>
+<dd>
+<section class="desc"><p>Scan for Apple TVs on network and return their configurations.</p>
+<p>When passing in an aiozc instance, a ServiceBrowser must
+be running for all the types in the protocols that being scanned for.</p></section>
+<div class="git-link-div"><a href="https://github.com/postlund/pyatv/blob/master/pyatv/__init__.py#L33-L98" class="git-link">Browse git</a></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite>.</p>
+</footer>