fe-set-tone.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _FE_SET_TONE:
  3. *****************
  4. ioctl FE_SET_TONE
  5. *****************
  6. Name
  7. ====
  8. FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
  9. Synopsis
  10. ========
  11. .. c:function:: int ioctl( int fd, FE_SET_TONE, enum fe_sec_tone_mode tone )
  12. :name: FE_SET_TONE
  13. Arguments
  14. =========
  15. ``fd``
  16. File descriptor returned by :ref:`open() <frontend_f_open>`.
  17. ``tone``
  18. an integer enumered value described at :c:type:`fe_sec_tone_mode`
  19. Description
  20. ===========
  21. This ioctl is used to set the generation of the continuous 22kHz tone.
  22. This call requires read/write permissions.
  23. Usually, satellite antenna subsystems require that the digital TV device
  24. to send a 22kHz tone in order to select between high/low band on some
  25. dual-band LNBf. It is also used to send signals to DiSEqC equipment, but
  26. this is done using the DiSEqC ioctls.
  27. .. attention:: If more than one device is connected to the same antenna,
  28. setting a tone may interfere on other devices, as they may lose the
  29. capability of selecting the band. So, it is recommended that applications
  30. would change to SEC_TONE_OFF when the device is not used.
  31. Return Value
  32. ============
  33. On success 0 is returned.
  34. On error -1 is returned, and the ``errno`` variable is set
  35. appropriately.
  36. Generic error codes are described at the
  37. :ref:`Generic Error Codes <gen-errors>` chapter.