fe-set-frontend-tune-mode.rst 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _FE_SET_FRONTEND_TUNE_MODE:
  3. *******************************
  4. ioctl FE_SET_FRONTEND_TUNE_MODE
  5. *******************************
  6. Name
  7. ====
  8. FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
  9. Synopsis
  10. ========
  11. .. c:function:: int ioctl( int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags )
  12. :name: FE_SET_FRONTEND_TUNE_MODE
  13. Arguments
  14. =========
  15. ``fd``
  16. File descriptor returned by :ref:`open() <frontend_f_open>`.
  17. ``flags``
  18. Valid flags:
  19. - 0 - normal tune mode
  20. - ``FE_TUNE_MODE_ONESHOT`` - When set, this flag will disable any
  21. zigzagging or other "normal" tuning behaviour. Additionally,
  22. there will be no automatic monitoring of the lock status, and
  23. hence no frontend events will be generated. If a frontend device
  24. is closed, this flag will be automatically turned off when the
  25. device is reopened read-write.
  26. Description
  27. ===========
  28. Allow setting tuner mode flags to the frontend, between 0 (normal) or
  29. ``FE_TUNE_MODE_ONESHOT`` mode
  30. Return Value
  31. ============
  32. On success 0 is returned.
  33. On error -1 is returned, and the ``errno`` variable is set
  34. appropriately.
  35. Generic error codes are described at the
  36. :ref:`Generic Error Codes <gen-errors>` chapter.