2009-10-31 12:54:56 -06:00
|
|
|
.TH XvStopVideo __libmansuffix__ __vendorversion__ "libXv Functions"
|
|
|
|
|
.SH NAME
|
|
|
|
|
XvStopVideo \- stop active video
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH SYNOPSIS
|
2008-05-24 07:46:47 -06:00
|
|
|
.B #include <X11/extensions/Xvlib.h>
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
2009-10-31 12:54:56 -06:00
|
|
|
.BI "int XvStopVideo(Display *" dpy ", XvPortID " port ", Drawable " draw ");"
|
2008-05-24 07:46:47 -06:00
|
|
|
.fi
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH ARGUMENTS
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIdpy\fR 8
|
2006-11-25 11:01:46 -07:00
|
|
|
Specifies the connection to the X server.
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIport\fR 8
|
2006-11-25 11:01:46 -07:00
|
|
|
Specifies the port for which video is to be stopped.
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIdraw\fR 8
|
2006-11-25 11:01:46 -07:00
|
|
|
Specifies the drawable associated with the named port.
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH DESCRIPTION
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.BR XvStopVideo (__libmansuffix__)
|
|
|
|
|
stops active video for the specified port and drawable. If the port
|
|
|
|
|
is not processing video, or if it is processing video in a different
|
|
|
|
|
drawable, the request is ignored. When video is stopped a
|
|
|
|
|
.BR XvVideoNotify (__libmansuffix__)
|
|
|
|
|
event with detail XvStopped is generated for the associated drawable.
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH RETURN VALUES
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [Success] 8
|
2009-10-31 12:54:56 -06:00
|
|
|
Returned if
|
|
|
|
|
.BR XvStopVideo (__libmansuffix__)
|
|
|
|
|
completed successfully.
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [XvBadExtension] 8
|
|
|
|
|
Returned if the Xv extension is unavailable.
|
|
|
|
|
.IP [XvBadAlloc] 8
|
2009-10-31 12:54:56 -06:00
|
|
|
Returned if
|
|
|
|
|
.BR XvStopVideo (__libmansuffix__)
|
|
|
|
|
failed to allocate memory to process the request.
|
|
|
|
|
.SH DIAGNOSTICS
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [XvBadPort] 8
|
|
|
|
|
Generated if the requested port does not exist.
|
|
|
|
|
.IP [BadDrawable] 8
|
|
|
|
|
Generated if the requested drawable does not exist.
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR XvGetVideo (__libmansuffix__),
|
|
|
|
|
.BR XvPutVideo (__libmansuffix__),
|
|
|
|
|
.BR XvVideoNotify (__libmansuffix__)
|
