Meziantou.Framework.WebPlatform.WebCodecs namespace

Classes

NameDescription
AacEncoderConfigThe options of the AAC encoder (https://w3c.github.io/webcodecs/aac_codec_registration.html#dictdef-aacencoderconfig).
AudioDataAudio samples (https://w3c.github.io/webcodecs/#audiodata): the decoded audio of an AudioDecoder, the input of an AudioEncoder, or the audio created by the scripts from a buffer. The samples are immutable and shared by the clones; they can be copied to a buffer in any sample format, and posted to a worker (serialized or transferred).
AudioDataCopyToOptionsThe options of AudioData.CopyTo and AudioData.AllocationSize (https://w3c.github.io/webcodecs/#dictdef-audiodatacopytooptions).
AudioDataInitThe description of the samples of an AudioData (https://w3c.github.io/webcodecs/#dictdef-audiodatainit).
AudioDecoderDecodes audio (https://w3c.github.io/webcodecs/#audiodecoder-interface): the EncodedAudioChunk objects given to AudioDecoder.Decode are decoded by the codecs of BrowsingContextOptions.MediaCodecs, and the AudioData objects are given to the output callback.
AudioDecoderConfigThe configuration of an AudioDecoder (https://w3c.github.io/webcodecs/#dictdef-audiodecoderconfig).
AudioDecoderInitThe callbacks of an AudioDecoder (https://w3c.github.io/webcodecs/#dictdef-audiodecoderinit).
AudioDecoderSupportThe result of AudioDecoder.IsConfigSupported (https://w3c.github.io/webcodecs/#dictdef-audiodecodersupport).
AudioEncoderEncodes audio (https://w3c.github.io/webcodecs/#audioencoder-interface): the AudioData objects given to AudioEncoder.Encode are encoded by the codecs of BrowsingContextOptions.MediaCodecs, and the EncodedAudioChunk objects are given to the output callback with the configuration of their decoder.
AudioEncoderConfigThe configuration of an AudioEncoder (https://w3c.github.io/webcodecs/#dictdef-audioencoderconfig).
AudioEncoderInitThe callbacks of an AudioEncoder (https://w3c.github.io/webcodecs/#dictdef-audioencoderinit).
AudioEncoderSupportThe result of AudioEncoder.IsConfigSupported (https://w3c.github.io/webcodecs/#dictdef-audioencodersupport).
AvcEncoderConfigThe options of the AVC encoder (https://w3c.github.io/webcodecs/avc_codec_registration.html#dictdef-avcencoderconfig).
EncodedAudioChunkA chunk of encoded audio (https://w3c.github.io/webcodecs/#encodedaudiochunk): the input of a AudioDecoder and the output of a AudioEncoder. Its bytes are immutable; it can be posted to a worker (serialized).
EncodedAudioChunkInitThe description of an EncodedAudioChunk (https://w3c.github.io/webcodecs/#dictdef-encodedaudiochunkinit).
EncodedAudioChunkMetadataThe metadata of an encoded audio chunk (https://w3c.github.io/webcodecs/#dictdef-encodedaudiochunkmetadata).
EncodedVideoChunkA chunk of encoded video (https://w3c.github.io/webcodecs/#encodedvideochunk): the input of a VideoDecoder and the output of a VideoEncoder. Its bytes are immutable; it can be posted to a worker (serialized).
EncodedVideoChunkInitThe description of an EncodedVideoChunk (https://w3c.github.io/webcodecs/#dictdef-encodedvideochunkinit).
EncodedVideoChunkMetadataThe metadata of an encoded video chunk (https://w3c.github.io/webcodecs/#dictdef-encodedvideochunkmetadata).
FlacEncoderConfigThe options of the FLAC encoder (https://w3c.github.io/webcodecs/flac_codec_registration.html#dictdef-flacencoderconfig).
HevcEncoderConfigThe options of the HEVC encoder (https://w3c.github.io/webcodecs/hevc_codec_registration.html#dictdef-hevcencoderconfig).
ImageDecodeOptionsThe options of ImageDecoder.Decode (https://w3c.github.io/webcodecs/#dictdef-imagedecodeoptions).
ImageDecodeResultThe result of ImageDecoder.Decode (https://w3c.github.io/webcodecs/#dictdef-imagedecoderesult).
ImageDecoderDecodes the frames of an encoded image (https://w3c.github.io/webcodecs/#imagedecoder) with the image decoders of the rendering backend (BrowsingContextOptions.RenderingBackend), the ones of the img elements: PNG (including the animated PNG), JPEG, GIF, WebP, AVIF, JPEG XL, BMP and ICO with the backend of Meziantou.Framework.WebPlatform.Imaging. The data is a buffer, or a stream whose frames can be decoded as they arrive.
ImageDecoderInitThe options of an ImageDecoder (https://w3c.github.io/webcodecs/#dictdef-imagedecoderinit).
ImageTrackA track of the image of an ImageDecoder (https://w3c.github.io/webcodecs/#imagetrack): a still image or an animation.
ImageTrackListThe tracks of the image of an ImageDecoder (https://w3c.github.io/webcodecs/#imagetracklist), and the selected one.
OpusEncoderConfigThe options of the Opus encoder (https://w3c.github.io/webcodecs/opus_codec_registration.html#dictdef-opusencoderconfig).
PlaneLayoutThe offset and the stride of a plane in a buffer (https://w3c.github.io/webcodecs/#dictdef-planelayout).
SvcOutputMetadataThe scalability metadata of an encoded chunk (https://w3c.github.io/webcodecs/#dictdef-svcoutputmetadata).
VideoColorSpaceThe color space of a VideoFrame (https://w3c.github.io/webcodecs/#videocolorspace): its color primaries, transfer characteristics, matrix coefficients and range, as the codecs describe them.
VideoColorSpaceInitThe members of a VideoColorSpace (https://w3c.github.io/webcodecs/#dictdef-videocolorspaceinit).
VideoDecoderDecodes video (https://w3c.github.io/webcodecs/#videodecoder-interface): the EncodedVideoChunk objects given to VideoDecoder.Decode are decoded by the codecs of BrowsingContextOptions.MediaCodecs, and the VideoFrame objects are given to the output callback, with the orientation, the display aspect ratio and the color space of the configuration.
VideoDecoderConfigThe configuration of a VideoDecoder (https://w3c.github.io/webcodecs/#dictdef-videodecoderconfig).
VideoDecoderInitThe callbacks of a VideoDecoder (https://w3c.github.io/webcodecs/#dictdef-videodecoderinit).
VideoDecoderSupportThe result of VideoDecoder.IsConfigSupported (https://w3c.github.io/webcodecs/#dictdef-videodecodersupport).
VideoEncoderEncodes video (https://w3c.github.io/webcodecs/#videoencoder-interface): the VideoFrame objects given to VideoEncoder.Encode are encoded by the codecs of BrowsingContextOptions.MediaCodecs, and the EncodedVideoChunk objects are given to the output callback with the configuration of their decoder.
VideoEncoderConfigThe configuration of a VideoEncoder (https://w3c.github.io/webcodecs/#dictdef-videoencoderconfig).
VideoEncoderEncodeOptionsThe options of the encoding of a frame (https://w3c.github.io/webcodecs/#dictdef-videoencoderencodeoptions).
VideoEncoderEncodeOptionsForAv1The options of the AV1 encoder for a frame (https://w3c.github.io/webcodecs/av1_codec_registration.html#dictdef-videoencoderencodeoptionsforav1).
VideoEncoderEncodeOptionsForAvcThe options of the AVC encoder for a frame (https://w3c.github.io/webcodecs/avc_codec_registration.html#dictdef-videoencoderencodeoptionsforavc).
VideoEncoderEncodeOptionsForHevcThe options of the HEVC encoder for a frame (https://w3c.github.io/webcodecs/hevc_codec_registration.html#dictdef-videoencoderencodeoptionsforhevc).
VideoEncoderEncodeOptionsForVp9The options of the VP9 encoder for a frame (https://w3c.github.io/webcodecs/vp9_codec_registration.html#dictdef-videoencoderencodeoptionsforvp9).
VideoEncoderInitThe callbacks of a VideoEncoder (https://w3c.github.io/webcodecs/#dictdef-videoencoderinit).
VideoEncoderSupportThe result of VideoEncoder.IsConfigSupported (https://w3c.github.io/webcodecs/#dictdef-videoencodersupport).
VideoFrameA frame of video or a decoded image (https://w3c.github.io/webcodecs/#videoframe): its pixels in one of the formats of VideoPixelFormat, the visible rectangle, the display size, the orientation, the timestamp and the color space. A frame is created from an image (a canvas, an image element, an ImageBitmap, a video element...), from a buffer of pixels, from another frame, by an ImageDecoder or by a VideoDecoder. A frame can be drawn on a canvas, used by createImageBitmap(), encoded by a VideoEncoder, posted to a worker (serialized or transferred) and copied to a buffer in its format or converted to RGB.
VideoFrameBufferInitThe description of the pixels of a VideoFrame created from a buffer (https://w3c.github.io/webcodecs/#dictdef-videoframebufferinit).
VideoFrameCopyToOptionsThe options of VideoFrame.CopyTo and VideoFrame.AllocationSize (https://w3c.github.io/webcodecs/#dictdef-videoframecopytooptions).
VideoFrameInitThe options of a VideoFrame created from an image or another frame (https://w3c.github.io/webcodecs/#dictdef-videoframeinit).
VideoFrameMetadataThe metadata of a VideoFrame (https://w3c.github.io/webcodecs/#dictdef-videoframemetadata): no member is defined by the specification.

Enums

NameDescription
AacBitstreamFormatThe bitstream format of the AAC encoder (https://w3c.github.io/webcodecs/aac_codec_registration.html#enumdef-aacbitstreamformat).
AlphaOptionWhether the alpha channel of a source is kept (https://w3c.github.io/webcodecs/#enumdef-alphaoption).
AudioSampleFormatThe format of the audio samples of an AudioData (https://w3c.github.io/webcodecs/#enumdef-audiosampleformat).
AvcBitstreamFormatThe bitstream format of the AVC encoder (https://w3c.github.io/webcodecs/avc_codec_registration.html#enumdef-avcbitstreamformat).
BitrateModeHow an audio encoder controls its bitrate (https://w3c.github.io/mediacapture-record/#enumdef-bitratemode).
CodecStateThe state of a codec (https://w3c.github.io/webcodecs/#enumdef-codecstate).
EncodedAudioChunkTypeThe type of an EncodedAudioChunk (https://w3c.github.io/webcodecs/#enumdef-encodedaudiochunktype).
EncodedVideoChunkTypeThe type of an EncodedVideoChunk (https://w3c.github.io/webcodecs/#enumdef-encodedvideochunktype).
HardwareAccelerationThe preference of a codec for a hardware implementation (https://w3c.github.io/webcodecs/#enumdef-hardwareacceleration).
HevcBitstreamFormatThe bitstream format of the HEVC encoder (https://w3c.github.io/webcodecs/hevc_codec_registration.html#enumdef-hevcbitstreamformat).
LatencyModeThe latency preferred by a video encoder (https://w3c.github.io/webcodecs/#enumdef-latencymode).
OpusApplicationThe intended application of the Opus encoder (https://w3c.github.io/webcodecs/opus_codec_registration.html#enumdef-opusapplication).
OpusBitstreamFormatThe bitstream format of the Opus encoder (https://w3c.github.io/webcodecs/opus_codec_registration.html#enumdef-opusbitstreamformat).
OpusSignalThe type of signal encoded by the Opus encoder (https://w3c.github.io/webcodecs/opus_codec_registration.html#enumdef-opussignal).
VideoColorPrimariesThe color primaries of a video color space (https://w3c.github.io/webcodecs/#enumdef-videocolorprimaries).
VideoEncoderBitrateModeHow a video encoder controls its bitrate (https://w3c.github.io/webcodecs/#enumdef-videoencoderbitratemode).
VideoMatrixCoefficientsThe matrix coefficients of a video color space (https://w3c.github.io/webcodecs/#enumdef-videomatrixcoefficients).
VideoPixelFormatThe arrangement of the bytes of the planes of a VideoFrame (https://w3c.github.io/webcodecs/#enumdef-videopixelformat).
VideoTransferCharacteristicsThe transfer characteristics of a video color space (https://w3c.github.io/webcodecs/#enumdef-videotransfercharacteristics).

Delegates

NameDescription
AudioDataOutputCallbackThe callback that receives the audio decoded by an AudioDecoder (https://w3c.github.io/webcodecs/#callbackdef-audiodataoutputcallback).
EncodedAudioChunkOutputCallbackThe callback that receives the chunks encoded by an AudioEncoder (https://w3c.github.io/webcodecs/#callbackdef-encodedaudiochunkoutputcallback).
EncodedVideoChunkOutputCallbackThe callback that receives the chunks encoded by a VideoEncoder (https://w3c.github.io/webcodecs/#callbackdef-encodedvideochunkoutputcallback).
VideoFrameOutputCallbackThe callback that receives the frames decoded by a VideoDecoder (https://w3c.github.io/webcodecs/#callbackdef-videoframeoutputcallback).
WebCodecsErrorCallbackThe callback that receives the error that closes a codec (https://w3c.github.io/webcodecs/#callbackdef-webcodecserrorcallback).