-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
226 lines (205 loc) · 8.98 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>NextAudio Documentation | NextAudio Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="NextAudio Documentation | NextAudio Documentation ">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="images/favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="">
<link rel="stylesheet" href="https://cdn.rawgit.com/jordnkr/collapsible/master/collapsible.css"></head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="images/icon.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<p>
<img class="logo" src="images/banner.png">
</p>
<h2 id="nextaudio-documentation">NextAudio Documentation</h2>
<p>NextAudio is a library focused in audio operations like encoding, decoding, muxing, demuxing, resampling, etc.</p>
<p>It's designed to be to simple to use, but with streaming support and high performance.</p>
<h2 id="getting-started">Getting Started</h2>
<p>If this is your first time using NextAudio, proceed to the <a href="/articles/introduction.html">Introduction</a> in articles section.</p>
<p>If you wanna see all objects provided by this library you can access the <a href="/api">API Documentation</a>.</p>
<h2 id="features">Features</h2>
<h4 id="basic-features">Basic features</h4>
<ul>
<li>High performance, low memory allocation with <code>Span<T></code>, <code>Memory<T></code>, <code>ArrayPool</code> and lower GC pressure with <code>ValueTask</code>.</li>
<li>Fully Sync and Async support.</li>
<li>Per audio frame reading/writing.</li>
<li>Logging with <code>Microsoft.Extensions.Logging</code>.</li>
<li>Symbols debugging (<code>.snupkg</code>).</li>
</ul>
<h4 id="containers-demuxing-support">Containers demuxing support:</h4>
<ul>
<li>Matroska (.mkv/.webm)</li>
</ul>
<h1 id="goals">Goals</h1>
<p>OBS: Goals will change as new lib versions come out.</p>
<h4 id="audio-stream-providers-support">Audio stream providers support:</h4>
<ul>
<li>File (current supported by <code>AudioStream.CreateFromFile</code>)</li>
<li>Http (current supported by <code>AudioStream.CreateFromStream</code> but is not persistent)</li>
<li>Youtube</li>
</ul>
<h4 id="containers-demuxing-support-1">Containers demuxing support:</h4>
<ul>
<li>Ogg (.ogg/.ogv/.oga/.ogx)</li>
<li>Wav (.wav/.wave)</li>
<li>MPEG-4 Part 14 (.mp4)</li>
<li>Flac (.flac)</li>
</ul>
<h4 id="decoders-support">Decoders support:</h4>
<ul>
<li>Opus (.opus)</li>
<li>Vorbis (.ogg/.oga)</li>
<li>AAC (.m4a/.m4b/.m4p/.m4v/.m4r/.aac/.3gp/.mp4)</li>
<li>MPEG-1/2 Audio Layer 3 (.mp3/.mp4)</li>
</ul>
<h4 id="encoders-support">Encoders support:</h4>
<ul>
<li>Opus (.opus)</li>
</ul>
<h4 id="containers-probe-support">Containers probe support:</h4>
<ul>
<li>Matroska (.mkv/.webm)</li>
<li>Ogg (.ogg/.ogv/.oga/.ogx)</li>
<li>Wav (.wav/.wave)</li>
<li>MPEG-4 Part 14 (.mp4)</li>
<li>Flac (.flac)</li>
</ul>
<h4 id="others-audio-operations">Others audio operations</h4>
<ul>
<li>Seeking (by timestamp)</li>
<li>Volume</li>
<li>Resampling</li>
<li>Mono to Stereo</li>
</ul>
<h4 id="others">Others</h4>
<ul>
<li>Package with all lib individual components</li>
<li>Audio Pipelines (less complexity when wanna a specific output format)</li>
<li>Support for <code>Microsoft.Extensions.DependencyInjection</code></li>
<li>Writing to output formats (<code>PipelineWriter</code>/<code>Stream</code>)</li>
<li>An Audio Player structure to control play/queue/pause/seek/volume operations</li>
</ul>
<h2 id="source-and-license">Source and License</h2>
<p>NextAudio is licensed under <a href="https://github.com/NextAudio/NextAudio/blob/main/LICENSE">MIT License</a>.</p>
<p>The repository containing the source code for this library is in <a href="https://github.com/NextAudio/NextAudio">Github</a>.</p>
<p>NextAudio is built by <a href="https://github.com/renanrcp">renanrcp</a>.</p>
<hr><p>This page was last modified at 10/22/2022 01:51:59 -03:00 (UTC).</p><div class="collapse-container last-modified" id="accordion"><span><span class="arrow-r"></span>Commit Message</span><div><pre><code>Author: Renan Pinheiro
Commit: 46c35686920505bf3d0d850d628048de2b92c836
</code></pre><pre><code class="xml">Write docs guides (#82)
* feat: add initial doc files
* feat: docs
- some fixes in css
- remove theme switcher
- articles and glossary section
- articles/introduction page
* feat: add getting started section
* feat: add matroska doc
* feat: write glossary
* fix: break lines in matroska thanks and references
* fix: typos and grammal errors</code></pre></div></div></article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/NextAudio/NextAudio/blob/try-fix-some-docs-warnings/docs/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<div class="pull-left">
NextAudio (c) 2022
</div>
<div class="toggle-mode pull-right visible-sm visible-xs">
<div class="icon">
<i aria-hidden="true">☀</i>
</div>
<label class="switch">
<input type="checkbox" id="switch-style-m">
<span class="slider round"></span>
</label>
<div class="icon">
<i aria-hidden="true">☾</i>
</div>
</div>
</div>
</div>
<script type="text/javascript" src="styles/toggle-theme.js"></script>
</footer> </div>
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
<script>
$( function() {
$( "#accordion" ).collapsible();
} );</script><script type="text/javascript" src="https://cdn.rawgit.com/jordnkr/collapsible/master/jquery.collapsible.min.js"></script></body>
</html>