]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - Documentation/linux_tv/media/dvb/video-stillpicture.rst
doc-rst: customize RTD theme, captions & inline literal
[mirror_ubuntu-artful-kernel.git] / Documentation / linux_tv / media / dvb / video-stillpicture.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_STILLPICTURE:
4
586027ce 5==================
47d23e36
MCC
6VIDEO_STILLPICTURE
7==================
8
586027ce
MCC
9NAME
10----
47d23e36 11
586027ce 12VIDEO_STILLPICTURE
47d23e36 13
586027ce 14SYNOPSIS
47d23e36
MCC
15--------
16
17.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
18
47d23e36 19
586027ce
MCC
20ARGUMENTS
21---------
47d23e36
MCC
22
23.. flat-table::
24 :header-rows: 0
25 :stub-columns: 0
26
27
28 - .. row 1
29
30 - int fd
31
32 - File descriptor returned by a previous call to open().
33
34 - .. row 2
35
36 - int request
37
38 - Equals VIDEO_STILLPICTURE for this command.
39
40 - .. row 3
41
42 - struct video_still_picture \*sp
43
44 - Pointer to a location where an I-frame and size is stored.
45
46
586027ce
MCC
47DESCRIPTION
48-----------
49
50This ioctl call asks the Video Device to display a still picture
51(I-frame). The input data shall contain an I-frame. If the pointer is
52NULL, then the current displayed still picture is blanked.
53
54
55RETURN VALUE
47d23e36
MCC
56------------
57
58On success 0 is returned, on error -1 and the ``errno`` variable is set
59appropriately. The generic error codes are described at the
60:ref:`Generic Error Codes <gen-errors>` chapter.