Skip to content

Commit

Permalink
feat(*): Removes internal class to API guide and fixes streamers pack…
Browse files Browse the repository at this point in the history 
…age name
  • Loading branch information
@ThibaultBee
ThibaultBee committed May 22, 2021
1 parent 87b0f3d commit a7f2f9e
Show file tree
Hide file tree
Showing 747 changed files with 1,147 additions and 22,187 deletions.
6 changes: 3 additions & 3 deletions app/src/main/java/com/github/thibaultbee/streampack/app/ui/main/PreviewViewModel.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ import com.github.thibaultbee.streampack.error.StreamPackError
import com.github.thibaultbee.streampack.internal.muxers.ts.data.ServiceInfo
import com.github.thibaultbee.streampack.listeners.OnConnectionListener
import com.github.thibaultbee.streampack.listeners.OnErrorListener
import com.github.thibaultbee.streampack.streamer.BaseCaptureStreamer
import com.github.thibaultbee.streampack.streamer.CaptureFileStreamer
import com.github.thibaultbee.streampack.streamer.CaptureSrtLiveStreamer
import com.github.thibaultbee.streampack.streamers.BaseCaptureStreamer
import com.github.thibaultbee.streampack.streamers.CaptureFileStreamer
import com.github.thibaultbee.streampack.streamers.CaptureSrtLiveStreamer
import java.io.File

