1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="LINUX MEDIA INFRASTRUCTURE API"><link rel="up" href="user-func.html" title="Appendix&#160;A.&#160;Function Reference"><link rel="prev" href="vidioc-g-parm.html" title="ioctl VIDIOC_G_PARM, VIDIOC_S_PARM"><link rel="next" href="vidioc-g-selection.html" title="ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="vidioc-g-parm.html">Prev</a>&#160;</td><th width="60%" align="center">Appendix&#160;A.&#160;Function Reference</th><td width="20%" align="right">&#160;<a accesskey="n" href="vidioc-g-selection.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="vidioc-g-priority"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY &#8212; Query or request the access priority associated with a
2file descriptor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">ioctl</b>(</code></td><td>int <var class="pdparam">fd</var>, </td></tr><tr><td>&#160;</td><td>int <var class="pdparam">request</var>, </td></tr><tr><td>&#160;</td><td>enum v4l2_priority *<var class="pdparam">argp</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">ioctl</b>(</code></td><td>int <var class="pdparam">fd</var>, </td></tr><tr><td>&#160;</td><td>int <var class="pdparam">request</var>, </td></tr><tr><td>&#160;</td><td>const enum v4l2_priority *<var class="pdparam">argp</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a name="idp1115035340"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>fd</code></em></span></dt><dd><p>File descriptor returned by <a class="link" href="func-open.html" title="V4L2 open()"><code class="function">open()</code></a>.</p></dd><dt><span class="term"><em class="parameter"><code>request</code></em></span></dt><dd><p>VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY</p></dd><dt><span class="term"><em class="parameter"><code>argp</code></em></span></dt><dd><p>Pointer to an enum v4l2_priority type.</p></dd></dl></div></div><div class="refsect1"><a name="idp1115039524"></a><h2>Description</h2><p>To query the current access priority
3applications call the <code class="constant">VIDIOC_G_PRIORITY</code> ioctl
4with a pointer to an enum v4l2_priority variable where the driver stores
5the current priority.</p><p>To request an access priority applications store the
6desired priority in an enum v4l2_priority variable and call
7<code class="constant">VIDIOC_S_PRIORITY</code> ioctl with a pointer to this
8variable.</p><div class="table"><a name="v4l2-priority"></a><p class="title"><b>Table&#160;A.83.&#160;enum v4l2_priority</b></p><div class="table-contents"><table summary="enum v4l2_priority" width="100%" border="0"><colgroup><col class="c1"><col class="c2"><col class="c3"></colgroup><tbody valign="top"><tr><td valign="top"><code class="constant">V4L2_PRIORITY_UNSET</code></td><td valign="top">0</td><td valign="top">&#160;</td></tr><tr><td valign="top"><code class="constant">V4L2_PRIORITY_BACKGROUND</code></td><td valign="top">1</td><td valign="top">Lowest priority, usually applications running in
9background, for example monitoring VBI transmissions. A proxy
10application running in user space will be necessary if multiple
11applications want to read from a device at this priority.</td></tr><tr><td valign="top"><code class="constant">V4L2_PRIORITY_INTERACTIVE</code></td><td valign="top">2</td><td valign="top">&#160;</td></tr><tr><td valign="top"><code class="constant">V4L2_PRIORITY_DEFAULT</code></td><td valign="top">2</td><td valign="top">Medium priority, usually applications started and
12interactively controlled by the user. For example TV viewers, Teletext
13browsers, or just "panel" applications to change the channel or video
14controls. This is the default priority unless an application requests
15another.</td></tr><tr><td valign="top"><code class="constant">V4L2_PRIORITY_RECORD</code></td><td valign="top">3</td><td valign="top">Highest priority. Only one file descriptor can have
16this priority, it blocks any other fd from changing device properties.
17Usually applications which must not be interrupted, like video
18recording.</td></tr></tbody></table></div></div><br class="table-break"></div><div class="refsect1"><a name="idp1115049076"></a><h2>Return Value</h2><p>On success <span class="returnvalue">0</span> is returned, on error <span class="returnvalue">-1</span> and the <code class="varname">errno</code> variable is set appropriately. The generic error codes are described at the <a class="link" href="gen_errors.html#gen-errors" title="Table&#160;19.1.&#160;Generic error codes">Generic Error Codes</a> chapter.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="errorcode">EINVAL</span></span></dt><dd><p>The requested priority value is invalid.</p></dd><dt><span class="term"><span class="errorcode">EBUSY</span></span></dt><dd><p>Another application already requested higher
19priority.</p></dd></dl></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="vidioc-g-parm.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="user-func.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="vidioc-g-selection.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">ioctl VIDIOC_G_PARM, VIDIOC_S_PARM&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION</td></tr></table></div></body></html>
20