diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-02-09 19:17:52 -0200 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-02-09 19:17:52 -0200 |
commit | 9287d394a995ecc037b79e502fd8a995c4929f56 (patch) | |
tree | fdd6485423789f7dfec6189cc1260ab00e3cbb31 /v4l2-spec/vidioc-g-input.sgml | |
parent | 803b1cde37f44f2d09bb97bef92d74ead3279578 (diff) | |
parent | 25c9b30402a26393ce698bd1addc01b7973928e2 (diff) | |
download | mediapointer-dvb-s2-9287d394a995ecc037b79e502fd8a995c4929f56.tar.gz mediapointer-dvb-s2-9287d394a995ecc037b79e502fd8a995c4929f56.tar.bz2 |
Bad: author doesn't exist!
Diffstat (limited to 'v4l2-spec/vidioc-g-input.sgml')
-rw-r--r-- | v4l2-spec/vidioc-g-input.sgml | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/v4l2-spec/vidioc-g-input.sgml b/v4l2-spec/vidioc-g-input.sgml new file mode 100644 index 000000000..ed076e927 --- /dev/null +++ b/v4l2-spec/vidioc-g-input.sgml @@ -0,0 +1,100 @@ +<refentry id="vidioc-g-input"> + <refmeta> + <refentrytitle>ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT</refentrytitle> + &manvol; + </refmeta> + + <refnamediv> + <refname>VIDIOC_G_INPUT</refname> + <refname>VIDIOC_S_INPUT</refname> + <refpurpose>Query or select the current video input</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>ioctl</function></funcdef> + <paramdef>int <parameter>fd</parameter></paramdef> + <paramdef>int <parameter>request</parameter></paramdef> + <paramdef>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_G_INPUT, VIDIOC_S_INPUT</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>argp</parameter></term> + <listitem> + <para></para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Description</title> + + <para>To query the current video input applications call the +<constant>VIDIOC_G_INPUT</constant> ioctl with a pointer to an integer +where the driver stores the number of the input, as in the +&v4l2-input; <structfield>index</structfield> field. This ioctl will +fail only when there are no video inputs, returning +<errorcode>EINVAL</errorcode>.</para> + + <para>To select a video input applications store the number of the +desired input in an integer and call the +<constant>VIDIOC_S_INPUT</constant> ioctl with a pointer to this +integer. Side effects are possible. For example inputs may support +different video standards, so the driver may implicitly switch the +current standard. It is good practice to select an input before +querying or negotiating any other parameters.</para> + + <para>Information about video inputs is available using the +&VIDIOC-ENUMINPUT; ioctl.</para> + </refsect1> + + <refsect1> + &return-value; + + <variablelist> + <varlistentry> + <term><errorcode>EINVAL</errorcode></term> + <listitem> + <para>The number of the video input is out of bounds, or +there are no video inputs at all and this ioctl is not +supported.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorcode>EBUSY</errorcode></term> + <listitem> + <para>I/O is in progress, the input cannot be +switched.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- +Local Variables: +mode: sgml +sgml-parent-document: "v4l2.sgml" +indent-tabs-mode: nil +End: +--> |