Documentation/DocBook/media/dvb/fe-get-property.xml

   1 <refentry id="FE_GET_PROPERTY">
   2   <refmeta>
   3     <refentrytitle>ioctl FE_SET_PROPERTY, FE_GET_PROPERTY</refentrytitle>
   4     &manvol;
   5   </refmeta>
   6
   7   <refnamediv>
   8       <refname>FE_SET_PROPERTY</refname>
   9       <refname>FE_GET_PROPERTY</refname>
  10     <refpurpose>FE_SET_PROPERTY sets one or more frontend properties.
  11         FE_GET_PROPERTY returns one or more frontend properties.</refpurpose>
  12   </refnamediv>
  13
  14   <refsynopsisdiv>
  15     <funcsynopsis>
  16       <funcprototype>
  17         <funcdef>int <function>ioctl</function></funcdef>
  18         <paramdef>int <parameter>fd</parameter></paramdef>
  19         <paramdef>int <parameter>request</parameter></paramdef>
  20         <paramdef>struct dtv_properties *<parameter>argp</parameter></paramdef>
  21       </funcprototype>
  22     </funcsynopsis>
  23   </refsynopsisdiv>
  24
  25   <refsect1>
  26     <title>Arguments</title>
  27         <variablelist>
  28       <varlistentry>
  29         <term><parameter>fd</parameter></term>
  30         <listitem>
  31           <para>&fe_fd;</para>
  32         </listitem>
  33       </varlistentry>
  34       <varlistentry>
  35         <term><parameter>request</parameter></term>
  36         <listitem>
  37           <para>FE_SET_PROPERTY, FE_GET_PROPERTY</para>
  38         </listitem>
  39       </varlistentry>
  40       <varlistentry>
  41         <term><parameter>argp</parameter></term>
  42         <listitem>
  43             <para>pointer to &dtv-properties;</para>
  44         </listitem>
  45       </varlistentry>
  46     </variablelist>
  47   </refsect1>
  48
  49   <refsect1>
  50     <title>Description</title>
  51
  52     <para>All DVB frontend devices support the
  53 <constant>FE_SET_PROPERTY</constant> and <constant>FE_GET_PROPERTY</constant>
  54 ioctls. The supported properties and statistics depends on the delivery system
  55 and on the device:</para>
  56 <itemizedlist>
  57 <listitem>
  58     <para><constant>FE_SET_PROPERTY:</constant></para>
  59 <itemizedlist>
  60 <listitem><para>This ioctl is used to set one or more
  61         frontend properties.</para></listitem>
  62 <listitem><para>This is the basic command to request the frontend to tune into some
  63     frequency and to start decoding the digital TV signal.</para></listitem>
  64 <listitem><para>This call requires read/write access to the device.</para></listitem>
  65 <listitem><para>At return, the values are updated to reflect the
  66     actual parameters used.</para></listitem>
  67 </itemizedlist>
  68 </listitem>
  69 <listitem>
  70     <para><constant>FE_GET_PROPERTY:</constant></para>
  71 <itemizedlist>
  72 <listitem><para>This ioctl is used to get properties and
  73 statistics from the frontend.</para></listitem>
  74 <listitem><para>No properties are changed, and statistics aren't reset.</para></listitem>
  75 <listitem><para>This call only requires read-only access to the device.</para></listitem>
  76 </itemizedlist>
  77 </listitem>
  78 </itemizedlist>
  79 &return-value-dvb;
  80 </refsect1>
  81 </refentry>