fe-get-property.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _FE_GET_PROPERTY:
  3. **************************************
  4. ioctl FE_SET_PROPERTY, FE_GET_PROPERTY
  5. **************************************
  6. Name
  7. ====
  8. FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend properties. - FE_GET_PROPERTY returns one or more frontend properties.
  9. Synopsis
  10. ========
  11. .. c:function:: int ioctl( int fd, FE_GET_PROPERTY, struct dtv_properties *argp )
  12. :name: FE_GET_PROPERTY
  13. .. c:function:: int ioctl( int fd, FE_SET_PROPERTY, struct dtv_properties *argp )
  14. :name: FE_SET_PROPERTY
  15. Arguments
  16. =========
  17. ``fd``
  18. File descriptor returned by :ref:`open() <frontend_f_open>`.
  19. ``argp``
  20. Pointer to struct :c:type:`dtv_properties`.
  21. Description
  22. ===========
  23. All Digital TV frontend devices support the ``FE_SET_PROPERTY`` and
  24. ``FE_GET_PROPERTY`` ioctls. The supported properties and statistics
  25. depends on the delivery system and on the device:
  26. - ``FE_SET_PROPERTY:``
  27. - This ioctl is used to set one or more frontend properties.
  28. - This is the basic command to request the frontend to tune into
  29. some frequency and to start decoding the digital TV signal.
  30. - This call requires read/write access to the device.
  31. .. note::
  32. At return, the values aren't updated to reflect the actual
  33. parameters used. If the actual parameters are needed, an explicit
  34. call to ``FE_GET_PROPERTY`` is needed.
  35. - ``FE_GET_PROPERTY:``
  36. - This ioctl is used to get properties and statistics from the
  37. frontend.
  38. - No properties are changed, and statistics aren't reset.
  39. - This call only requires read-only access to the device.
  40. Return Value
  41. ============
  42. On success 0 is returned.
  43. On error -1 is returned, and the ``errno`` variable is set
  44. appropriately.
  45. Generic error codes are described at the
  46. :ref:`Generic Error Codes <gen-errors>` chapter.