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