Skip to content

Commit

Permalink
upgrade doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@husen-hn
husen-hn committed Feb 2, 2025
1 parent a454196 commit ba65a7c
Show file tree
Hide file tree
Showing 90 changed files with 7,414 additions and 12,619 deletions.
37 changes: 11 additions & 26 deletions docs/__404error.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,23 @@
<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 6.1.5">
<meta name="description" content="nyx_converter API docs, for the Dart programming language.">
<title>nyx_converter - 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/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">

<link rel="stylesheet" href="static-assets/github.css?v1">
<link rel="stylesheet" href="static-assets/styles.css?v1">
<link rel="icon" href="static-assets/favicon.png?v1">


</head>


<body data-base-href="" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
<ol class="breadcrumbs gt-separated dark hidden-xs">
Expand All @@ -35,20 +30,21 @@
<form class="search navbar-right" role="search">
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
<div class="toggle" id="theme-button">
<div class="toggle" id="theme-button" title="Toggle brightness">
<label for="theme">
<input type="checkbox" id="theme" value="light-theme">
<span class="material-symbols-outlined">
brightness_4
<span id="dark-theme-button" class="material-symbols-outlined">
dark_mode
</span>
<span id="light-theme-button" class="material-symbols-outlined">
light_mode
</span>
</label>
</div>
</header>
<main>

<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>
Expand All @@ -57,52 +53,41 @@ <h1>404: Something's gone wrong :-(</h1>
<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-left" class="sidebar sidebar-offcanvas-left">
<header id="header-search-sidebar" class="hidden-l">
<!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<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 class="self-crumb">nyx_converter package</li>
<li class="self-crumb">nyx_converter package</li>
</ol>


<h5><span class="package-name">nyx_converter</span> <span class="package-kind">package</span></h5>
<ol>
<li class="section-title">Libraries</li>
<li><a href="nyx_converter/nyx_converter-library.html">nyx_converter</a></li>
</ol>

</div>

<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
</div>

</main>

<footer>
<span class="no-break">
nyx_converter
0.0.1
0.3.0
</span>


</footer>



<script src="static-assets/highlight.pack.js?v1"></script>
<script src="static-assets/docs.dart.js"></script>



</body>

</html>

126 changes: 38 additions & 88 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,23 @@
<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 6.1.5">
<meta name="description" content="nyx_converter API docs, for the Dart programming language.">
<title>nyx_converter - 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/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">

<link rel="stylesheet" href="static-assets/github.css?v1">
<link rel="stylesheet" href="static-assets/styles.css?v1">
<link rel="icon" href="static-assets/favicon.png?v1">


</head>


<body data-base-href="" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
<ol class="breadcrumbs gt-separated dark hidden-xs">
Expand All @@ -35,38 +30,41 @@
<form class="search navbar-right" role="search">
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
<div class="toggle" id="theme-button">
<div class="toggle" id="theme-button" title="Toggle brightness">
<label for="theme">
<input type="checkbox" id="theme" value="light-theme">
<span class="material-symbols-outlined">
brightness_4
<span id="dark-theme-button" class="material-symbols-outlined">
dark_mode
</span>
<span id="light-theme-button" class="material-symbols-outlined">
light_mode
</span>
</label>
</div>
</header>
<main>

<div id="dartdoc-main-content" class="main-content">

