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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _audio_fwrite:
   4
   5 =========================
   6 Digital TV audio write()
   7 =========================
   8
   9 Name
  10 ----
  11
  12 Digital TV audio write()
  13
  14 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: size_t write(int fd, const void *buf, size_t count)
  20     :name: dvb-audio-write
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -  .. row 2
  38
  39        -  void \*buf
  40
  41        -  Pointer to the buffer containing the PES data.
  42
  43     -  .. row 3
  44
  45        -  size_t count
  46
  47        -  Size of buf.
  48
  49
  50 Description
  51 -----------
  52
  53 This system call can only be used if AUDIO_SOURCE_MEMORY is selected
  54 in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in
  55 PES format. If O_NONBLOCK is not specified the function will block
  56 until buffer space is available. The amount of data to be transferred is
  57 implied by count.
  58
  59
  60 Return Value
  61 ------------
  62
  63 .. flat-table::
  64     :header-rows:  0
  65     :stub-columns: 0
  66
  67
  68     -  .. row 1
  69
  70        -  ``EPERM``
  71
  72        -  Mode AUDIO_SOURCE_MEMORY not selected.
  73
  74     -  .. row 2
  75
  76        -  ``ENOMEM``
  77
  78        -  Attempted to write more data than the internal buffer can hold.
  79
  80     -  .. row 3
  81
  82        -  ``EBADF``
  83
  84        -  fd is not a valid open file descriptor.