Fabio/flutter_cast_framework_modern
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix README and re-generate docs

Browse source
This commit is contained in:
gianlucaparadise 2023-01-02 16:43:09 +01:00
parent a2ea319dd4
commit 7e06eab13f
3 changed files with 21 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -30,12 +30,9 @@ Currently only the following APIs are integrated (both Android and iOS):
#### Add Dependency #### Add Dependency
Clone this repo and add the following piece of code to your app's pubspec Run the following to add `flutter_cast_framework` to the dependencies:
```shell
```yaml flutter pub add flutter_cast_framework
dependencies:
flutter_cast_framework:
path: ../flutter_cast_framework/ # the path depends on where you cloned this repo
``` ```
### Android Setup ### Android Setup
@ -155,8 +152,9 @@ Next features to be developed:
* CC in Expanded Controls (iOS) * CC in Expanded Controls (iOS)
* Expanded Controls cosmetics (ad in progress bar, full screen, progress bar handle) * Expanded Controls cosmetics (ad in progress bar, full screen, progress bar handle)
* Title in MiniController and ExpandedControls (blocked because of a [pigeon issue](https://github.com/flutter/flutter/issues/93464)) * Title in MiniController and ExpandedControls (blocked because of a [pigeon issue](https://github.com/flutter/flutter/issues/93464), but solved with a workaround)
* Handle queue * Handle queue
* Handle progress seek * Handle progress seek
* Understand if it is better to refactor using streams instead of listeners * Understand if it is better to refactor using streams instead of listeners
* Add tests * Add tests
* Various glitches and cosmetic fixes

4
doc/api/__404error.html
View file

@ -30,7 +30,7 @@
<header id="title"> <header id="title">
<button id="sidenav-left-toggle" type="button">&nbsp;</button> <button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs"> <ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="https://gianlucaparadise.github.io/flutter_cast_framework/api/">flutter_cast_framework package</a></li> <li><a href="https://github.com/gianlucaparadise/flutter_cast_framework">flutter_cast_framework package</a></li>
</ol> </ol>
<div class="self-name">flutter_cast_framework</div> <div class="self-name">flutter_cast_framework</div>
<form class="search navbar-right" role="search"> <form class="search navbar-right" role="search">
@ -64,7 +64,7 @@
</header> </header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav"> <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
<li><a href="https://gianlucaparadise.github.io/flutter_cast_framework/api/">flutter_cast_framework package</a></li> <li><a href="https://github.com/gianlucaparadise/flutter_cast_framework">flutter_cast_framework package</a></li>
</ol> </ol>

43
doc/api/index.html
View file

@ -30,7 +30,7 @@
<header id="title"> <header id="title">
<button id="sidenav-left-toggle" type="button">&nbsp;</button> <button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs"> <ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="https://gianlucaparadise.github.io/flutter_cast_framework/api/">flutter_cast_framework package</a></li> <li><a href="https://github.com/gianlucaparadise/flutter_cast_framework">flutter_cast_framework package</a></li>
</ol> </ol>
<div class="self-name">flutter_cast_framework</div> <div class="self-name">flutter_cast_framework</div>
<form class="search navbar-right" role="search"> <form class="search navbar-right" role="search">
@ -46,6 +46,7 @@
<section class="desc markdown"> <section class="desc markdown">
<h1 id="flutter-cast-framework">Flutter Cast Framework</h1> <h1 id="flutter-cast-framework">Flutter Cast Framework</h1>
<h2 id="overview">Overview</h2> <h2 id="overview">Overview</h2>
<p><img src="https://img.shields.io/pub/v/flutter_cast_framework?include_prereleases" alt="Pub Version (including pre-releases)"></p>
<p>Flutter Cast Framework is a POC of a flutter plugin that lets you use Chromecast API in a flutter app.</p> <p>Flutter Cast Framework is a POC of a flutter plugin that lets you use Chromecast API in a flutter app.</p>
<h2 id="useful-links">Useful links</h2> <h2 id="useful-links">Useful links</h2>
<ul> <ul>
@ -68,10 +69,8 @@
</ul> </ul>
<h2 id="setup">Setup</h2> <h2 id="setup">Setup</h2>
<h4 id="add-dependency">Add Dependency</h4> <h4 id="add-dependency">Add Dependency</h4>
<p>Clone this repo and add the following piece of code to your app's pubspec</p> <p>Run the following to add <code>flutter_cast_framework</code> to the dependencies:</p>
<pre class="language-yaml"><code class="language-yaml">dependencies: <pre class="language-shell"><code class="language-shell">flutter pub add flutter_cast_framework
flutter_cast_framework:
path: ../flutter_cast_framework/ # the path depends on where you cloned this repo
</code></pre> </code></pre>
<h3 id="android-setup">Android Setup</h3> <h3 id="android-setup">Android Setup</h3>
<h4 id="1-create-castoptionsprovider">1. Create <code>CastOptionsProvider</code></h4> <h4 id="1-create-castoptionsprovider">1. Create <code>CastOptionsProvider</code></h4>
@ -162,30 +161,14 @@ Select <em>Runner</em> from left pane &gt; <em>General</em> tab &gt; <em>Deploym
<h2 id="roadmap">Roadmap</h2> <h2 id="roadmap">Roadmap</h2>
<p>Next features to be developed:</p> <p>Next features to be developed:</p>
<ul> <ul>
<li> <li>CC in Expanded Controls (iOS)</li>
<p>Test strings workaround on ios</p> <li>Expanded Controls cosmetics (ad in progress bar, full screen, progress bar handle)</li>
</li> <li>Title in MiniController and ExpandedControls (blocked because of a <a href="https://github.com/flutter/flutter/issues/93464">pigeon issue</a>, but solved with a workaround)</li>
<li> <li>Handle queue</li>
<p>CC in Expanded Controls (iOS)</p> <li>Handle progress seek</li>
</li> <li>Understand if it is better to refactor using streams instead of listeners</li>
<li> <li>Add tests</li>
<p>Expanded Controls cosmetics (ad in progress bar, full screen, progress bar handle)</p> <li>Various glitches and cosmetic fixes</li>
</li>
<li>
<p>Title in MiniController and ExpandedControls (blocked because of a <a href="https://github.com/flutter/flutter/issues/93464">pigeon issue</a>)</p>
</li>
<li>
<p>Handle queue</p>
</li>
<li>
<p>Handle progress seek</p>
</li>
<li>
<p>Understand if it is better to refactor using streams instead of listeners</p>
</li>
<li>
<p>Add tests</p>
</li>
</ul> </ul>
</section> </section>
@ -220,7 +203,7 @@ Select <em>Runner</em> from left pane &gt; <em>General</em> tab &gt; <em>Deploym
</header> </header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav"> <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
<li><a href="https://gianlucaparadise.github.io/flutter_cast_framework/api/">flutter_cast_framework package</a></li> <li><a href="https://github.com/gianlucaparadise/flutter_cast_framework">flutter_cast_framework package</a></li>
</ol> </ol>