Blame view

kernel/linux-rt-4.4.41/Documentation/DocBook/media/v4l/vidioc-overlay.xml 1.88 KB
5113f6f70   김현기   kernel add
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
64
65
66
67
68
69
70
71
72
73
74
  <refentry id="vidioc-overlay">
    <refmeta>
      <refentrytitle>ioctl VIDIOC_OVERLAY</refentrytitle>
      &manvol;
    </refmeta>
  
    <refnamediv>
      <refname>VIDIOC_OVERLAY</refname>
      <refpurpose>Start or stop video overlay</refpurpose>
    </refnamediv>
  
    <refsynopsisdiv>
      <funcsynopsis>
        <funcprototype>
  	<funcdef>int <function>ioctl</function></funcdef>
  	<paramdef>int <parameter>fd</parameter></paramdef>
  	<paramdef>int <parameter>request</parameter></paramdef>
  	<paramdef>const int *<parameter>argp</parameter></paramdef>
        </funcprototype>
      </funcsynopsis>
    </refsynopsisdiv>
  
    <refsect1>
      <title>Arguments</title>
  
      <variablelist>
        <varlistentry>
  	<term><parameter>fd</parameter></term>
  	<listitem>
  	  <para>&fd;</para>
  	</listitem>
        </varlistentry>
        <varlistentry>
  	<term><parameter>request</parameter></term>
  	<listitem>
  	  <para>VIDIOC_OVERLAY</para>
  	</listitem>
        </varlistentry>
        <varlistentry>
  	<term><parameter>argp</parameter></term>
  	<listitem>
  	  <para></para>
  	</listitem>
        </varlistentry>
      </variablelist>
    </refsect1>
  
    <refsect1>
      <title>Description</title>
  
      <para>This ioctl is part of the <link linkend="overlay">video
      overlay</link> I/O method. Applications call
      <constant>VIDIOC_OVERLAY</constant> to start or stop the
      overlay. It takes a pointer to an integer which must be set to
      zero by the application to stop overlay, to one to start.</para>
  
      <para>Drivers do not support &VIDIOC-STREAMON; or
  &VIDIOC-STREAMOFF; with <constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>.</para>
    </refsect1>
  
    <refsect1>
      &return-value;
  
      <variablelist>
        <varlistentry>
  	<term><errorcode>EINVAL</errorcode></term>
  	<listitem>
  	  <para>The overlay parameters have not been set up. See <xref
  linkend="overlay" /> for the necessary steps.</para>
  	</listitem>
        </varlistentry>
      </variablelist>
    </refsect1>
  </refentry>