Mediabunny API reference
Here you can find detailed documentation for all classes, functions, constants and types exposed by Mediabunny's public API.
Samples
Raw, unencoded chunks of media data, such as video frames or sections of audio.
Packets
Chunks of encoded media data.
Input files & tracks
Read input files and their tracks; demuxer API.
Input formats
Container formats that Mediabunny can read.
- InputFormat
- AdtsInputFormat
- IsobmffInputFormat
- MatroskaInputFormat
- Mp3InputFormat
- Mp4InputFormat
- OggInputFormat
- QuickTimeInputFormat
- WaveInputFormat
- WebMInputFormat
- ALL_FORMATS
- ADTS
- MATROSKA
- MP3
- MP4
- OGG
- QTFF
- WAVE
- WEBM
Input sources
The sources that can provide data to an Input.
- Source
- BlobSource
- BlobSourceOptions
- BufferSource
- FilePathSource
- FilePathSourceOptions
- StreamSource
- StreamSourceOptions
- ReadableStreamSource
- ReadableStreamSourceOptions
- UrlSource
- UrlSourceOptions
Output files
Create and write new media files; muxer API.
Output formats
Container formats that Mediabunny can write.
- OutputFormat
- AdtsOutputFormat
- AdtsOutputFormatOptions
- IsobmffOutputFormat
- IsobmffOutputFormatOptions
- MkvOutputFormat
- MkvOutputFormatOptions
- MovOutputFormat
- Mp3OutputFormat
- Mp3OutputFormatOptions
- Mp4OutputFormat
- OggOutputFormat
- OggOutputFormatOptions
- WavOutputFormat
- WavOutputFormatOptions
- WebMOutputFormat
- WebMOutputFormatOptions
- TrackCountLimits
Output targets
The targets where Output writes data to.
Media sinks
Methods for extracting media data from input files.
- AudioBufferSink
- AudioSampleSink
- BaseMediaSampleSink
- CanvasSink
- CanvasSinkOptions
- EncodedPacketSink
- PacketRetrievalOptions
- VideoSampleSink
- WrappedAudioBuffer
- WrappedCanvas
Media sources
Methods for adding media data to output files.
- MediaSource
- VideoSource
- AudioSource
- SubtitleSource
- AudioBufferSource
- AudioSampleSource
- CanvasSource
- EncodedAudioPacketSource
- EncodedVideoPacketSource
- MediaStreamAudioTrackSource
- MediaStreamVideoTrackSource
- TextSubtitleSource
- VideoSampleSource
Conversion
A simple API for converting and transforming media files.
Metadata tags
Descriptive metadata tags attached to media files.
Codecs
Codecs understood by Mediabunny.
- MediaCodec
- VideoCodec
- AudioCodec
- SubtitleCodec
- VIDEO_CODECS
- AUDIO_CODECS
- PCM_AUDIO_CODECS
- NON_PCM_AUDIO_CODECS
- SUBTITLE_CODECS
Encoding
Encoder configuration and encodability checks.
- VideoEncodingConfig
- VideoEncodingAdditionalOptions
- AudioEncodingConfig
- AudioEncodingAdditionalOptions
- canEncode
- canEncodeVideo
- canEncodeAudio
- canEncodeSubtitles
- getEncodableCodecs
- getEncodableVideoCodecs
- getEncodableAudioCodecs
- getEncodableSubtitleCodecs
- getFirstEncodableVideoCodec
- getFirstEncodableAudioCodec
- getFirstEncodableSubtitleCodec
- Quality
- QUALITY_VERY_LOW
- QUALITY_LOW
- QUALITY_MEDIUM
- QUALITY_HIGH
- QUALITY_VERY_HIGH
Custom coders
API for adding custom encoders and decoders.
- CustomVideoDecoder
- CustomVideoEncoder
- CustomAudioDecoder
- CustomAudioEncoder
- registerDecoder
- registerEncoder
Miscellaneous
Whatever's left.
@mediabunny/mp3-encoder
Adds MP3 encoder support to Mediabunny.