Add API doc generator, improve documentation across the board

This commit is contained in:
Vanilagy
2025-09-03 18:11:43 +02:00
parent 9d70c4c605
commit a2a30c3e92
28 changed files with 2281 additions and 388 deletions
+91 -58
View File
@@ -16,61 +16,53 @@ export {
VideoTrackMetadata,
AudioTrackMetadata,
SubtitleTrackMetadata,
TrackType,
ALL_TRACK_TYPES,
} from './output';
export {
OutputFormat,
AdtsOutputFormat,
AdtsOutputFormatOptions,
IsobmffOutputFormat,
Mp4OutputFormat,
MovOutputFormat,
IsobmffOutputFormatOptions,
MkvOutputFormat,
MkvOutputFormatOptions,
WebMOutputFormat,
WebMOutputFormatOptions,
MovOutputFormat,
Mp3OutputFormat,
Mp3OutputFormatOptions,
WavOutputFormat,
WavOutputFormatOptions,
Mp4OutputFormat,
OggOutputFormat,
OggOutputFormatOptions,
AdtsOutputFormat,
AdtsOutputFormatOptions,
TrackCountLimits,
WavOutputFormat,
WavOutputFormatOptions,
WebMOutputFormat,
WebMOutputFormatOptions,
InclusiveIntegerRange,
TrackCountLimits,
} from './output-format';
export {
MediaSource,
VideoSource,
EncodedVideoPacketSource,
VideoSampleSource,
CanvasSource,
MediaStreamVideoTrackSource,
AudioSource,
EncodedAudioPacketSource,
AudioSampleSource,
AudioBufferSource,
MediaStreamAudioTrackSource,
SubtitleSource,
AudioBufferSource,
AudioSampleSource,
CanvasSource,
EncodedAudioPacketSource,
EncodedVideoPacketSource,
MediaStreamAudioTrackSource,
MediaStreamVideoTrackSource,
TextSubtitleSource,
VideoSampleSource,
} from './media-source';
export {
VIDEO_CODECS,
MediaCodec,
VideoCodec,
AudioCodec,
SubtitleCodec,
VIDEO_CODECS,
AUDIO_CODECS,
PCM_AUDIO_CODECS,
NON_PCM_AUDIO_CODECS,
AUDIO_CODECS,
AudioCodec,
SUBTITLE_CODECS,
SubtitleCodec,
MediaCodec,
Quality,
QUALITY_VERY_LOW,
QUALITY_LOW,
QUALITY_MEDIUM,
QUALITY_HIGH,
QUALITY_VERY_HIGH,
} from './codec';
export {
VideoEncodingConfig,
@@ -88,69 +80,110 @@ export {
getFirstEncodableVideoCodec,
getFirstEncodableAudioCodec,
getFirstEncodableSubtitleCodec,
Quality,
QUALITY_VERY_LOW,
QUALITY_LOW,
QUALITY_MEDIUM,
QUALITY_HIGH,
QUALITY_VERY_HIGH,
} from './encode';
export { Target, BufferTarget, StreamTarget, StreamTargetChunk, StreamTargetOptions, NullTarget } from './target';
export { Rotation, AnyIterable, SetRequired, MaybePromise } from './misc';
export {
Target,
BufferTarget,
NullTarget,
StreamTarget,
StreamTargetOptions,
StreamTargetChunk,
} from './target';
export {
AnyIterable,
MaybePromise,
Rotation,
SetRequired,
} from './misc';
export {
TrackType,
ALL_TRACK_TYPES,
} from './output';
export {
Source,
BufferSource,
BlobSource,
BlobSourceOptions,
UrlSource,
UrlSourceOptions,
BufferSource,
FilePathSource,
FilePathSourceOptions,
StreamSource,
StreamSourceOptions,
ReadableStreamSource,
ReadableStreamSourceOptions,
UrlSource,
UrlSourceOptions,
} from './source';
export {
InputFormat,
AdtsInputFormat,
IsobmffInputFormat,
Mp4InputFormat,
QuickTimeInputFormat,
MatroskaInputFormat,
WebMInputFormat,
Mp3InputFormat,
WaveInputFormat,
Mp4InputFormat,
OggInputFormat,
QuickTimeInputFormat,
WaveInputFormat,
WebMInputFormat,
ALL_FORMATS,
MP4,
QTFF,
ADTS,
MATROSKA,
WEBM,
MP3,
WAVE,
MP4,
OGG,
QTFF,
WAVE,
WEBM,
} from './input-format';
export { Input, InputOptions } from './input';
export { InputTrack, InputVideoTrack, InputAudioTrack, PacketStats } from './input-track';
export { EncodedPacket, PacketType } from './packet';
export {
VideoSample,
VideoSampleInit,
Input,
InputOptions,
} from './input';
export {
InputTrack,
InputVideoTrack,
InputAudioTrack,
PacketStats,
} from './input-track';
export {
EncodedPacket,
PacketType,
} from './packet';
export {
AudioSample,
AudioSampleInit,
AudioSampleCopyToOptions,
VideoSample,
VideoSampleInit,
} from './sample';
export {
PacketRetrievalOptions,
EncodedPacketSink,
BaseMediaSampleSink,
VideoSampleSink,
CanvasSinkOptions,
CanvasSink,
WrappedCanvas,
AudioSampleSink,
AudioBufferSink,
AudioSampleSink,
BaseMediaSampleSink,
CanvasSink,
CanvasSinkOptions,
EncodedPacketSink,
PacketRetrievalOptions,
VideoSampleSink,
WrappedAudioBuffer,
WrappedCanvas,
} from './media-sink';
export { Conversion, ConversionOptions, ConversionVideoOptions, ConversionAudioOptions } from './conversion';
export {
Conversion,
ConversionOptions,
ConversionVideoOptions,
ConversionAudioOptions,
DiscardedTrack,
} from './conversion';
export {
CustomVideoDecoder,
CustomAudioDecoder,
CustomVideoEncoder,
CustomAudioDecoder,
CustomAudioEncoder,
registerDecoder,
registerEncoder,