blob: 865129c726ad533840824f245d694b8013bf5b78 [file] [log] [blame]
.. Permission is granted to copy, distribute and/or modify this
.. document under the terms of the GNU Free Documentation License,
.. Version 1.1 or any later version published by the Free Software
.. Foundation, with no Invariant Sections, no Front-Cover Texts
.. and no Back-Cover Texts. A copy of the license is included at
.. Documentation/media/uapi/fdl-appendix.rst.
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
.. _func-write:
V4L2 write()
v4l2-write - Write to a V4L2 device
.. code-block:: c
#include <unistd.h>
.. c:function:: ssize_t write( int fd, void *buf, size_t count )
:name: v4l2-write
File descriptor returned by :ref:`open() <func-open>`.
Buffer with data to be written
Number of bytes at the buffer
:ref:`write() <func-write>` writes up to ``count`` bytes to the device
referenced by the file descriptor ``fd`` from the buffer starting at
``buf``. When the hardware outputs are not active yet, this function
enables them. When ``count`` is zero, :ref:`write() <func-write>` returns 0
without any other effect.
When the application does not provide more data in time, the previous
video frame, raw VBI image, sliced VPS or WSS data is displayed again.
Sliced Teletext or Closed Caption data is not repeated, the driver
inserts a blank line instead.
Return Value
On success, the number of bytes written are returned. Zero indicates
nothing was written. On error, -1 is returned, and the ``errno``
variable is set appropriately. In this case the next write will start at
the beginning of a new frame. Possible error codes are:
Non-blocking I/O has been selected using the
:ref:`O_NONBLOCK <func-open>` flag and no buffer space was
available to write the data immediately.
``fd`` is not a valid file descriptor or is not open for writing.
The driver does not support multiple write streams and the device is
already in use.
``buf`` references an inaccessible memory area.
The call was interrupted by a signal before any data was written.
I/O error. This indicates some hardware problem.
The :ref:`write() <func-write>` function is not supported by this driver,
not on this device, or generally not on this type of device.