blob: 449127e3f2aa80591521379fcf9ad385649d6b5d [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03001.. -*- coding: utf-8; mode: rst -*-
2
3.. _AUDIO_STOP:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -03005==========
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03006AUDIO_STOP
7==========
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -03009Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030010----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030011
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030012AUDIO_STOP
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030013
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030014
15Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030016--------
17
Mauro Carvalho Chehab5929cb12016-07-05 15:22:59 -030018.. cpp:function:: int ioctl(int fd, int request = AUDIO_STOP)
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030019
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030020
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030021Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030022---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030023
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
39 - Equals AUDIO_STOP for this command.
40
41
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030042Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030043-----------
44
45This ioctl call asks the Audio Device to stop playing the current
46stream.
47
48
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030049Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030050------------
51
52On success 0 is returned, on error -1 and the ``errno`` variable is set
53appropriately. The generic error codes are described at the
54:ref:`Generic Error Codes <gen-errors>` chapter.