diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-17 11:17:44 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-17 11:17:44 -0300 |
commit | ee117cb21fc99d6d1ef141b62ac07c2c99ed6558 (patch) | |
tree | b3109826151f5b2cacd01a2a78fc51079381fec7 /linux/Documentation/DocBook/v4l/vidioc-g-std.xml | |
parent | 3c34c6c8fa0c2f378cdad415e8f15c0938c28cb8 (diff) | |
parent | 26642526dd562aa77049bb56d5bf9ad64158c767 (diff) | |
download | mediapointer-dvb-s2-ee117cb21fc99d6d1ef141b62ac07c2c99ed6558.tar.gz mediapointer-dvb-s2-ee117cb21fc99d6d1ef141b62ac07c2c99ed6558.tar.bz2 |
merge: http://kernellabs.com/hg/~mkrufky/saa7164
From: Mauro Carvalho Chehab <mchehab@redhat.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'linux/Documentation/DocBook/v4l/vidioc-g-std.xml')
-rw-r--r-- | linux/Documentation/DocBook/v4l/vidioc-g-std.xml | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/linux/Documentation/DocBook/v4l/vidioc-g-std.xml b/linux/Documentation/DocBook/v4l/vidioc-g-std.xml new file mode 100644 index 000000000..b6f5d267e --- /dev/null +++ b/linux/Documentation/DocBook/v4l/vidioc-g-std.xml @@ -0,0 +1,99 @@ +<refentry id="vidioc-g-std"> + <refmeta> + <refentrytitle>ioctl VIDIOC_G_STD, VIDIOC_S_STD</refentrytitle> + &manvol; + </refmeta> + + <refnamediv> + <refname>VIDIOC_G_STD</refname> + <refname>VIDIOC_S_STD</refname> + <refpurpose>Query or select the video standard of the current 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>v4l2_std_id +*<parameter>argp</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>ioctl</function></funcdef> + <paramdef>int <parameter>fd</parameter></paramdef> + <paramdef>int <parameter>request</parameter></paramdef> + <paramdef>const v4l2_std_id +*<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_STD, VIDIOC_S_STD</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>argp</parameter></term> + <listitem> + <para></para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Description</title> + + <para>To query and select the current video standard applications +use the <constant>VIDIOC_G_STD</constant> and <constant>VIDIOC_S_STD</constant> ioctls which take a pointer to a +&v4l2-std-id; type as argument. <constant>VIDIOC_G_STD</constant> can +return a single flag or a set of flags as in &v4l2-standard; field +<structfield>id</structfield>. The flags must be unambiguous such +that they appear in only one enumerated <structname>v4l2_standard</structname> structure.</para> + + <para><constant>VIDIOC_S_STD</constant> accepts one or more +flags, being a write-only ioctl it does not return the actual new standard as +<constant>VIDIOC_G_STD</constant> does. When no flags are given or +the current input does not support the requested standard the driver +returns an &EINVAL;. When the standard set is ambiguous drivers may +return <errorcode>EINVAL</errorcode> or choose any of the requested +standards.</para> + </refsect1> + + <refsect1> + &return-value; + + <variablelist> + <varlistentry> + <term><errorcode>EINVAL</errorcode></term> + <listitem> + <para>This ioctl is not supported, or the +<constant>VIDIOC_S_STD</constant> parameter was unsuitable.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- +Local Variables: +mode: sgml +sgml-parent-document: "v4l2.sgml" +indent-tabs-mode: nil +End: +--> |