File: video_encoder.idl

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (63 lines) | stat: -rw-r--r-- 2,425 bytes parent folder | download | duplicates (9)
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
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// https://github.com/WICG/web-codecs

[
    Exposed=(Window,DedicatedWorker),
    SecureContext,
    ActiveScriptWrappable
] interface VideoEncoder : EventTarget {
    [CallWith=ScriptState, RaisesException, MeasureAs=WebCodecsVideoEncoder]
    constructor(VideoEncoderInit init);

    // The number of pending encode requests. This does not include requests
    // that have been sent to the underlying codec.
    readonly attribute unsigned long encodeQueueSize;

    // Fires to signal a decrease in encodeQueueSize. Will fire at most once
    // for a given turn of the event loop.
    attribute EventHandler ondequeue;

    // Enqueues a control message to configure the video encoder for encoding
    // frames as described by config.
    [RaisesException]
    void configure(VideoEncoderConfig config);

    // Enqueues a request to encode a frame.
    // Results of the encoding (EncodedVideoChunk) are returned via
    // the output callback provided in configure().
    [RaisesException]
    void encode(VideoFrame frame,
                         optional VideoEncoderEncodeOptions options = {});


    // Enqueues a request to produce outputs for all already encoded frames.
    // Resolved after emitting outputs for all previously encoded frames.
    [RaisesException]
    Promise<undefined> flush();

    // Discard all pending work and current encoder configuration.
    //
    // Output for earlier encoding requests will not be emitted.
    // The next encoded frame will be a keyframe.
    // Requires configure() to be call to set configuration once again.
    [RaisesException]
    void reset();

    // Enqueues a request to shut down the encoder and free its resources.
    [RaisesException]
    void close();

    // Which state the encoder is in, indicating which methods can be called.
    readonly attribute CodecState state;

    // Call prior to configure() to determine whether config will be supported.
    [CallWith=ScriptState, RaisesException]
    static Promise<VideoEncoderSupport> isConfigSupported(VideoEncoderConfig config);

    // Returns a list of all buffers that can be used while encoding
    [CallWith=ScriptState, RaisesException, RuntimeEnabled=WebCodecsVideoEncoderBuffers]
    sequence<VideoEncoderBuffer> getAllFrameBuffers();
};