1 <refentry id=
"vidioc-s-hw-freq-seek">
3 <refentrytitle>ioctl VIDIOC_S_HW_FREQ_SEEK
</refentrytitle>
8 <refname>VIDIOC_S_HW_FREQ_SEEK
</refname>
9 <refpurpose>Perform a hardware frequency seek
</refpurpose>
15 <funcdef>int
<function>ioctl
</function></funcdef>
16 <paramdef>int
<parameter>fd
</parameter></paramdef>
17 <paramdef>int
<parameter>request
</parameter></paramdef>
18 <paramdef>struct v4l2_hw_freq_seek
19 *
<parameter>argp
</parameter></paramdef>
25 <title>Arguments
</title>
29 <term><parameter>fd
</parameter></term>
35 <term><parameter>request
</parameter></term>
37 <para>VIDIOC_S_HW_FREQ_SEEK
</para>
41 <term><parameter>argp
</parameter></term>
50 <title>Description
</title>
52 <para>Start a hardware frequency seek from the current frequency.
53 To do this applications initialize the
<structfield>tuner
</structfield>,
54 <structfield>type
</structfield>,
<structfield>seek_upward
</structfield>,
55 <structfield>spacing
</structfield> and
56 <structfield>wrap_around
</structfield> fields, and zero out the
57 <structfield>reserved
</structfield> array of a &v4l2-hw-freq-seek; and
58 call the
<constant>VIDIOC_S_HW_FREQ_SEEK
</constant> ioctl with a pointer
59 to this structure.
</para>
61 <para>This ioctl is supported if the
<constant>V4L2_CAP_HW_FREQ_SEEK
</constant> capability is set.
</para>
63 <table pgwide=
"1" frame=
"none" id=
"v4l2-hw-freq-seek">
64 <title>struct
<structname>v4l2_hw_freq_seek
</structname></title>
70 <entry><structfield>tuner
</structfield></entry>
71 <entry>The tuner index number. This is the
72 same value as in the &v4l2-input;
<structfield>tuner
</structfield>
73 field and the &v4l2-tuner;
<structfield>index
</structfield> field.
</entry>
76 <entry>&v4l2-tuner-type;
</entry>
77 <entry><structfield>type
</structfield></entry>
78 <entry>The tuner type. This is the same value as in the
79 &v4l2-tuner;
<structfield>type
</structfield> field.
</entry>
83 <entry><structfield>seek_upward
</structfield></entry>
84 <entry>If non-zero, seek upward from the current frequency, else seek downward.
</entry>
88 <entry><structfield>wrap_around
</structfield></entry>
89 <entry>If non-zero, wrap around when at the end of the frequency range, else stop seeking.
</entry>
93 <entry><structfield>spacing
</structfield></entry>
94 <entry>If non-zero, defines the hardware seek resolution in Hz. The driver selects the nearest value that is supported by the device. If spacing is zero a reasonable default value is used.
</entry>
98 <entry><structfield>reserved
</structfield>[
7]
</entry>
99 <entry>Reserved for future extensions. Drivers and
100 applications must set the array to zero.
</entry>
112 <term><errorcode>EINVAL
</errorcode></term>
114 <para>The
<structfield>tuner
</structfield> index is out of
115 bounds or the value in the
<structfield>type
</structfield> field is
120 <term><errorcode>EAGAIN
</errorcode></term>
122 <para>The ioctl timed-out. Try again.
</para>
132 sgml-parent-document: "v4l2.sgml"
133 indent-tabs-mode: nil