<section class="desc markdown">
<h1 id="nyx-converter-github-releasehttpsimgshieldsiogithubvreleasexaus-groupnyx_converterhttpsgithubcomxaus-groupnyx_converter-pub-packagehttpsimgshieldsiopubvnyx_convertersvghttpspubdevpackagesnyx_converter-licensehttpsimgshieldsiogithublicensexaus-groupnyx_converterhttpswwwgnuorglicenseslgpl-30enhtml-github-starshttpsimgshieldsiogithubstarsxaus-groupnyx_converterhttpsgithubcomxaus-groupnyx_converter-issueshttpsimgshieldsiogithubissuesxaus-groupnyx_converterhttpsgithubcomxaus-groupnyx_converterissues">Nyx Converter <a href="https://github.com/xaus-group/nyx_converter"><img src="https://img.shields.io/github/v/release/xaus-group/nyx_converter" alt="Github release"></a> <a href="https://pub.dev/packages/nyx_converter"><img src="https://img.shields.io/pub/v/nyx_converter.svg" alt="pub package"></a> <a href="https://www.gnu.org/licenses/lgpl-3.0.en.html"><img src="https://img.shields.io/github/license/xaus-group/nyx_converter" alt="License"></a> <a href="https://github.com/xaus-group/nyx_converter"><img src="https://img.shields.io/github/stars/xaus-group/nyx_converter" alt="Github Stars"></a> <a href="https://github.com/xaus-group/nyx_converter/issues"><img src="https://img.shields.io/github/issues/xaus-group/nyx_converter" alt="Issues"></a></h1><p align="center"><img src="https://raw.githubusercontent.com/xaus-group/nyx_converter/master/screenshots/logo.png" alt="nyx_converter logo" width="240"></p>
<p>The <code>nyx_converter</code> widget in Flutter empowers you to seamlessly convert media files between various formats, codecs, resolutions, bitrates, and audio properties. It utilizes the robust ffmpeg library under the hood, providing a convenient and efficient solution for your media processing needs within your Flutter applications.</p>
<h1 id="nyx-converter-github-releasehttpsimgshieldsiogithubvreleasexaus-groupnyx_converterhttpsgithubcomxaus-groupnyx_converter-pub-packagehttpsimgshieldsiopubvnyx_convertersvghttpspubdevpackagesnyx_converter-licensehttpsimgshieldsiogithublicensexaus-groupnyx_converterhttpswwwgnuorglicenseslgpl-30enhtml-github-starshttpsimgshieldsiogithubstarsxaus-groupnyx_converterhttpsgithubcomxaus-groupnyx_converter-issueshttpsimgshieldsiogithubissuesxaus-groupnyx_converterhttpsgithubcomxaus-groupnyx_converterissues">Nyx Converter <a href="https://github.com/xaus-group/nyx_converter"><img src="https://img.shields.io/github/v/release/xaus-group/nyx_converter" alt="Github release"></a> <a href="https://pub.dev/packages/nyx_converter"><img src="https://img.shields.io/pub/v/nyx_converter.svg" alt="pub package"></a> <a href="https://www.gnu.org/licenses/lgpl-3.0.en.html"><img src="https://img.shields.io/github/license/xaus-group/nyx_converter" alt="License"></a> <a href="https://github.com/xaus-group/nyx_converter"><img src="https://img.shields.io/github/stars/xaus-group/nyx_converter" alt="Github Stars"></a> <a href="https://github.com/xaus-group/nyx_converter/issues"><img src="https://img.shields.io/github/issues/xaus-group/nyx_converter" alt="Issues"></a></h1>
<p align="center"><img src="https://raw.githubusercontent.com/xaus-group/nyx_converter/master/screenshots/logo.png" alt="nyx_converter logo" width="240"></p>
<p>The <code>nyx_converter</code> package in Flutter empowers you to seamlessly convert media files between various formats, codecs, resolutions, bitrates, and audio properties. It utilizes the robust <a href="https://ffmpeg.org/">ffmpeg</a> under the hood, providing a convenient and efficient solution for your media processing needs within your Flutter applications.</p>
<h2 id="key-features">Key Features</h2>
<ul>
<li><strong>Extensive Container Support:</strong> Convert a wide range of video and audio file containers.</li>
<li><strong>Flexible Codec Control:</strong> Specify desired video codecs (e.g., H.264, VP8) and audio codecs (e.g., AAC, MP3) to tailor the output file's characteristics.</li>
<li><strong>Granular Resolution Management:</strong> Define the exact width and height in pixels for the converted video, granting precise control over the output dimensions.</li>
<li><strong>Bitrate Optimization:</strong> Set the bitrate (in kbps) to strike a balance between quality and file size, catering to different bandwidth requirements or storage constraints.</li>
<li><strong>Audio Fine-Tuning:</strong> Specify the sampling frequency (in Hz) and number of channels (mono or stereo) for the audio stream within the converted media file, allowing for customized audio output.</li>
<li><strong>Granular Resolution Management:</strong> Define the exact width and height in pixels for the converted video, granting precise control over the output dimensions. <em>(will be added)</em></li>
<li><strong>Bitrate Optimization:</strong> Set the bitrate (in kbps or on Mbps) to strike a balance between quality and file size, catering to different bandwidth requirements or storage constraints.</li>
<li><strong>Audio Fine-Tuning:</strong> Specify the sampling frequency (in Hz) and number of channels (mono or stereo) for the audio stream within the converted media file, allowing for customized audio output. <em>(will be added)</em></li>
</ul>
<h2 id="installation">Installation</h2>
<p>download nyx_converter to path <code>./widgets/nyx_converter</code> then add as a dependency in your pubspec.yaml file:</p>
<p>To use this package, add <code>nyx_converter</code> as a dependency in your pubspec.yaml file.</p>
<pre class="language-yaml"><code class="language-yaml">dependencies:
nyx_converter:
path: ./widgets/nyx_converter
nyx_converter: &lt;latest-version&gt;
</code></pre>
<h2 id="platform-support">Platform Support</h2>
<p>The following table shows Android API level, iOS deployment target and macOS deployment target requirements in <code>nyx_converter</code> releases.</p><table>
<p>The following table shows Android API level, iOS deployment target and macOS deployment target requirements in <code>nyx_converter</code> releases.</p>
<table>
<thead>
<tr>
<th align="center">Android<br>API Level</th>
Expand All @@ -89,42 +87,23 @@ <h2 id="using">Using</h2>
<p><strong>Widget Usage:</strong> Use <code>.convertTo</code> method for initiate the media file path and desired output file path to save converted media file.</p>
<pre class="language-dart"><code class="language-dart">final filePath = 'path/to/my.mp4';
final outputPath = 'path/to/';
NyxData? result = NyxConverter.convertTo(
result = NyxConverter.convertTo(
filePath, // Specify the input file path
outputPath, // Define the output file path
</code></pre>
<p><strong><a href="https://xaus-group.github.io/nyx_converter/nyx_converter/NyxContainer.html">Container</a>:</strong> Choose the desired container for your output media file.</p><table>
<thead>
<tr>
<th align="center">Video</th>
<th align="center">Audio</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">AVI</td>
<td align="center">WAV</td>
</tr>
<tr>
<td align="center">MP4</td>
<td align="center">FLAC</td>
</tr>
<tr>
<td align="center">MKV</td>
<td align="center">OGG</td>
</tr>
<tr>
<td align="center">MOV</td>
<td align="center">AAC</td>
</tr>
<tr>
<td align="center">WebM</td>
<td align="center">MP3</td>
</tr>
</tbody>
</table>
<p><strong><a href="https://github.com/xaus-group/nyx_converter/wiki/Container">Container</a>:</strong> Choose the desired container for your output media file.</p>
<pre class="language-dart"><code class="language-dart"> container: NyxContainer.mp4,
</code></pre>
<p><strong><a href="https://github.com/xaus-group/nyx_converter/wiki/Video-codec">Video Codec</a>:</strong> Select the appropriate video codec for your media file.</p>
<pre class="language-dart"><code class="language-dart"> videoCodec: NyxVideoCodec.h264,
</code></pre>
<p><strong><a href="https://github.com/xaus-group/nyx_converter/wiki/Audio-codec">Audio Codec</a>:</strong> Select the appropriate audio codec for your media file.</p>
<pre class="language-dart"><code class="language-dart"> audioCodec: NyxAudioCodec.aac,
</code></pre>
<p><strong><a href="https://github.com/xaus-group/nyx_converter/wiki/Bitrate">Bitrate</a>:</strong> Set the bitrate to balance between quality and file size. Typical values range from 96 kbps for low quality to 320 kbps for high quality audio, and from 1 Mbps for low quality to 10 Mbps or higher for high quality video.</p>
<pre class="language-dart"><code class="language-dart"> audioBitrate: 192,
videoBitrate: 5,
</code></pre>
<p><strong>Debug Mode:</strong> Set true for get detailed logs</p>
<pre class="language-dart"><code class="language-dart"> debugMode: true,
</code></pre>
Expand All @@ -137,30 +116,12 @@ <h2 id="using">Using</h2>
}
);
</code></pre>
<h2 id="todo">TODO</h2>
<pre class="language-dart"><code class="language-dart">final filePath = 'path/to/my.mp4';
final outputPath = 'path/to/';
NyxData? result = NyxConverter.convertTo(
//TODO: videoCodec: NyxVideoCodec.h264, // Specify the video codec (optional)
//TODO: audioCodec: NyxAudioCodec.flac, // Define the audio codec (optional)
//TODO: size: NyxSize.w1280h720, // Set the width and height in pixels (optional)
//TODO: bitrate: NyxBitrate.k320, // Set the bitrate in kbps (optional)
//TODO: frequency: NyxFrequency.hz48000, // Specify the sampling frequency in Hz (optional)
//TODO: channelLayout: NyxChannelLayout.stereo // Define the number of channels (optional)
);

