AUDIO_BILINGUAL_CHANNEL_SELECT
==============================
-NAME
+Name
----
AUDIO_BILINGUAL_CHANNEL_SELECT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Select the output format of the audio (mono left/right, stereo).
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. It has been replaced
for bilingual streams if possible.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_CHANNEL_SELECT
====================
-NAME
+Name
----
AUDIO_CHANNEL_SELECT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Select the output format of the audio (mono left/right, stereo).
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
possible.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_CLEAR_BUFFER
==================
-NAME
+Name
----
AUDIO_CLEAR_BUFFER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals AUDIO_CLEAR_BUFFER for this command.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to clear all software and hardware
buffers of the audio decoder device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_CONTINUE
==============
-NAME
+Name
----
AUDIO_CONTINUE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals AUDIO_CONTINUE for this command.
-DESCRIPTION
+Description
-----------
This ioctl restarts the decoding and playing process previously paused
with AUDIO_PAUSE command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DVB audio close()
=================
-NAME
+Name
----
DVB audio close()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call closes a previously opened audio device.
-RETURN VALUE
+Return Value
------------
.. flat-table::
DVB audio open()
================
-NAME
+Name
----
DVB audio open()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call opens a named audio device (e.g.
AUDIO_GET_STATUS. All other call will return with an error code.
-RETURN VALUE
+Return Value
------------
.. flat-table::
DVB audio write()
=================
-NAME
+Name
----
DVB audio write()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call can only be used if AUDIO_SOURCE_MEMORY is selected
implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
AUDIO_GET_CAPABILITIES
======================
-NAME
+Name
----
AUDIO_GET_CAPABILITIES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Returns a bit array of supported sound formats.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to tell us about the decoding
capabilities of the audio hardware.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_GET_PTS
=============
-NAME
+Name
----
AUDIO_GET_PTS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
-ARGUMENTS
+Arguments
---------
.. flat-table::
decoded frame or the last PTS extracted by the PES parser.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. If you need this
timestamp.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_GET_STATUS
================
-NAME
+Name
----
AUDIO_GET_STATUS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Returns the current state of Audio Device.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to return the current state of the
Audio Device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_PAUSE
===========
-NAME
+Name
----
AUDIO_PAUSE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals AUDIO_PAUSE for this command.
-DESCRIPTION
+Description
-----------
This ioctl call suspends the audio stream being played. Decoding and
playing process of the audio stream using AUDIO_CONTINUE command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_PLAY
==========
-NAME
+Name
----
AUDIO_PLAY
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals AUDIO_PLAY for this command.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to start playing an audio stream
from the selected source.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SELECT_SOURCE
===================
-NAME
+Name
----
AUDIO_SELECT_SOURCE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Indicates the source that shall be used for the Audio stream.
-DESCRIPTION
+Description
-----------
This ioctl call informs the audio device which source shall be used for
through the write command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_ATTRIBUTES
====================
-NAME
+Name
----
AUDIO_SET_ATTRIBUTES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
-ARGUMENTS
+Arguments
---------
.. flat-table::
- audio attributes according to section ??
-DESCRIPTION
+Description
-----------
This ioctl is intended for DVD playback and allows you to set certain
information about the audio stream.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_AV_SYNC
=================
-NAME
+Name
----
AUDIO_SET_AV_SYNC
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- FALSE AV-sync OFF
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to turn ON or OFF A/V
synchronization.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_BYPASS_MODE
=====================
-NAME
+Name
----
AUDIO_SET_BYPASS_MODE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- FALSE Bypass is enabled
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to bypass the Audio decoder and
the hardware can handle it.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_EXT_ID
================
-NAME
+Name
----
AUDIO_SET_EXT_ID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- audio sub_stream_id
-DESCRIPTION
+Description
-----------
This ioctl can be used to set the extension id for MPEG streams in DVD
playback. Only the first 3 bits are recognized.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_ID
============
-NAME
+Name
----
AUDIO_SET_ID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- audio sub-stream id
-DESCRIPTION
+Description
-----------
This ioctl selects which sub-stream is to be decoded if a program or
recognized.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_KARAOKE
=================
-NAME
+Name
----
AUDIO_SET_KARAOKE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- karaoke settings according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl allows one to set the mixer settings for a karaoke DVD.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_MIXER
===============
-NAME
+Name
----
AUDIO_SET_MIXER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- mixer settings.
-DESCRIPTION
+Description
-----------
This ioctl lets you adjust the mixer settings of the audio decoder.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_MUTE
==============
-NAME
+Name
----
AUDIO_SET_MUTE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- FALSE Audio Un-mute
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
currently being played.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_SET_STREAMTYPE
====================
-NAME
+Name
----
AUDIO_SET_STREAMTYPE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- stream type
-DESCRIPTION
+Description
-----------
This ioctl tells the driver which kind of audio stream to expect. This
AC3.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
AUDIO_STOP
==========
-NAME
+Name
----
AUDIO_STOP
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals AUDIO_STOP for this command.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to stop playing the current
stream.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DVB CA close()
==============
-NAME
+Name
----
DVB CA close()
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call closes a previously opened audio device.
-RETURN VALUE
+Return Value
------------
.. flat-table::
DVB CA open()
=============
-NAME
+Name
----
DVB CA open()
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call opens a named ca device (e.g. /dev/ost/ca) for
the device in this mode will fail, and an error code will be returned.
-RETURN VALUE
+Return Value
------------
.. flat-table::
CA_GET_CAP
==========
-NAME
+Name
----
CA_GET_CAP
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
CA_GET_DESCR_INFO
=================
-NAME
+Name
----
CA_GET_DESCR_INFO
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
CA_GET_MSG
==========
-NAME
+Name
----
CA_GET_MSG
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
CA_GET_SLOT_INFO
================
-NAME
+Name
----
CA_GET_SLOT_INFO
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
CA_RESET
========
-NAME
+Name
----
CA_RESET
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_RESET)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals CA_RESET for this command.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
CA_SEND_MSG
===========
-NAME
+Name
----
CA_SEND_MSG
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
CA_SET_DESCR
============
-NAME
+Name
----
CA_SET_DESCR
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
CA_SET_PID
==========
-NAME
+Name
----
CA_SET_PID
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_ADD_PID
===========
-NAME
+Name
----
DMX_ADD_PID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- PID number to be filtered.
-DESCRIPTION
+Description
-----------
This ioctl call allows to add multiple PIDs to a transport stream filter
DMX_OUT_TSDEMUX_TAP.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DVB demux close()
=================
-NAME
+Name
----
DVB demux close()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call deactivates and deallocates a filter that was
previously allocated via the open() call.
-RETURN VALUE
+Return Value
------------
.. flat-table::
DVB demux open()
================
-NAME
+Name
----
DVB demux open()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call, used with a device name of /dev/dvb/adapter0/demux0,
using the F_SETFL command of the fcntl system call.
-RETURN VALUE
+Return Value
------------
.. flat-table::
DVB demux read()
================
-NAME
+Name
----
DVB demux read()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: size_t read(int fd, void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call returns filtered data, which might be section or PES
implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
DVB demux write()
=================
-NAME
+Name
----
DVB demux write()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call is only provided by the logical device
The amount of data to be transferred is implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
DMX_GET_CAPS
============
-NAME
+Name
----
DMX_GET_CAPS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_GET_EVENT
=============
-NAME
+Name
----
DMX_GET_EVENT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Pointer to the location where the event is to be stored.
-DESCRIPTION
+Description
-----------
This ioctl call returns an event if available. If an event is not
event becomes available.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_GET_PES_PIDS
================
-NAME
+Name
----
DMX_GET_PES_PIDS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_GET_STC
===========
-NAME
+Name
----
DMX_GET_STC
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Pointer to the location where the stc is to be stored.
-DESCRIPTION
+Description
-----------
This ioctl call returns the current value of the system time counter
the real 90kHz STC value is stc->stc / stc->base .
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_REMOVE_PID
==============
-NAME
+Name
----
DMX_REMOVE_PID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- PID of the PES filter to be removed.
-DESCRIPTION
+Description
-----------
This ioctl call allows to remove a PID when multiple PIDs are set on a
DMX_SET_PES_FILTER or DMX_ADD_PID.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_SET_BUFFER_SIZE
===================
-NAME
+Name
----
DMX_SET_BUFFER_SIZE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Size of circular buffer.
-DESCRIPTION
+Description
-----------
This ioctl call is used to set the size of the circular buffer used for
used.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_SET_FILTER
==============
-NAME
+Name
----
DMX_SET_FILTER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Pointer to structure containing filter parameters.
-DESCRIPTION
+Description
-----------
This ioctl call sets up a filter according to the filter and mask
will be canceled, and the receive buffer will be flushed.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_SET_PES_FILTER
==================
-NAME
+Name
----
DMX_SET_PES_FILTER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Pointer to structure containing filter parameters.
-DESCRIPTION
+Description
-----------
This ioctl call sets up a PES filter according to the parameters
capability is supported.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_SET_SOURCE
==============
-NAME
+Name
----
DMX_SET_SOURCE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_START
=========
-NAME
+Name
----
DMX_START
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_START)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals DMX_START for this command.
-DESCRIPTION
+Description
-----------
This ioctl call is used to start the actual filtering operation defined
via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
DMX_STOP
========
-NAME
+Name
----
DMX_STOP
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_STOP)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals DMX_STOP for this command.
-DESCRIPTION
+Description
-----------
This ioctl call is used to stop the actual filtering operation defined
started via the DMX_START command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_DISEQC_RECV_SLAVE_REPLY
********************************
-NAME
+Name
====
FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp )
-ARGUMENTS
+Arguments
=========
``fd``
:ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
-DESCRIPTION
+Description
===========
Receives reply from a DiSEqC 2.0 command.
- Return from ioctl after timeout ms with errorcode when no message
was received
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_DISEQC_RESET_OVERLOAD
******************************
-NAME
+Name
====
FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it was powered off due - to power overload.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, NULL )
-ARGUMENTS
+Arguments
=========
``fd``
FE_DISEQC_RESET_OVERLOAD
-DESCRIPTION
+Description
===========
If the bus has been automatically powered off due to power overload,
is manually powered off. Not all DVB adapters support this ioctl.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_DISEQC_SEND_BURST
**************************
-NAME
+Name
====
FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
-ARGUMENTS
+Arguments
=========
``fd``
pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>`
-DESCRIPTION
+Description
===========
This ioctl is used to set the generation of a 22kHz tone burst for mini
- Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_DISEQC_SEND_MASTER_CMD
*******************************
-NAME
+Name
====
FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp )
-ARGUMENTS
+Arguments
=========
``fd``
:ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>`
-DESCRIPTION
+Description
===========
Sends a DiSEqC command to the antenna subsystem.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
FE_DISHNETWORK_SEND_LEGACY_CMD
******************************
-NAME
+Name
====
FE_DISHNETWORK_SEND_LEGACY_CMD
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
-ARGUMENTS
+Arguments
=========
.. flat-table::
- sends the specified raw cmd to the dish via DISEqC.
-DESCRIPTION
+Description
===========
WARNING: This is a very obscure legacy command, used only at stv0299
dishes were already legacy in 2004.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_ENABLE_HIGH_LNB_VOLTAGE
********************************
-NAME
+Name
====
FE_ENABLE_HIGH_LNB_VOLTAGE - Select output DC level between normal LNBf voltages or higher LNBf - voltages.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int high )
-ARGUMENTS
+Arguments
=========
``fd``
to compensate for long antenna cables.
-DESCRIPTION
+Description
===========
Select output DC level between normal LNBf voltages or higher LNBf
voltages.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
FE_GET_EVENT
************
-NAME
+Name
====
FE_GET_EVENT
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
-ARGUMENTS
+Arguments
=========
.. flat-table::
- if any, is to be stored.
-DESCRIPTION
+Description
===========
This ioctl call returns a frontend event if available. If an event is
an event becomes available.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
FE_GET_FRONTEND
***************
-NAME
+Name
====
FE_GET_FRONTEND
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
-ARGUMENTS
+Arguments
=========
.. flat-table::
- Points to parameters for tuning operation.
-DESCRIPTION
+Description
===========
This ioctl call queries the currently effective frontend parameters. For
this command, read-only access to the device is sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_GET_INFO
*****************
-NAME
+Name
====
FE_GET_INFO - Query DVB frontend capabilities and returns information about the - front-end. This call only requires read-only access to the device
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
-ARGUMENTS
+Arguments
=========
``fd``
:ref:`dvb_frontend_info <dvb-frontend-info>`
-DESCRIPTION
+Description
===========
All DVB frontend devices support the ``FE_GET_INFO`` ioctl. It is used
- The frontend can stop spurious TS data output
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_SET_PROPERTY, FE_GET_PROPERTY
**************************************
-NAME
+Name
====
FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend properties. - FE_GET_PROPERTY returns one or more frontend properties.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
-ARGUMENTS
+Arguments
=========
``fd``
pointer to struct :ref:`dtv_properties <dtv-properties>`
-DESCRIPTION
+Description
===========
All DVB frontend devices support the ``FE_SET_PROPERTY`` and
- This call only requires read-only access to the device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
FE_READ_BER
***********
-Description
------------
+Name
+====
-This ioctl call returns the bit error rate for the signal currently
-received/demodulated by the front-end. For this command, read-only
-access to the device is sufficient.
+FE_READ_BER
-SYNOPSIS
+Synopsis
+========
.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
+
Arguments
-----------
+=========
.. flat-table::
:header-rows: 0
- The bit error rate is stored into \*ber.
+Description
+===========
+
+This ioctl call returns the bit error rate for the signal currently
+received/demodulated by the front-end. For this command, read-only
+access to the device is sufficient.
+
+
Return Value
-------------
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
FE_READ_SIGNAL_STRENGTH
***********************
-NAME
+Name
====
FE_READ_SIGNAL_STRENGTH
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
-ARGUMENTS
+Arguments
=========
.. flat-table::
- The signal strength value is stored into \*strength.
-DESCRIPTION
+Description
===========
This ioctl call returns the signal strength value for the signal
to the device is sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
FE_READ_SNR
***********
-NAME
+Name
====
FE_READ_SNR
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
-ARGUMENTS
+Arguments
=========
.. flat-table::
- The signal-to-noise ratio is stored into \*snr.
-DESCRIPTION
+Description
===========
This ioctl call returns the signal-to-noise ratio for the signal
to the device is sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_READ_STATUS
********************
-NAME
+Name
====
FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int *status )
-ARGUMENTS
+Arguments
=========
``fd``
:ref:`fe_status <fe-status>`.
-DESCRIPTION
+Description
===========
All DVB frontend devices support the ``FE_READ_STATUS`` ioctl. It is
- The frontend was reinitialized, application is recommended to
reset DiSEqC, tone and parameters
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
FE_READ_UNCORRECTED_BLOCKS
**************************
-NAME
+Name
====
FE_READ_UNCORRECTED_BLOCKS
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
-ARGUMENTS
+Arguments
=========
.. flat-table::
- The total number of uncorrected blocks seen by the driver so far.
-DESCRIPTION
+Description
===========
This ioctl call returns the number of uncorrected blocks detected by the
sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_SET_FRONTEND_TUNE_MODE
*******************************
-NAME
+Name
====
FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int flags )
-ARGUMENTS
+Arguments
=========
``fd``
device is reopened read-write.
-DESCRIPTION
+Description
===========
Allow setting tuner mode flags to the frontend, between 0 (normal) or
FE_TUNE_MODE_ONESHOT mode
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
FE_SET_FRONTEND
***************
-NAME
+Name
====
FE_SET_FRONTEND
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
-ARGUMENTS
+Arguments
=========
.. flat-table::
- Points to parameters for tuning operation.
-DESCRIPTION
+Description
===========
This ioctl call starts a tuning operation using specified parameters.
requires read/write access to the device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_SET_TONE
*****************
-NAME
+Name
====
FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_tone_mode *tone )
-ARGUMENTS
+Arguments
=========
``fd``
pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>`
-DESCRIPTION
+Description
===========
This ioctl is used to set the generation of the continuous 22kHz tone.
- Don't send a 22kHz tone to the antenna (except if the
FE_DISEQC_* ioctls are called)
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl FE_SET_VOLTAGE
********************
-NAME
+Name
====
FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem.
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
-ARGUMENTS
+Arguments
=========
``fd``
:ref:`fe_sec_voltage <fe-sec-voltage>`.
-DESCRIPTION
+Description
===========
This ioctl allows to set the DC voltage level sent through the antenna
recommended.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
DVB frontend close()
********************
-NAME
+Name
====
fe-close - Close a frontend device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int close( int fd )
-ARGUMENTS
+Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-DESCRIPTION
+Description
===========
This system call closes a previously opened front-end device. After
down automatically.
-RETURN VALUE
+Return Value
============
The function returns 0 on success, -1 on failure and the ``errno`` is
DVB frontend open()
*******************
-NAME
+Name
====
fe-open - Open a frontend device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int open( const char *device_name, int flags )
-ARGUMENTS
+Arguments
=========
``device_name``
Other flags have no effect.
-DESCRIPTION
+Description
===========
This system call opens a named frontend device
that possible.
-RETURN VALUE
+Return Value
============
On success :ref:`open() <frontend_f_open>` returns the new file descriptor.
ioctl NET_ADD_IF
****************
-NAME
+Name
====
NET_ADD_IF - Creates a new network interface for a given Packet ID.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-ARGUMENTS
+Arguments
=========
``fd``
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-DESCRIPTION
+Description
===========
The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl NET_GET_IF
****************
-NAME
+Name
====
NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-ARGUMENTS
+Arguments
=========
``fd``
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-DESCRIPTION
+Description
===========
The NET_GET_IF ioctl uses the interface number given by the struct
the ``errno`` with ``EINVAL`` error code.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl NET_REMOVE_IF
*******************
-NAME
+Name
====
NET_REMOVE_IF - Removes a network interface.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, int ifnum )
-ARGUMENTS
+Arguments
=========
``fd``
number of the interface to be removed
-DESCRIPTION
+Description
===========
The NET_REMOVE_IF ioctl deletes an interface previously created via
:ref:`NET_ADD_IF <net>`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_CLEAR_BUFFER
==================
-NAME
+Name
----
VIDEO_CLEAR_BUFFER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals VIDEO_CLEAR_BUFFER for this command.
-DESCRIPTION
+Description
-----------
This ioctl call clears all video buffers in the driver and in the
decoder hardware.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_COMMAND
=============
-NAME
+Name
----
VIDEO_COMMAND
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Commands the decoder.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
more information.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_CONTINUE
==============
-NAME
+Name
----
VIDEO_CONTINUE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals VIDEO_CONTINUE for this command.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
stream which was played before a call to VIDEO_FREEZE was made.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_FAST_FORWARD
==================
-NAME
+Name
----
VIDEO_FAST_FORWARD
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- The number of frames to skip.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to skip decoding of N number of
selected.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
dvb video close()
=================
-NAME
+Name
----
dvb video close()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call closes a previously opened video device.
-RETURN VALUE
+Return Value
------------
.. flat-table::
dvb video open()
================
-NAME
+Name
----
dvb video open()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call opens a named video device (e.g.
return an error code.
-RETURN VALUE
+Return Value
------------
.. flat-table::
VIDEO_FREEZE
============
-NAME
+Name
----
VIDEO_FREEZE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals VIDEO_FREEZE for this command.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
dvb video write()
=================
-NAME
+Name
----
dvb video write()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call can only be used if VIDEO_SOURCE_MEMORY is selected
available. The amount of data to be transferred is implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
VIDEO_GET_CAPABILITIES
======================
-NAME
+Name
----
VIDEO_GET_CAPABILITIES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Pointer to a location where to store the capability information.
-DESCRIPTION
+Description
-----------
This ioctl call asks the video device about its decoding capabilities.
defines in section ??.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_GET_EVENT
===============
-NAME
+Name
----
VIDEO_GET_EVENT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Points to the location where the event, if any, is to be stored.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To get events from a V4L2 decoder
for this ioctl call.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_GET_FRAME_COUNT
=====================
-NAME
+Name
----
VIDEO_GET_FRAME_COUNT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
-ARGUMENTS
+Arguments
---------
.. flat-table::
started.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
frames since the decoder was started.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_GET_FRAME_RATE
====================
-NAME
+Name
----
VIDEO_GET_FRAME_RATE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Returns the framerate in number of frames per 1000 seconds.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to return the current framerate.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_GET_NAVI
==============
-NAME
+Name
----
VIDEO_GET_NAVI
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- PCI or DSI pack (private stream 2) according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl returns navigational information from the DVD stream. This is
hardware.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_GET_PTS
=============
-NAME
+Name
----
VIDEO_GET_PTS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
-ARGUMENTS
+Arguments
---------
.. flat-table::
decoded frame or the last PTS extracted by the PES parser.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
timestamp.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_GET_SIZE
==============
-NAME
+Name
----
VIDEO_GET_SIZE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Returns the size and aspect ratio.
-DESCRIPTION
+Description
-----------
This ioctl returns the size and aspect ratio.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_GET_STATUS
================
-NAME
+Name
----
VIDEO_GET_STATUS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Returns the current status of the Video Device.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to return the current status of
the device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_PLAY
==========
-NAME
+Name
----
VIDEO_PLAY
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Equals VIDEO_PLAY for this command.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
from the selected source.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SELECT_SOURCE
===================
-NAME
+Name
----
VIDEO_SELECT_SOURCE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Indicates which source shall be used for the Video stream.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. This ioctl was also supported by the
selected, the data is fed to the video device through the write command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_ATTRIBUTES
====================
-NAME
+Name
----
VIDEO_SET_ATTRIBUTES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- video attributes according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl is intended for DVD playback and allows you to set certain
playback.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_BLANK
===============
-NAME
+Name
----
VIDEO_SET_BLANK
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- FALSE: Show last decoded frame.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to blank out the picture.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_DISPLAY_FORMAT
========================
-NAME
+Name
----
VIDEO_SET_DISPLAY_FORMAT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Selects the video format to be used.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to select the video format to be
applied by the MPEG chip on the video.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_FORMAT
================
-NAME
+Name
----
VIDEO_SET_FORMAT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- video format of TV as defined in section ??.
-DESCRIPTION
+Description
-----------
This ioctl sets the screen format (aspect ratio) of the connected output
accordingly.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_HIGHLIGHT
===================
-NAME
+Name
----
VIDEO_SET_HIGHLIGHT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- SPU Highlight information according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl sets the SPU highlight information for the menu access of a
DVD.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_ID
============
-NAME
+Name
----
VIDEO_SET_ID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- video sub-stream id
-DESCRIPTION
+Description
-----------
This ioctl selects which sub-stream is to be decoded if a program or
system stream is sent to the video device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_SPU_PALETTE
=====================
-NAME
+Name
----
VIDEO_SET_SPU_PALETTE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
-ARGUMENTS
+Arguments
---------
.. flat-table::
- SPU palette according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl sets the SPU color palette.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_SPU
=============
-NAME
+Name
----
VIDEO_SET_SPU
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
-ARGUMENTS
+Arguments
---------
.. flat-table::
??.
-DESCRIPTION
+Description
-----------
This ioctl activates or deactivates SPU decoding in a DVD input stream.
It can only be used, if the driver is able to handle a DVD stream.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_STREAMTYPE
====================
-NAME
+Name
----
VIDEO_SET_STREAMTYPE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- stream type
-DESCRIPTION
+Description
-----------
This ioctl tells the driver which kind of stream to expect being written
drivers might not support this call and always expect PES.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SET_SYSTEM
================
-NAME
+Name
----
VIDEO_SET_SYSTEM
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- video system of TV output.
-DESCRIPTION
+Description
-----------
This ioctl sets the television output format. The format (see section
return an error.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_SLOWMOTION
================
-NAME
+Name
----
VIDEO_SLOWMOTION
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- The number of times to repeat each frame.
-DESCRIPTION
+Description
-----------
This ioctl call asks the video device to repeat decoding frames N number
selected.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_STILLPICTURE
==================
-NAME
+Name
----
VIDEO_STILLPICTURE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Pointer to a location where an I-frame and size is stored.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to display a still picture
NULL, then the current displayed still picture is blanked.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_STOP
==========
-NAME
+Name
----
VIDEO_STOP
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- FALSE: Show last decoded frame.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
or displaying the last decoded frame.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
VIDEO_TRY_COMMAND
=================
-NAME
+Name
----
VIDEO_TRY_COMMAND
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
- Try a decoder command.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
for more information.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
media close()
*************
-NAME
+Name
====
media-close - Close a media device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int close( int fd )
-ARGUMENTS
+Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-DESCRIPTION
+Description
===========
Closes the media device. Resources associated with the file descriptor
are freed. The device configuration remain unchanged.
-RETURN VALUE
+Return Value
============
:ref:`close() <func-close>` returns 0 on success. On error, -1 is returned, and
media ioctl()
*************
-NAME
+Name
====
media-ioctl - Control a media device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int ioctl( int fd, int request, void *argp )
-ARGUMENTS
+Arguments
=========
``fd``
Pointer to a request-specific structure.
-DESCRIPTION
+Description
===========
The :ref:`ioctl() <func-ioctl>` function manipulates media device parameters.
:ref:`media-user-func`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
media open()
************
-NAME
+Name
====
media-open - Open a media device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int open( const char *device_name, int flags )
-ARGUMENTS
+Arguments
=========
``device_name``
Other flags have no effect.
-DESCRIPTION
+Description
===========
To open a media device applications call :ref:`open() <func-open>` with the
EBADF.
-RETURN VALUE
+Return Value
============
:ref:`open() <func-open>` returns the new file descriptor on success. On error,
ioctl MEDIA_IOC_DEVICE_INFO
***************************
-NAME
+Name
====
MEDIA_IOC_DEVICE_INFO - Query device information
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_device_info *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
All media devices must support the ``MEDIA_IOC_DEVICE_INFO`` ioctl. To
vary across reboots or device unplug/replug.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl MEDIA_IOC_ENUM_ENTITIES
*****************************
-NAME
+Name
====
MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of an entity, applications set the id field of a
-
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl MEDIA_IOC_ENUM_LINKS
**************************
-NAME
+Name
====
MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_links_enum *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To enumerate pads and/or links for a given entity, applications set the
- Link flags, see :ref:`media-link-flag` for more details.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl MEDIA_IOC_G_TOPOLOGY
**************************
-NAME
+Name
====
MEDIA_IOC_G_TOPOLOGY - Enumerate the graph topology and graph element properties
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_v2_topology *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The typical usage of this ioctl is to call it twice. On the first call,
this array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl MEDIA_IOC_SETUP_LINK
**************************
-NAME
+Name
====
MEDIA_IOC_SETUP_LINK - Modify the properties of a link
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To change link properties applications fill a struct
error code.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
V4L2 close()
************
-NAME
+Name
====
v4l2-close - Close a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int close( int fd )
-ARGUMENTS
+Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-DESCRIPTION
+Description
===========
Closes the device. Any I/O in progress is terminated and resources
remain unchanged.
-RETURN VALUE
+Return Value
============
The function returns 0 on success, -1 on failure and the ``errno`` is
V4L2 ioctl()
************
-NAME
+Name
====
v4l2-ioctl - Program a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int ioctl( int fd, int request, void *argp )
-ARGUMENTS
+Arguments
=========
``fd``
Pointer to a function parameter, usually a structure.
-DESCRIPTION
+Description
===========
The :ref:`ioctl() <func-ioctl>` function is used to program V4L2 devices. The
specified in :ref:`user-func`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
V4L2 mmap()
***********
-NAME
+Name
====
v4l2-mmap - Map device memory into application address space
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset )
-ARGUMENTS
+Arguments
=========
``start``
``mem_offset`` field for the multi-planar API.
-DESCRIPTION
+Description
===========
The :ref:`mmap() <func-mmap>` function asks to map ``length`` bytes starting at
To unmap buffers the :ref:`munmap() <func-munmap>` function is used.
-RETURN VALUE
+Return Value
============
On success :ref:`mmap() <func-mmap>` returns a pointer to the mapped buffer. On
V4L2 munmap()
*************
-NAME
+Name
====
v4l2-munmap - Unmap device memory
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int munmap( void *start, size_t length )
-ARGUMENTS
+Arguments
=========
``start``
multi-planar API.
-DESCRIPTION
+Description
===========
Unmaps a previously with the :ref:`mmap() <func-mmap>` function mapped
buffer and frees it, if possible.
-RETURN VALUE
+Return Value
============
On success :ref:`munmap() <func-munmap>` returns 0, on failure -1 and the
V4L2 open()
***********
-NAME
+Name
====
v4l2-open - Open a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int open( const char *device_name, int flags )
-ARGUMENTS
+Arguments
=========
``device_name``
Other flags have no effect.
-DESCRIPTION
+Description
===========
To open a V4L2 device applications call :ref:`open() <func-open>` with the
undefined state.
-RETURN VALUE
+Return Value
============
On success :ref:`open() <func-open>` returns the new file descriptor. On error
V4L2 poll()
***********
-NAME
+Name
====
v4l2-poll - Wait for some event on a file descriptor
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
-ARGUMENTS
+Arguments
=========
-DESCRIPTION
+Description
===========
With the :ref:`poll() <func-poll>` function applications can suspend execution
For more details see the :ref:`poll() <func-poll>` manual page.
-RETURN VALUE
+Return Value
============
On success, :ref:`poll() <func-poll>` returns the number structures which have
V4L2 read()
***********
-NAME
+Name
====
v4l2-read - Read from a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: ssize_t read( int fd, void *buf, size_t count )
-ARGUMENTS
+Arguments
=========
``fd``
``count``
-DESCRIPTION
+Description
===========
:ref:`read() <func-read>` attempts to read up to ``count`` bytes from file
For minimum requirements see :ref:`devices`.
-RETURN VALUE
+Return Value
============
On success, the number of bytes read is returned. It is not an error if
V4L2 select()
*************
-NAME
+Name
====
v4l2-select - Synchronous I/O multiplexing
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: int select( int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout )
-ARGUMENTS
+Arguments
=========
-DESCRIPTION
+Description
===========
With the :ref:`select() <func-select>` function applications can suspend
For more details see the :ref:`select() <func-select>` manual page.
-RETURN VALUE
+Return Value
============
On success, :ref:`select() <func-select>` returns the number of descriptors
V4L2 write()
************
-NAME
+Name
====
v4l2-write - Write to a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
.. cpp:function:: ssize_t write( int fd, void *buf, size_t count )
-ARGUMENTS
+Arguments
=========
``fd``
``count``
-DESCRIPTION
+Description
===========
:ref:`write() <func-write>` writes up to ``count`` bytes to the device
inserts a blank line instead.
-RETURN VALUE
+Return Value
============
On success, the number of bytes written are returned. Zero indicates
ioctl VIDIOC_CREATE_BUFS
************************
-NAME
+Name
====
VIDIOC_CREATE_BUFS - Create buffers for Memory Mapped or User Pointer or DMA Buffer I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_create_buffers *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
This ioctl is used to create buffers for :ref:`memory mapped <mmap>`
must set the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_CROPCAP
********************
-NAME
+Name
====
VIDIOC_CROPCAP - Information about the video cropping and scaling abilities
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Applications use this function to query the cropping limits, the pixel
- Height of the rectangle, in pixels.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_DBG_G_CHIP_INFO
****************************
-NAME
+Name
====
VIDIOC_DBG_G_CHIP_INFO - Identify the chips on a TV card
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_chip_info *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
**Note**
- Match the nth sub-device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER
**************************************************
-NAME
+Name
====
VIDIOC_DBG_G_REGISTER - VIDIOC_DBG_S_REGISTER - Read or write hardware registers
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_register *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
**Note**
- Match the nth sub-device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
************************************************
-NAME
+Name
====
VIDIOC_DECODER_CMD - VIDIOC_TRY_DECODER_CMD - Execute an decoder command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls control an audio/video (usually MPEG-) decoder.
flags are defined for this command.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_DQEVENT
********************
-NAME
+Name
====
VIDIOC_DQEVENT - Dequeue event
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Dequeue an event from a video device. No input is required for this
decoder.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP
*********************************************************
-NAME
+Name
====
VIDIOC_DV_TIMINGS_CAP - VIDIOC_SUBDEV_DV_TIMINGS_CAP - The capabilities of the Digital Video receiver/transmitter
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the capabilities of the DV receiver/transmitter applications
the standards set in the ``standards`` field.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD
************************************************
-NAME
+Name
====
VIDIOC_ENCODER_CMD - VIDIOC_TRY_ENCODER_CMD - Execute an encoder command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls control an audio/video (usually MPEG-) encoder.
rather than immediately.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS
***********************************************************
-NAME
+Name
====
VIDIOC_ENUM_DV_TIMINGS - VIDIOC_SUBDEV_ENUM_DV_TIMINGS - Enumerate supported Digital Video timings
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
While some DV receivers or transmitters support a wide range of timings,
- The timings.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUM_FMT
*********************
-NAME
+Name
====
VIDIOC_ENUM_FMT - Enumerate image formats
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To enumerate image formats applications initialize the ``type`` and
format instead for better performance.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUM_FRAMEINTERVALS
********************************
-NAME
+Name
====
VIDIOC_ENUM_FRAMEINTERVALS - Enumerate frame intervals
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp )
-ARGUMENTS
+Arguments
=========
``fd``
interval.
-DESCRIPTION
+Description
===========
This ioctl allows applications to enumerate all frame intervals that the
- Step-wise defined frame interval.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUM_FRAMESIZES
****************************
-NAME
+Name
====
VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp )
-ARGUMENTS
+Arguments
=========
``fd``
and height.
-DESCRIPTION
+Description
===========
This ioctl allows applications to enumerate all frame sizes (i. e. width
- Step-wise defined frame size.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUM_FREQ_BANDS
****************************
-NAME
+Name
====
VIDIOC_ENUM_FREQ_BANDS - Enumerate supported frequency bands
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Enumerates the frequency bands that a tuner or modulator supports. To do
- Amplitude Modulation, commonly used for analog radio.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUMAUDIO
**********************
-NAME
+Name
====
VIDIOC_ENUMAUDIO - Enumerate audio inputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of an audio input applications initialize the
:ref:`v4l2_audio <v4l2-audio>`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUMAUDOUT
***********************
-NAME
+Name
====
VIDIOC_ENUMAUDOUT - Enumerate audio outputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of an audio output applications initialize the
:ref:`v4l2_audioout <v4l2-audioout>`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUMINPUT
**********************
-NAME
+Name
====
VIDIOC_ENUMINPUT - Enumerate video inputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_input *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a video input applications initialize the
:ref:`v4l2-selections-common`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUMOUTPUT
***********************
-NAME
+Name
====
VIDIOC_ENUMOUTPUT - Enumerate video outputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a video outputs applications initialize the
:ref:`v4l2-selections-common`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_ENUMSTD
********************
-NAME
+Name
====
VIDIOC_ENUMSTD - Enumerate supported video standards
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_standard *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a video standard, especially a custom (driver
- + 6.5 [8]_
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_EXPBUF
*******************
-NAME
+Name
====
VIDIOC_EXPBUF - Export a buffer as a DMABUF file descriptor.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
************************************
-NAME
+Name
====
VIDIOC_G_AUDIO - VIDIOC_S_AUDIO - Query or select the current audio input and its attributes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the current audio input applications zero out the ``reserved``
- AVL mode is on.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
**************************************
-NAME
+Name
====
VIDIOC_G_AUDOUT - VIDIOC_S_AUDOUT - Query or select the current audio output
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the current audio output applications zero out the ``reserved``
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_CROP, VIDIOC_S_CROP
**********************************
-NAME
+Name
====
VIDIOC_G_CROP - VIDIOC_S_CROP - Get or set the current cropping rectangle
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_crop *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the cropping rectangle size and position applications set the
:ref:`v4l2_cropcap <v4l2-cropcap>` ``bounds`` is used.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL
**********************************
-NAME
+Name
====
VIDIOC_G_CTRL - VIDIOC_S_CTRL - Get or set the value of a control
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_control *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To get the current value of a control applications initialize the ``id``
- New value or current value.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS
**********************************************
-NAME
+Name
====
VIDIOC_G_DV_TIMINGS - VIDIOC_S_DV_TIMINGS - VIDIOC_SUBDEV_G_DV_TIMINGS - VIDIOC_SUBDEV_S_DV_TIMINGS - Get or set DV timings for input or output
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To set DV timings for the input or output, applications use the
``V4L2_IN_CAP_DV_TIMINGS`` flag), then ``ENODATA`` error code is returned.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID
******************************************************************************
-NAME
+Name
====
VIDIOC_G_EDID - VIDIOC_S_EDID - VIDIOC_SUBDEV_G_EDID - VIDIOC_SUBDEV_S_EDID - Get or set the EDID of a video receiver/transmitter
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls can be used to get or set an EDID associated with an input
``blocks`` * 128.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_ENC_INDEX
************************
-NAME
+Name
====
VIDIOC_G_ENC_INDEX - Get meta data about a compressed video stream
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enc_idx *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` ioctl provides meta data about a compressed
type.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS
******************************************************************
-NAME
+Name
====
VIDIOC_G_EXT_CTRLS - VIDIOC_S_EXT_CTRLS - VIDIOC_TRY_EXT_CTRLS - Get or set the value of several controls, try control values
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls allow the caller to get or set multiple controls
described in :ref:`rf-tuner-controls`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF
**********************************
-NAME
+Name
====
VIDIOC_G_FBUF - VIDIOC_S_FBUF - Get or set frame buffer overlay parameters
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_framebuffer *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Applications can use the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl
:ref:`v4l2_window <v4l2-window>` is being used.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
************************************************
-NAME
+Name
====
VIDIOC_G_FMT - VIDIOC_S_FMT - VIDIOC_TRY_FMT - Get or set the data format, try a format
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls are used to negotiate the format of data (typically image
- Place holder for future extensions.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
********************************************
-NAME
+Name
====
VIDIOC_G_FREQUENCY - VIDIOC_S_FREQUENCY - Get or set tuner or modulator radio frequency
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To get the current tuner or modulator radio frequency applications set
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT
************************************
-NAME
+Name
====
VIDIOC_G_INPUT - VIDIOC_S_INPUT - Query or select the current video input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the current video input applications call the
:ref:`VIDIOC_ENUMINPUT` ioctl.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP
******************************************
-NAME
+Name
====
VIDIOC_G_JPEGCOMP - VIDIOC_S_JPEGCOMP
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp )
.. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls are **deprecated**. New drivers and applications should use
- App segment, driver will always use APP0
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR
********************************************
-NAME
+Name
====
VIDIOC_G_MODULATOR - VIDIOC_S_MODULATOR - Get or set modulator attributes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_modulator *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a modulator applications initialize the
- Enable the RDS encoder for a radio FM transmitter.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT
**************************************
-NAME
+Name
====
VIDIOC_G_OUTPUT - VIDIOC_S_OUTPUT - Query or select the current video output
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the current video output applications call the
:ref:`VIDIOC_ENUMOUTPUT` ioctl.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_PARM, VIDIOC_S_PARM
**********************************
-NAME
+Name
====
VIDIOC_G_PARM - VIDIOC_S_PARM - Get or set streaming parameters
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_streamparm *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The current video standard determines a nominal number of frames per
- Capture might only work through the :ref:`read() <func-read>` call.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY
******************************************
-NAME
+Name
====
VIDIOC_G_PRIORITY - VIDIOC_S_PRIORITY - Query or request the access priority associated with a file descriptor
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum v4l2_priority *argp )
.. c:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp )
-ARGUMENTS
+Arguments
=========
``fd``
Pointer to an enum v4l2_priority type.
-DESCRIPTION
+Description
===========
To query the current access priority applications call the
applications which must not be interrupted, like video recording.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
********************************************
-NAME
+Name
====
VIDIOC_G_SELECTION - VIDIOC_S_SELECTION - Get or set one of the selection rectangles
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_selection *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The ioctls are used to query and configure selection rectangles.
this array.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_SLICED_VBI_CAP
*****************************
-NAME
+Name
====
VIDIOC_G_SLICED_VBI_CAP - Query sliced VBI capabilities
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_sliced_vbi_cap *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To find out which data services are supported by a sliced VBI capture or
- :cspan:`2` Set of services applicable to 625 line systems.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_STD, VIDIOC_S_STD
********************************
-NAME
+Name
====
VIDIOC_G_STD - VIDIOC_S_STD - Query or select the video standard of the current input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
.. cpp:function:: int ioctl( int fd, int request, const v4l2_std_id *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query and select the current video standard applications use the
returned.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER
************************************
-NAME
+Name
====
VIDIOC_G_TUNER - VIDIOC_S_TUNER - Get or set tuner attributes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_tuner *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a tuner applications initialize the ``index``
- Lang1/Lang2 (preferred) or Lang1/Lang1
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_LOG_STATUS
***********************
-NAME
+Name
====
VIDIOC_LOG_STATUS - Log driver status information
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request )
-ARGUMENTS
+Arguments
=========
-DESCRIPTION
+Description
===========
As the video/audio devices become more complicated it becomes harder to
in Linux 2.6.15.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_OVERLAY
********************
-NAME
+Name
====
VIDIOC_OVERLAY - Start or stop video overlay
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, const int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_PREPARE_BUF
************************
-NAME
+Name
====
VIDIOC_PREPARE_BUF - Prepare a buffer for I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to
:ref:`buffer`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_QBUF, VIDIOC_DQBUF
*******************************
-NAME
+Name
====
VIDIOC_QBUF - VIDIOC_DQBUF - Exchange a buffer with the driver
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Applications call the ``VIDIOC_QBUF`` ioctl to enqueue an empty
:ref:`buffer`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_QUERY_DV_TIMINGS
*****************************
-NAME
+Name
====
VIDIOC_QUERY_DV_TIMINGS - VIDIOC_SUBDEV_QUERY_DV_TIMINGS - Sense the DV preset received by the current input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The hardware may be able to detect the current DV timings automatically,
precise feedback to the user.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_QUERYBUF
*********************
-NAME
+Name
====
VIDIOC_QUERYBUF - Query the status of a buffer
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can
:ref:`buffer`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_QUERYCAP
*********************
-NAME
+Name
====
VIDIOC_QUERYCAP - Query device capabilities
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
All V4L2 devices support the ``VIDIOC_QUERYCAP`` ioctl. It is used to
``device_caps`` field.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctls VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU
*******************************************************************
-NAME
+Name
====
VIDIOC_QUERYCTRL - VIDIOC_QUERY_EXT_CTRL - VIDIOC_QUERYMENU - Enumerate controls and menu control items
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp )
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a control applications set the ``id`` field
``V4L2_CTRL_TYPE_BUTTON`` have this flag set.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_QUERYSTD
*********************
-NAME
+Name
====
VIDIOC_QUERYSTD - Sense the video standard received by the current input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The hardware may be able to detect the current video standard
standard, allocate new buffers and start streaming again.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_REQBUFS
********************
-NAME
+Name
====
VIDIOC_REQBUFS - Initiate Memory Mapping or User Pointer I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
This ioctl is used to initiate :ref:`memory mapped <mmap>`,
must set the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_S_HW_FREQ_SEEK
***************************
-NAME
+Name
====
VIDIOC_S_HW_FREQ_SEEK - Perform a hardware frequency seek
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_hw_freq_seek *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Start a hardware frequency seek from the current frequency. To do this
zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF
***************************************
-NAME
+Name
====
VIDIOC_STREAMON - VIDIOC_STREAMOFF - Start or stop streaming I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, const int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The ``VIDIOC_STREAMON`` and ``VIDIOC_STREAMOFF`` ioctl start and stop
to synchronize with other events.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL
***************************************
-NAME
+Name
====
VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL - Enumerate frame intervals
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval_enum * argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
This ioctl lets applications enumerate available frame intervals on a
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE
***********************************
-NAME
+Name
====
VIDIOC_SUBDEV_ENUM_FRAME_SIZE - Enumerate media bus frame sizes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_size_enum * argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
This ioctl allows applications to enumerate all frame sizes supported by
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE
**********************************
-NAME
+Name
====
VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
To enumerate media bus formats available at a given sub-device pad
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP
************************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_CROP - VIDIOC_SUBDEV_S_CROP - Get or set the crop rectangle on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
**Note**
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBDEV_G_FMT, VIDIOC_SUBDEV_S_FMT
**********************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_FMT - VIDIOC_SUBDEV_S_FMT - Get or set the data format on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls are used to negotiate the frame format at specific subdev
- Active formats, applied to the hardware.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL
********************************************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_FRAME_INTERVAL - VIDIOC_SUBDEV_S_FRAME_INTERVAL - Get or set the frame interval on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
These ioctls are used to get and set the frame interval at specific
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
**********************************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
The selections are used to configure various image processing
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT
******************************************************
-NAME
+Name
====
VIDIOC_SUBSCRIBE_EVENT - VIDIOC_UNSUBSCRIBE_EVENT - Subscribe or unsubscribe event
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event_subscription *argp )
-ARGUMENTS
+Arguments
=========
``fd``
``argp``
-DESCRIPTION
+Description
===========
Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by
situations like that.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
projects / karo-tx-linux.git / commitdiff