forked from Minki/linux
cf8076c314
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
66 lines
1.2 KiB
ReStructuredText
66 lines
1.2 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _AUDIO_GET_PTS:
|
|
|
|
=============
|
|
AUDIO_GET_PTS
|
|
=============
|
|
|
|
Name
|
|
----
|
|
|
|
AUDIO_GET_PTS
|
|
|
|
.. attention:: This ioctl is deprecated
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. c:function:: int ioctl(int fd, AUDIO_GET_PTS, __u64 *pts)
|
|
:name: AUDIO_GET_PTS
|
|
|
|
|
|
Arguments
|
|
---------
|
|
|
|
.. flat-table::
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
|
|
|
|
-
|
|
|
|
- int fd
|
|
|
|
- File descriptor returned by a previous call to open().
|
|
|
|
-
|
|
|
|
- __u64 \*pts
|
|
|
|
- Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
|
|
ISO/IEC 13818-1.
|
|
|
|
The PTS should belong to the currently played frame if possible,
|
|
but may also be a value close to it like the PTS of the last
|
|
decoded frame or the last PTS extracted by the PES parser.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
This ioctl is obsolete. Do not use in new drivers. If you need this
|
|
functionality, then please contact the linux-media mailing list
|
|
(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__).
|
|
|
|
This ioctl call asks the Audio Device to return the current PTS
|
|
timestamp.
|
|
|
|
|
|
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.
|