[deliverable/linux.git] / Documentation / media / uapi / dvb / dmx-set-filter.rst

.. -*- coding: utf-8; mode: rst -*-

.. _DMX_SET_FILTER:

==============
DMX_SET_FILTER
==============

Name
----

DMX_SET_FILTER


Synopsis
--------

.. c:function:: int ioctl( int fd, DMX_SET_FILTER, struct dmx_sct_filter_params *params)
    :name: DMX_SET_FILTER

Arguments
---------

``fd``
    File descriptor returned by :c:func:`open() <dvb-dmx-open>`.

``params``

    Pointer to structure containing filter parameters.


Description
-----------

This ioctl call sets up a filter according to the filter and mask
parameters provided. A timeout may be defined stating number of seconds
to wait for a section to be loaded. A value of 0 means that no timeout
should be applied. Finally there is a flag field where it is possible to
state whether a section should be CRC-checked, whether the filter should
be a ”one-shot” filter, i.e. if the filtering operation should be
stopped after the first section is received, and whether the filtering
operation should be started immediately (without waiting for a
DMX_START ioctl call). If a filter was previously set-up, this filter
will be canceled, and the receive buffer will be flushed.


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
:ref:`Generic Error Codes <gen-errors>` chapter.
Commit	Line	Data
47d23e36 MCC	1	.. -- coding: utf-8; mode: rst --
	2
	3	.. _DMX_SET_FILTER:
	4
586027ce	5	==============
47d23e36 MCC	6	DMX_SET_FILTER
	7	==============
	8
15e7d615	9	Name
586027ce	10	----
47d23e36	11
586027ce	12	DMX_SET_FILTER
47d23e36	13
15e7d615 MCC	14
15e7d615 MCC	15	Synopsis
47d23e36 MCC	16	--------
47d23e36 MCC	17
cf8076c3 MCC	18	.. c:function:: int ioctl( int fd, DMX_SET_FILTER, struct dmx_sct_filter_params *params)
cf8076c3 MCC	19	:name: DMX_SET_FILTER
47d23e36	20
15e7d615	21	Arguments
586027ce	22	---------
47d23e36	23
cf8076c3 MCC	24	``fd``
cf8076c3 MCC	25	File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
47d23e36	26
cf8076c3	27	``params``
47d23e36	28
cf8076c3	29	Pointer to structure containing filter parameters.
47d23e36 MCC	30
47d23e36 MCC	31
15e7d615	32	Description
586027ce MCC	33	-----------
	34
	35	This ioctl call sets up a filter according to the filter and mask
	36	parameters provided. A timeout may be defined stating number of seconds
	37	to wait for a section to be loaded. A value of 0 means that no timeout
	38	should be applied. Finally there is a flag field where it is possible to
	39	state whether a section should be CRC-checked, whether the filter should
	40	be a ”one-shot” filter, i.e. if the filtering operation should be
	41	stopped after the first section is received, and whether the filtering
	42	operation should be started immediately (without waiting for a
	43	DMX_START ioctl call). If a filter was previously set-up, this filter
	44	will be canceled, and the receive buffer will be flushed.
	45
	46
15e7d615	47	Return Value
47d23e36 MCC	48	------------
	49
	50	On success 0 is returned, on error -1 and the ``errno`` variable is set
	51	appropriately. The generic error codes are described at the
	52	:ref:`Generic Error Codes <gen-errors>` chapter.