Documentation/media/uapi/dvb/audio-fwrite.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _audio_fwrite:
  11
  12 =========================
  13 Digital TV audio write()
  14 =========================
  15
  16 Name
  17 ----
  18
  19 Digital TV audio write()
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: size_t write(int fd, const void *buf, size_t count)
  27     :name: dvb-audio-write
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -  .. row 1
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -  .. row 2
  45
  46        -  void \*buf
  47
  48        -  Pointer to the buffer containing the PES data.
  49
  50     -  .. row 3
  51
  52        -  size_t count
  53
  54        -  Size of buf.
  55
  56
  57 Description
  58 -----------
  59
  60 This system call can only be used if AUDIO_SOURCE_MEMORY is selected
  61 in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in
  62 PES format. If O_NONBLOCK is not specified the function will block
  63 until buffer space is available. The amount of data to be transferred is
  64 implied by count.
  65
  66
  67 Return Value
  68 ------------
  69
  70 .. flat-table::
  71     :header-rows:  0
  72     :stub-columns: 0
  73
  74
  75     -  .. row 1
  76
  77        -  ``EPERM``
  78
  79        -  Mode AUDIO_SOURCE_MEMORY not selected.
  80
  81     -  .. row 2
  82
  83        -  ``ENOMEM``
  84
  85        -  Attempted to write more data than the internal buffer can hold.
  86
  87     -  .. row 3
  88
  89        -  ``EBADF``
  90
  91        -  fd is not a valid open file descriptor.