diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2021-06-01 12:41:39 +0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2021-06-04 09:08:17 +0300 |
| commit | 793e52d4e77d49737ad83cb11925c98f4907fcb1 (patch) | |
| tree | 450c895a3a259f0359ad26be8c47ecf2e3e90d03 /drivers/staging/media/av7110/audio-set-streamtype.rst | |
| parent | 819fbd3d8ef36c09576c2a0ffea503f5c46e9177 (diff) | |
| download | linux-793e52d4e77d49737ad83cb11925c98f4907fcb1.tar.xz | |
media: docs: move DVB audio/video docs to staging
The only upstream driver using the API described there is the
av7110 driver.
As the driver was moved to staging, move the API bits to staging
as well.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'drivers/staging/media/av7110/audio-set-streamtype.rst')
| -rw-r--r-- | drivers/staging/media/av7110/audio-set-streamtype.rst | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/drivers/staging/media/av7110/audio-set-streamtype.rst b/drivers/staging/media/av7110/audio-set-streamtype.rst new file mode 100644 index 000000000000..77d73c74882f --- /dev/null +++ b/drivers/staging/media/av7110/audio-set-streamtype.rst @@ -0,0 +1,66 @@ +.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. c:namespace:: DTV.audio + +.. _AUDIO_SET_STREAMTYPE: + +==================== +AUDIO_SET_STREAMTYPE +==================== + +Name +---- + +AUDIO_SET_STREAMTYPE + +.. attention:: This ioctl is deprecated + +Synopsis +-------- + +.. c:macro:: AUDIO_SET_STREAMTYPE + +``int ioctl(fd, AUDIO_SET_STREAMTYPE, int type)`` + +Arguments +--------- + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + - + + - int fd + + - File descriptor returned by a previous call to open(). + + - + + - int type + + - stream type + +Description +----------- + +This ioctl tells the driver which kind of audio stream to expect. This +is useful if the stream offers several audio sub-streams like LPCM and +AC3. + +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. + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + - .. row 1 + + - ``EINVAL`` + + - type is not a valid or supported stream type. |