Debian Codegraph @

doc/spec/source/API_ref/VPL_func_vid_encode.rst

raw
1 .. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
2 ..
3 .. SPDX-License-Identifier: CC-BY-4.0
4 ..
5 Intel(r) Video Processing Library (Intel(r) VPL)
6
7 .. _func_video_encode:
8
9 ===========
10 VideoENCODE
11 ===========
12
13 .. _func_vid_encode_begin:
14
15 Functions that perform the entire encoding pipeline from the input video frames
16 to the output bitstream.
17
18 .. _func_vid_encode_end:
19
20 ---
21 API
22 ---
23
24 .. contents::
25 :local:
26 :depth: 1
27
28 MFXVideoENCODE_Query
29 --------------------
30
31 .. doxygenfunction:: MFXVideoENCODE_Query
32 :project: DEF_BREATHE_PROJECT
33
34 .. important:: The :cpp:func:`MFXVideoENCODE_Query` function is mandatory when
35 implementing an encoder.
36
37 MFXVideoENCODE_QueryIOSurf
38 --------------------------
39
40 .. doxygenfunction:: MFXVideoENCODE_QueryIOSurf
41 :project: DEF_BREATHE_PROJECT
42
43 MFXVideoENCODE_Init
44 -------------------
45
46 .. doxygenfunction:: MFXVideoENCODE_Init
47 :project: DEF_BREATHE_PROJECT
48
49 .. important:: The :cpp:func:`MFXVideoENCODE_Init` function is mandatory when
50 implementing an encoder.
51
52 MFXVideoENCODE_Reset
53 --------------------
54
55 .. doxygenfunction:: MFXVideoENCODE_Reset
56 :project: DEF_BREATHE_PROJECT
57
58 MFXVideoENCODE_Close
59 --------------------
60
61 .. doxygenfunction:: MFXVideoENCODE_Close
62 :project: DEF_BREATHE_PROJECT
63
64 .. important:: The :cpp:func:`MFXVideoENCODE_Close` function is mandatory when
65 implementing an encoder.
66
67 MFXVideoENCODE_GetVideoParam
68 ----------------------------
69
70 .. doxygenfunction:: MFXVideoENCODE_GetVideoParam
71 :project: DEF_BREATHE_PROJECT
72
73 MFXVideoENCODE_GetEncodeStat
74 ----------------------------
75
76 .. doxygenfunction:: MFXVideoENCODE_GetEncodeStat
77 :project: DEF_BREATHE_PROJECT
78
79 MFXVideoENCODE_EncodeFrameAsync
80 -------------------------------
81
82 .. doxygenfunction:: MFXVideoENCODE_EncodeFrameAsync
83 :project: DEF_BREATHE_PROJECT
84
85 .. important:: The :cpp:func:`MFXVideoENCODE_EncodeFrameAsync` function is mandatory when
86 implementing an encoder.