video-stop.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _VIDEO_STOP:
  3. ==========
  4. VIDEO_STOP
  5. ==========
  6. Name
  7. ----
  8. VIDEO_STOP
  9. .. attention:: This ioctl is deprecated.
  10. Synopsis
  11. --------
  12. .. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode)
  13. :name: VIDEO_STOP
  14. Arguments
  15. ---------
  16. .. flat-table::
  17. :header-rows: 0
  18. :stub-columns: 0
  19. - .. row 1
  20. - int fd
  21. - File descriptor returned by a previous call to open().
  22. - .. row 2
  23. - int request
  24. - Equals VIDEO_STOP for this command.
  25. - .. row 3
  26. - Boolean mode
  27. - Indicates how the screen shall be handled.
  28. - .. row 4
  29. -
  30. - TRUE: Blank screen when stop.
  31. - .. row 5
  32. -
  33. - FALSE: Show last decoded frame.
  34. Description
  35. -----------
  36. This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
  37. V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
  38. This ioctl call asks the Video Device to stop playing the current
  39. stream. Depending on the input parameter, the screen can be blanked out
  40. or displaying the last decoded frame.
  41. Return Value
  42. ------------
  43. On success 0 is returned, on error -1 and the ``errno`` variable is set
  44. appropriately. The generic error codes are described at the
  45. :ref:`Generic Error Codes <gen-errors>` chapter.