NyxCoverter.convertTo$.subscribe((int percent, int time, bool isDone) {
printDebug('percent on complition $percent');
printDebug('time of file process $time');
printDebug('process is done $isDone');
});

if(result.path != null) {
//TODO: converted file is ready
}

NyxConverter.convertTo$.kill(); // kill all process of NyxConverter widget
<hr>
<p><strong>Stop process:</strong> Use <code>.kill</code> method to kill all <code>nyx_converter</code> processes.</p>
<pre class="language-dart"><code class="language-dart">NyxConverter.kill();
</code></pre>
<h2 id="contributing">Contributing</h2>
<p>There is not much to contribute since the package serves its purpose, however, in chance of needing to bump or adjust some version, or any other suggestion for that matter, please read <a href="https://github.com/xaus-group/nyx_converter/blob/master/CONTRIBUTING.md">CONTRIBUTING</a>.</p>
</section>


Expand All @@ -176,51 +137,40 @@ <h2>Libraries</h2>

</dl>
</section>

</div> <!-- /.main-content -->

<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
<header id="header-search-sidebar" class="hidden-l">
<!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<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 class="self-crumb">nyx_converter package</li>
<li class="self-crumb">nyx_converter package</li>
</ol>


<h5 class="hidden-xs"><span class="package-name">nyx_converter</span> <span class="package-kind">package</span></h5>
<ol>
<li class="section-title">Libraries</li>
<li><a href="nyx_converter/nyx_converter-library.html">nyx_converter</a></li>
</ol>

</div>

<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
</div>

</main>

<footer>
<span class="no-break">
nyx_converter
0.0.1
0.3.0
</span>


</footer>



<script src="static-assets/highlight.pack.js?v1"></script>
<script src="static-assets/docs.dart.js"></script>



</body>

</html>

2 changes: 1 addition & 1 deletion docs/index.json
View file

Large diffs are not rendered by default.

Loading

0 comments on commit ba65a7c

Please sign in to comment.