Commit 76df39fa authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

media: dmx-get-pes-pids.rst: document the ioctl

This ioctl is supported by the DVB core, but was never
documented.

Add a documentation for it.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 883dfe8a
...@@ -25,13 +25,31 @@ Arguments ...@@ -25,13 +25,31 @@ Arguments
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
``pids`` ``pids``
Undocumented. Array used to store 5 Program IDs.
Description Description
----------- -----------
.. note:: This ioctl is undocumented. Documentation is welcome. This ioctl allows to query a DVB device to return the first PID used
by audio, video, textext, subtitle and PCR programs on a given service.
They're stored as:
======================= ======== =======================================
PID element position content
======================= ======== =======================================
pids[DMX_PES_AUDIO] 0 first audio PID
pids[DMX_PES_VIDEO] 1 first video PID
pids[DMX_PES_TELETEXT] 2 first teletext PID
pids[DMX_PES_SUBTITLE] 3 first subtitle PID
pids[DMX_PES_PCR] 4 first Program Clock Reference PID
======================= ======== =======================================
.. note::
A value equal to 0xffff means that the PID was not filled by the
Kernel.
Return Value Return Value
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment