Commit 47d23e36 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

doc-rst: linux_tv: split DVB function call documentation 



Just like V4L, split the DVB function calls into one file per
system call. This is a requirement for the man pages creator
on Sphinx to work, and makes the document easier to maintain.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent bb2ade02

Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst

0 → 100644
+59 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _AUDIO_BILINGUAL_CHANNEL_SELECT:



AUDIO_BILINGUAL_CHANNEL_SELECT

==============================



Description

-----------



This ioctl is obsolete. Do not use in new drivers. It has been replaced

by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control

for MPEG decoders controlled through V4L2.



This ioctl call asks the Audio Device to select the requested channel

for bilingual streams if possible.



Synopsis

--------



.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)



Arguments

----------







.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  int fd



       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_BILINGUAL_CHANNEL_SELECT for this command.



    -  .. row 3



       -  audio_channel_select_t ch



       -  Select the output format of the audio (mono left/right, stereo).





Return Value

------------



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

Documentation/linux_tv/media/dvb/audio-channel-select.rst

0 → 100644
+58 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _AUDIO_CHANNEL_SELECT:



AUDIO_CHANNEL_SELECT

====================



Description

-----------



This ioctl is for DVB devices only. To control a V4L2 decoder use the

V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.



This ioctl call asks the Audio Device to select the requested channel if

possible.



Synopsis

--------



.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)



Arguments

----------







.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  int fd



       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_CHANNEL_SELECT for this command.



    -  .. row 3



       -  audio_channel_select_t ch



       -  Select the output format of the audio (mono left/right, stereo).





Return Value

------------



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

Documentation/linux_tv/media/dvb/audio-clear-buffer.rst

0 → 100644
+49 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _AUDIO_CLEAR_BUFFER:



AUDIO_CLEAR_BUFFER

==================



Description

-----------



This ioctl call asks the Audio Device to clear all software and hardware

buffers of the audio decoder device.



Synopsis

--------



.. c:function:: int  ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)



Arguments

----------







.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  int fd



       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_CLEAR_BUFFER for this command.





Return Value

------------



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

Documentation/linux_tv/media/dvb/audio-continue.rst

0 → 100644
+49 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _AUDIO_CONTINUE:



AUDIO_CONTINUE

==============



Description

-----------



This ioctl restarts the decoding and playing process previously paused

with AUDIO_PAUSE command.



Synopsis

--------



.. c:function:: int  ioctl(int fd, int request = AUDIO_CONTINUE)



Arguments

----------







.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  int fd



       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_CONTINUE for this command.





Return Value

------------



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

Documentation/linux_tv/media/dvb/audio-fclose.rst

0 → 100644
+52 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _audio_fclose:



DVB audio close()

=================



Description

-----------



This system call closes a previously opened audio device.



Synopsis

--------



.. c:function:: int  close(int fd)



Arguments

----------







.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  int fd



       -  File descriptor returned by a previous call to open().





Return Value

------------







.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  ``EBADF``



       -  fd is not a valid open file descriptor.