xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/dvb/dmx-get-pes-pids.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: DTV.dmx
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _DMX_GET_PES_PIDS:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun================
7*4882a593SmuzhiyunDMX_GET_PES_PIDS
8*4882a593Smuzhiyun================
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun----
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunDMX_GET_PES_PIDS
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunSynopsis
16*4882a593Smuzhiyun--------
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun.. c:macro:: DMX_GET_PES_PIDS
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun``int ioctl(fd, DMX_GET_PES_PIDS, __u16 pids[5])``
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunArguments
23*4882a593Smuzhiyun---------
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun``fd``
26*4882a593Smuzhiyun    File descriptor returned by :c:func:`open()`.
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun``pids``
29*4882a593Smuzhiyun    Array used to store 5 Program IDs.
30*4882a593Smuzhiyun
31*4882a593SmuzhiyunDescription
32*4882a593Smuzhiyun-----------
33*4882a593Smuzhiyun
34*4882a593SmuzhiyunThis ioctl allows to query a DVB device to return the first PID used
35*4882a593Smuzhiyunby audio, video, textext, subtitle and PCR programs on a given service.
36*4882a593SmuzhiyunThey're stored as:
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun=======================	========	=======================================
39*4882a593SmuzhiyunPID  element		position	content
40*4882a593Smuzhiyun=======================	========	=======================================
41*4882a593Smuzhiyunpids[DMX_PES_AUDIO]	0		first audio PID
42*4882a593Smuzhiyunpids[DMX_PES_VIDEO]	1		first video PID
43*4882a593Smuzhiyunpids[DMX_PES_TELETEXT]	2		first teletext PID
44*4882a593Smuzhiyunpids[DMX_PES_SUBTITLE]	3		first subtitle PID
45*4882a593Smuzhiyunpids[DMX_PES_PCR]	4		first Program Clock Reference PID
46*4882a593Smuzhiyun=======================	========	=======================================
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun.. note::
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun	A value equal to 0xffff means that the PID was not filled by the
51*4882a593Smuzhiyun	Kernel.
52*4882a593Smuzhiyun
53*4882a593SmuzhiyunReturn Value
54*4882a593Smuzhiyun------------
55*4882a593Smuzhiyun
56*4882a593SmuzhiyunOn success 0 is returned.
57*4882a593Smuzhiyun
58*4882a593SmuzhiyunOn error -1 is returned, and the ``errno`` variable is set
59*4882a593Smuzhiyunappropriately.
60*4882a593Smuzhiyun
61*4882a593SmuzhiyunThe generic error codes are described at the
62*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
63