class PreviewViewModel(application: Application) : AndroidViewModel(application) {
Expand Down
297 changes: 11 additions & 286 deletions docs/dokka/sdk/alltypes/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,6 @@ <h3>All Types</h3>
<tbody>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.descriptors/-adaptation-field/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.descriptors.AdaptationField</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.encoders.format.aac/-adts/index.html">com.github.thibaultbee.streampack.internal.encoders.format.aac.Adts</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.sources/-audio-capture/index.html">com.github.thibaultbee.streampack.internal.sources.AudioCapture</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.data/-audio-config/index.html">com.github.thibaultbee.streampack.data.AudioConfig</a></td>
<td>
<p>Audio configuration class.
Expand All @@ -36,36 +18,10 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.encoders/-audio-media-codec-encoder/index.html">com.github.thibaultbee.streampack.internal.encoders.AudioMediaCodecEncoder</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.streamer/-base-capture-streamer/index.html">com.github.thibaultbee.streampack.streamer.BaseCaptureStreamer</a></td>
<td>
<p>Base class of CaptureStreamer: <a href="../com.github.thibaultbee.streampack.streamer/-capture-file-streamer/index.html">CaptureFileStreamer</a> or <a href="../com.github.thibaultbee.streampack.streamer/-capture-srt-live-streamer/index.html">CaptureSrtLiveStreamer</a>
Use this class, only if you want to implement a custom <a href="../com.github.thibaultbee.streampack.internal.endpoints/-i-endpoint/index.html">IEndpoint</a>.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.bitbuffer/-bit-buffer/index.html">com.github.thibaultbee.streampack.internal.bitbuffer.BitBuffer</a></td>
<td>
<p>A data type similar to <a href="https://developer.android.com/reference/java/nio/ByteBuffer.html">ByteBuffer</a>, but can read/write bits as well as <code>byte</code>s to improve
throughput and allow for optional compression.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.utils/kotlin.-boolean/index.html">kotlin.Boolean</a> (extensions in package com.github.thibaultbee.streampack.internal.muxers.ts.utils)</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.sources/-camera-capture/index.html">com.github.thibaultbee.streampack.internal.sources.CameraCapture</a></td>
<a href="../com.github.thibaultbee.streampack.streamers/-base-capture-streamer/index.html">com.github.thibaultbee.streampack.streamers.BaseCaptureStreamer</a></td>
<td>
<p>Base class of CaptureStreamer: <a href="../com.github.thibaultbee.streampack.streamers/-capture-file-streamer/index.html">CaptureFileStreamer</a> or <a href="../com.github.thibaultbee.streampack.streamers/-capture-srt-live-streamer/index.html">CaptureSrtLiveStreamer</a>
Use this class, only if you want to implement a custom endpoint.</p>
</td>
</tr>
<tr>
Expand All @@ -77,119 +33,29 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.streamer/-capture-file-streamer/index.html">com.github.thibaultbee.streampack.streamer.CaptureFileStreamer</a></td>
<td>
<p><a href="../com.github.thibaultbee.streampack.streamer/-base-capture-streamer/index.html">BaseCaptureStreamer</a> that sends audio/video frames to a <a href="https://developer.android.com/reference/java/io/File.html">File</a>.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.streamer/-capture-srt-live-streamer/index.html">com.github.thibaultbee.streampack.streamer.CaptureSrtLiveStreamer</a>
</td>
<td>
<p>
<a href="../com.github.thibaultbee.streampack.streamer/-base-capture-streamer/index.html">BaseCaptureStreamer</a>
that sends audio/video frames to a remote device p, Secure Reliable
Transport (SRT) Protocol.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.utils/-codec-utils/index.html">com.github.thibaultbee.streampack.utils.CodecUtils</a>
</td>
<td>
<p>Helper for audio/video codec.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.utils/android.content.-context/index.html">android.content.Context</a>
(extensions in package com.github.thibaultbee.streampack.utils)
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.interfaces/-controllable/index.html">com.github.thibaultbee.streampack.internal.interfaces.Controllable</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.utils/-c-r-c32/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.utils.CRC32</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.gl/-e-gl-surface/index.html">com.github.thibaultbee.streampack.internal.gl.EGlSurface</a></td>
<td>
<p>Holds state associated with a Surface used for MediaCodec encoder input.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.events/-event-handler/index.html">com.github.thibaultbee.streampack.internal.events.EventHandler</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.endpoints/-fake-endpoint/index.html">com.github.thibaultbee.streampack.internal.endpoints.FakeEndpoint</a></td>
<td>
<p>A fake endpoint for test purpose.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.endpoints/-file-writer/index.html">com.github.thibaultbee.streampack.internal.endpoints.FileWriter</a></td>
<a href="../com.github.thibaultbee.streampack.streamers/-capture-file-streamer/index.html">com.github.thibaultbee.streampack.streamers.CaptureFileStreamer</a></td>
<td>
<p><a href="../com.github.thibaultbee.streampack.streamers/-base-capture-streamer/index.html">BaseCaptureStreamer</a> that sends audio/video frames to a <a href="https://developer.android.com/reference/java/io/File.html">File</a>.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.data/-frame/index.html">com.github.thibaultbee.streampack.internal.data.Frame</a></td>
<a href="../com.github.thibaultbee.streampack.streamers/-capture-srt-live-streamer/index.html">com.github.thibaultbee.streampack.streamers.CaptureSrtLiveStreamer</a></td>
<td>
<p>Frame internal representation.</p>
<p><a href="../com.github.thibaultbee.streampack.streamers/-base-capture-streamer/index.html">BaseCaptureStreamer</a> that sends audio/video frames to a remote device p, Secure Reliable
Transport (SRT) Protocol.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.gl/-full-frame-rect/index.html">com.github.thibaultbee.streampack.internal.gl.FullFrameRect</a></td>
<a href="../com.github.thibaultbee.streampack.utils/-codec-utils/index.html">com.github.thibaultbee.streampack.utils.CodecUtils</a></td>
<td>
<p>This class essentially represents a viewport-sized sprite that will be rendered with
a texture, usually from an external source like the camera or video decoder.</p>
<p>Helper for audio/video codec.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.gl/-gl-utils/index.html">com.github.thibaultbee.streampack.internal.gl.GlUtils</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.sources/-i-capture/index.html">com.github.thibaultbee.streampack.internal.sources.ICapture</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.encoders/-i-encoder/index.html">com.github.thibaultbee.streampack.internal.encoders.IEncoder</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.encoders/-i-encoder-listener/index.html">com.github.thibaultbee.streampack.internal.encoders.IEncoderListener</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.endpoints/-i-endpoint/index.html">com.github.thibaultbee.streampack.internal.endpoints.IEndpoint</a></td>
<a href="../com.github.thibaultbee.streampack.utils/android.content.-context/index.html">android.content.Context</a> (extensions in package com.github.thibaultbee.streampack.utils)</td>
<td>
</td>
</tr>
Expand All @@ -202,30 +68,6 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers/-i-muxer-listener/index.html">com.github.thibaultbee.streampack.internal.muxers.IMuxerListener</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.data/-i-t-s-element/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.data.ITSElement</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.encoders/-media-codec-encoder/index.html">com.github.thibaultbee.streampack.internal.encoders.MediaCodecEncoder</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.utils/-muxer-const/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.utils.MuxerConst</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.listeners/-on-connection-listener/index.html">com.github.thibaultbee.streampack.listeners.OnConnectionListener</a></td>
<td>
<p>Interface of Secure Reliable Transport (SRT) Protocol listener</p>
Expand All @@ -240,74 +82,6 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.data/-packet/index.html">com.github.thibaultbee.streampack.internal.data.Packet</a></td>
<td>
<p>Packet internal representation.
A <a href="../com.github.thibaultbee.streampack.internal.data/-frame/index.html">Frame</a> is composed by multiple packets.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.tables/-pat/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.tables.Pat</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.packets/-pes/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.packets.Pes</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.packets/-pes-header/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.packets.PesHeader</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.tables/-pmt/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.tables.Pmt</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.tables/-psi/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.tables.Psi</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.tables/-sdt/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.tables.Sdt</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.data/-service/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.data.Service</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.data/-service-info/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.data.ServiceInfo</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.endpoints/-srt-producer/index.html">com.github.thibaultbee.streampack.internal.endpoints.SrtProducer</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.data/-stream/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.data.Stream</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.error/-stream-pack-error/index.html">com.github.thibaultbee.streampack.error.StreamPackError</a></td>
<td>
<p>Class that encapsulates StreamPack errors</p>
Expand All @@ -321,61 +95,12 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.tables/-table-header/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.tables.TableHeader</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.gl/-texture2-d-program/index.html">com.github.thibaultbee.streampack.internal.gl.Texture2DProgram</a></td>
<td>
<p>GL program and supporting functions for textured 2D shapes.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.utils/-time-utils/index.html">com.github.thibaultbee.streampack.internal.utils.TimeUtils</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.packets/-t-s/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.packets.TS</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.utils/-t-s-const/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.utils.TSConst</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts/-t-s-muxer/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.TSMuxer</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.muxers.ts.utils/-t-s-output-callback/index.html">com.github.thibaultbee.streampack.internal.muxers.ts.utils.TSOutputCallback</a></td>
<td>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.data/-video-config/index.html">com.github.thibaultbee.streampack.data.VideoConfig</a></td>
<td>
<p>Video configuration class.
If you don't know how to set class members, <a href="https://developer.android.com/guide/topics/media/media-formats#video-encoding">Video encoding recommendations</a> should give you hints.</p>
</td>
</tr>
<tr>
<td>
<a href="../com.github.thibaultbee.streampack.internal.encoders/-video-media-codec-encoder/index.html">com.github.thibaultbee.streampack.internal.encoders.VideoMediaCodecEncoder</a></td>
<td>
</td>
</tr>
</tbody>
</table>
</BODY>
Expand Down
2 changes: 1 addition & 1 deletion docs/dokka/sdk/com.github.thibaultbee.streampack.data/-audio-config/-init-.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h1>&lt;init&gt;</h1>
<p>Audio configuration class.
If you don't know how to set class members, <a href="https://developer.android.com/guide/topics/media/media-formats#video-encoding">Video encoding recommendations</a> should give you hints.</p>
<p><strong>See Also</strong><br/>
<p><a href="../../com.github.thibaultbee.streampack.streamer/-base-capture-streamer/configure.html">BaseCaptureStreamer.configure</a></p>
<p><a href="../../com.github.thibaultbee.streampack.streamers/-base-capture-streamer/configure.html">BaseCaptureStreamer.configure</a></p>
</p>
</BODY>
</HTML>
2 changes: 1 addition & 1 deletion docs/dokka/sdk/com.github.thibaultbee.streampack.data/-audio-config/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h1>AudioConfig</h1>
<p>Audio configuration class.
If you don't know how to set class members, <a href="https://developer.android.com/guide/topics/media/media-formats#video-encoding">Video encoding recommendations</a> should give you hints.</p>
<p><strong>See Also</strong><br/>
<p><a href="../../com.github.thibaultbee.streampack.streamer/-base-capture-streamer/configure.html">BaseCaptureStreamer.configure</a></p>
<p><a href="../../com.github.thibaultbee.streampack.streamers/-base-capture-streamer/configure.html">BaseCaptureStreamer.configure</a></p>
</p>
<h3>Constructors</h3>
<table>
Expand Down
Loading

0 comments on commit a7f2f9e

Please sign in to comment.