add api doc

QuestsInc · Feb 3, 2021 · 799c7f7 · 799c7f7
1 parent f05c966
commit 799c7f7
Show file tree

Hide file tree

Showing 20 changed files with 3,542 additions and 0 deletions.
diff --git a/doc/api/__404error.html b/doc/api/__404error.html
@@ -0,0 +1,93 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+ <meta name="generator" content="made with love by dartdoc 0.39.0">
+ <meta name="description" content="volume_controller API docs, for the Dart programming language.">
+ <title>volume_controller - Dart API docs</title>
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com">
+ <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+ <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+ <link rel="stylesheet" href="static-assets/github.css">
+ <link rel="stylesheet" href="static-assets/styles.css">
+ <link rel="icon" href="static-assets/favicon.png">
+
+</head>
+
+<body data-base-href=""
+ data-using-base-href="false">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+ <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+ <ol class="breadcrumbs gt-separated dark hidden-xs">
+ <li><a href="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/Kurenai7968/volume_controller">volume_controller package</a></li>
+ </ol>
+ <div class="self-name">volume_controller</div>
+ <form class="search navbar-right" role="search">
+ <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+ </form>
+</header>
+
+<main>
+
+ <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+ <header id="header-search-sidebar" class="hidden-l">
+ <form class="search-sidebar" role="search">
+ <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+ </form>
+ </header>
+
+ <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+ <li><a href="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/Kurenai7968/volume_controller">volume_controller package</a></li>
+ </ol>
+
+ <h5><span class="package-name">volume_controller</span> <span class="package-kind">package</span></h5>
+ <ol>
+ <li class="section-title">Libraries</li>
+ <li><a href="volume_controller/volume_controller-library.html">volume_controller</a></li>
+ </ol>
+ </div>
+
+ <div id="dartdoc-main-content" class="main-content">
+ <h1>404: Something's gone wrong :-(</h1>
+
+ <section class="desc">
+ <p>You've tried to visit a page that doesn't exist. Luckily this site
+ has other <a href="index.html">pages</a>.</p>
+ <p>If you were looking for something specific, try searching:
+ <form class="search-body" role="search">
+ <input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+ </form>
+ </p>
+
+ </section>
+ </div> <!-- /.main-content -->
+
+ <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+ </div>
+
+</main>
+
+<footer>
+ <span class="no-break">
+ volume_controller
+ 1.0.0
+ </span>
+
+</footer>
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="static-assets/typeahead.bundle.min.js"></script>
+<script src="static-assets/highlight.pack.js"></script>
+<script src="static-assets/script.js"></script>
+
+
+</body>
+
+</html>
diff --git a/doc/api/categories.json b/doc/api/categories.json
@@ -0,0 +1 @@
+[]
diff --git a/doc/api/index.html b/doc/api/index.html
@@ -0,0 +1,197 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+ <meta name="generator" content="made with love by dartdoc 0.39.0">
+ <meta name="description" content="volume_controller API docs, for the Dart programming language.">
+ <title>volume_controller - Dart API docs</title>
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com">
+ <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+ <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+ <link rel="stylesheet" href="static-assets/github.css">
+ <link rel="stylesheet" href="static-assets/styles.css">
+ <link rel="icon" href="static-assets/favicon.png">
+
+</head>
+
+<body data-base-href=""
+ data-using-base-href="false">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+ <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+ <ol class="breadcrumbs gt-separated dark hidden-xs">
+ <li><a href="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/Kurenai7968/volume_controller">volume_controller package</a></li>
+ </ol>
+ <div class="self-name">volume_controller</div>
+ <form class="search navbar-right" role="search">
+ <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+ </form>
+</header>
+
+<main>
+
+ <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+ <header id="header-search-sidebar" class="hidden-l">
+ <form class="search-sidebar" role="search">
+ <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+ </form>
+ </header>
+
+ <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+ <li><a href="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/Kurenai7968/volume_controller">volume_controller package</a></li>
+ </ol>
+
+ <h5 class="hidden-xs"><span class="package-name">volume_controller</span> <span class="package-kind">package</span></h5>
+ <ol>
+ <li class="section-title">Libraries</li>
+ <li><a href="volume_controller/volume_controller-library.html">volume_controller</a></li>
+ </ol>
+ </div>
+
+ <div id="dartdoc-main-content" class="main-content">
+ <section class="desc markdown">
+ <h1 id="volume_controller">volume_controller</h1>
+<p>A Flutter plugin for iOS and Android get/set/listen system volume.</p>
+<h2 id="functions">Functions</h2>
+<ul>
+<li>getVolume: get current volume from system
+<blockquote>
+<p>VolumeController.getVolume()</p>
+</blockquote>
+</li>
+<li>maxVolume: set the volume to max
+<blockquote>
+<p>VolumeController.maxVolume()</p>
+</blockquote>
+</li>
+<li>muteVolume: mute the volume
+<blockquote>
+<p>VolumeController.muteVolume()</p>
+</blockquote>
+</li>
+<li>setVolume: input a double number to set system volume. The range is <code>0, 1</code>
+<blockquote>
+<p>await VolumeController.setVolume(double volume)</p>
+</blockquote>
+</li>
+<li>volumeListener: listen system volume
+<blockquote>
+<p>VolumeController.volumeListener.listen((volume) { // TODO });</p>
+</blockquote>
+</li>
+</ul>
+<h2 id="usage">Usage</h2>
+<pre class="language-dart"><code class="language-dart">
+class _MyAppState extends State&lt;MyApp&gt; {
+ double _volumeListenerValue = 0;
+ double _getVolume = 0;
+ double _setVolumeValue = 0;
+
+ @override
+ void initState() {
+ super.initState();
+ VolumeController.volumeListener.listen((volume) {
+ setState(() =&gt; _volumeListenerValue = volume);
+ });
+ VolumeController.getVolume().then((volume) =&gt; _setVolumeValue = volume);
+ }
+
+ @override
+ Widget build(BuildContext context) {
+ return MaterialApp(
+ home: Scaffold(
+ appBar: AppBar(
+ title: const Text('Volume Plugin example app'),
+ ),
+ body: Column(
+ children: [
+ Text('Current volume: $_volumeListenerValue'),
+ Row(
+ children: [
+ Text('Set Volume:'),
+ Flexible(
+ child: Slider(
+ min: 0,
+ max: 1,
+ onChanged: (double value) {
+ _setVolumeValue = value;
+ VolumeController.setVolume(_setVolumeValue);
+ setState(() {});
+ },
+ value: _setVolumeValue,
+ ),
+ ),
+ ],
+ ),
+ Row(
+ mainAxisAlignment: MainAxisAlignment.center,
+ children: [
+ Text('Volume is: $_getVolume'),
+ TextButton(
+ onPressed: () async {
+ _getVolume = await VolumeController.getVolume();
+ setState(() {});
+ },
+ child: Text('Get Volume'),
+ ),
+ ],
+ ),
+ TextButton(
+ onPressed: () =&gt; VolumeController.muteVolume(),
+ child: Text('Mute Volume'),
+ ),
+ TextButton(
+ onPressed: () =&gt; VolumeController.maxVolume(),
+ child: Text('Max Volume'),
+ ),
+ ],
+ ),
+ ),
+ );
+ }
+}
+</code></pre>
+ </section>
+
+ <section class="summary">
+ <h2>Libraries</h2>
+ <dl>
+ <dt id="volume_controller">
+ <span class="name"><a href="volume_controller/volume_controller-library.html">volume_controller</a></span> 
+ </dt>
+ <dd>
+
+ </dd>
+ </dl>
+ </section>
+
+ </div> <!-- /.main-content -->
+
+ <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+ </div>
+
+</main>
+
+<footer>
+ <span class="no-break">
+ volume_controller
+ 1.0.0
+ </span>
+
+</footer>
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+<script src="static-assets/typeahead.bundle.min.js"></script>
+<script src="static-assets/highlight.pack.js"></script>
+<script src="static-assets/script.js"></script>
+
+
+</body>
+
+</html>
diff --git a/doc/api/index.json b/doc/api/index.json
@@ -0,0 +1 @@
+[{"name":"volume_controller","qualifiedName":"volume_controller","href":"volume_controller/volume_controller-library.html","type":"library","overriddenDepth":0,"packageName":"volume_controller"},{"name":"VolumeController","qualifiedName":"volume_controller.VolumeController","href":"volume_controller/VolumeController-class.html","type":"class","overriddenDepth":0,"packageName":"volume_controller","enclosedBy":{"name":"volume_controller","type":"library"}},{"name":"VolumeController","qualifiedName":"volume_controller.VolumeController.VolumeController","href":"volume_controller/VolumeController/VolumeController.html","type":"constructor","overriddenDepth":0,"packageName":"volume_controller","enclosedBy":{"name":"VolumeController","type":"class"}},{"name":"getVolume","qualifiedName":"volume_controller.VolumeController.getVolume","href":"volume_controller/VolumeController/getVolume.html","type":"method","overriddenDepth":0,"packageName":"volume_controller","enclosedBy":{"name":"VolumeController","type":"class"}},{"name":"maxVolume","qualifiedName":"volume_controller.VolumeController.maxVolume","href":"volume_controller/VolumeController/maxVolume.html","type":"method","overriddenDepth":0,"packageName":"volume_controller","enclosedBy":{"name":"VolumeController","type":"class"}},{"name":"muteVolume","qualifiedName":"volume_controller.VolumeController.muteVolume","href":"volume_controller/VolumeController/muteVolume.html","type":"method","overriddenDepth":0,"packageName":"volume_controller","enclosedBy":{"name":"VolumeController","type":"class"}},{"name":"setVolume","qualifiedName":"volume_controller.VolumeController.setVolume","href":"volume_controller/VolumeController/setVolume.html","type":"method","overriddenDepth":0,"packageName":"volume_controller","enclosedBy":{"name":"VolumeController","type":"class"}},{"name":"volumeListener","qualifiedName":"volume_controller.VolumeController.volumeListener","href":"volume_controller/VolumeController/volumeListener.html","type":"property","overriddenDepth":0,"packageName":"volume_controller","enclosedBy":{"name":"VolumeController","type":"class"}}]
diff --git a/doc/api/static-assets/favicon.png b/doc/api/static-assets/favicon.png
diff --git a/doc/api/static-assets/github.css b/doc/api/static-assets/github.css
@@ -0,0 +1,99 @@
+/*
+
+github.com style (c) Vasily Polovnyov <[email protected]>
+
+*/
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ padding: 0.5em;
+ color: #333;
+ background: #f8f8f8;
+}
+
+.hljs-comment,
+.hljs-quote {
+ color: #998;
+ font-style: italic;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-subst {
+ color: #333;
+ font-weight: bold;
+}
+
+.hljs-number,
+.hljs-literal,
+.hljs-variable,
+.hljs-template-variable,
+.hljs-tag .hljs-attr {
+ color: #008080;
+}
+
+.hljs-string,
+.hljs-doctag {
+ color: #d14;
+}
+
+.hljs-title,
+.hljs-section,
+.hljs-selector-id {
+ color: #900;
+ font-weight: bold;
+}
+
+.hljs-subst {
+ font-weight: normal;
+}
+
+.hljs-type,
+.hljs-class .hljs-title {
+ color: #458;
+ font-weight: bold;
+}
+
+.hljs-tag,
+.hljs-name,
+.hljs-attribute {
+ color: #000080;
+ font-weight: normal;
+}
+
+.hljs-regexp,
+.hljs-link {
+ color: #009926;
+}
+
+.hljs-symbol,
+.hljs-bullet {
+ color: #990073;
+}
+
+.hljs-built_in,
+.hljs-builtin-name {
+ color: #0086b3;
+}
+
+.hljs-meta {
+ color: #999;
+ font-weight: bold;
+}
+
+.hljs-deletion {
+ background: #fdd;
+}
+
+.hljs-addition {
+ background: #dfd;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}