XvStopVideo(__libmansuffix__)

Name
XvStopVideo - stop active video

Syntax
#include <X11/extensions/Xvlib.h>

XvStopVideo(dpy, port, draw)

Display *dpy;
XvPortID port;
Drawable draw;

Arguments

dpy Specifies the display screen on which the Xv Server is to accept requests from Xv clients. If the display option is not specified, Xv uses the display screen specified by your DISPLAY environment variable. The display option has the format hostname:number. Using two colons (::) instead of one (:) indicates that DECnet is to be used for transport.

port
    Specifies the port for which video is to be stopped.

draw
    Specifies the drawable associated with the named port.

Description
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 XvVideoNotify(__libmansuffix__) event with detail XvStopped is generated for the associated drawable.

Returned Values

[Success]
    Returned if XvStopVideo(__libmansuffix__) completed successfully.

[XvBadExtension]
    Returned if the Xv extension is unavailable.

[XvBadAlloc]
    Returned if XvStopVideo(__libmansuffix__) failed to allocate memory to process the request.

Diagnostics

[XvBadPort]
    Generated if the requested port does not exist.

[BadDrawable]
    Generated if the requested drawable does not exist.

See Also
XvGetVideo(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotifyEvent(__libmansuffix__)