*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->IRIX man pages -> dmedia/vlcmd (1)              
Title
Content
Arch
Section
 

Contents


vlcmd(1)							      vlcmd(1)


NAME    [Toc]    [Back]

     vlcmd - Video Library command line	interface

SYNOPSIS    [Toc]    [Back]

     vlcmd [-h]

PARAMETERS    [Toc]    [Back]

     -h	  Print	help message (command and arguments list).

DESCRIPTION    [Toc]    [Back]

     The application vlcmd provides a command line interface to	the
     functionality of the Video	Library.  Operations such as creating paths
     and setting/getting controls can be accomplished on the command line, or
     from a script.

     For ease of access	to nodes and paths vlcmd maintains 2 arrays. Once
     created, all nodes	and paths are referred to by their array indices.
     These are represented in the command argument lists by nodeindex and
     pathindex.	Nodeid and pathid are the ID numbers assigned by the Video
     Library when each is created.

COMMANDS    [Toc]    [Back]

     openvideo
	  The openvideo	command	connects to the	video server. This should be
	  the first command of any vlcmd script.

     setpathid <pathindex> <pathid>
	  The setpathid	command	associates a path with an index	into the path
	  array. You can then use the index to refer to	the path in other
	  vlcmd	commmands.  Use	setpathid if you know the ID number of the
	  path you want	and it has already been	created	in a currently running
	  application. You can get the ID from several of the supplied video
	  applications by running them with the	-I option.

     setnodeid <nodeindex> <nodeid>
	  The setnodeid	command	associates a node with an index	into the node
	  array. You can then use the index to refer to	the node in other
	  vlcmd	commmands.  Use	setnodeid if you know the ID number of the
	  node you want	and the	node has previously instantiated by a
	  vlGetNode() call in a	currently running application. You can get the
	  ID from several of the supplied video	applications by	running	them
	  with the -I option.

     getdevice <pathindex>
	  The getdevice	command	prints the number of the device	on the given
	  path.

     getdevicelist
	  The getdevicelist command prints the number of the devices as	well
	  as the name and number of each device	accessible to the video



									Page 1






vlcmd(1)							      vlcmd(1)



	  server.

     getcontrollist <pathindex>	<nodeindex>
	  The getcontrollist command information on all	controls on the	given
	  node on the given path. The path must	be setup prior to using	this
	  command.

     getnode <nodeindex> <source|drain|device|internal>
	  <video|graphics|memory|screen|texture|network|blender> <nodenum> The
	  getnode command gets a node of the given type, kind and number and
	  associates it	with an	index into the node array. You can then	use
	  the index to refer to	the node in other vlcmd	commands. Use getnode
	  if you do not	know the ID of the node	you want or if the node(s)
	  have not have	not been previously instantiated by a vlGetNode() call
	  in another currently running application.

     createpath	<pathindex> <devicenum>	<srcnodeindex> <drnnodeindex>
	  The createpath command creates a path	on the given device, with the
	  given	nodes and associates it	with an	index into the path array. You
	  can then use the index to refer to the path in other vlcmd commands.
	  Use createpath if you	do not know the	ID of the path you want	or it
	  has not already been created by a currently running application.

     setuppaths	<pathindex> <share|readonly|lock|doneusing>
	  <share|readonly|lock|doneusing> The setuppaths command sets up the
	  given	(previously created) path with the given control and stream
	  usages, respectively.

     addnode <pathindex> <nodeindex>
	  The addnode command adds the given node to the given path. The path
	  must be setup	prior to using this command.

     removenode	<pathindex> <nodeindex>
	  The removenode command removes the given node	from the given path.
	  The path must	be setup prior to using	this command.

     setcontrol	<controltype> <pathindex> <nodeindex> <data1> <data2>
	  The setcontrol command sets a	control	of type	controltype on the
	  given	node and path to values	data1 and data2	data1 is the
	  numerator, data2 is the denominator. Where the control value is an
	  x,y pair data1 is x, data2 is	y. Where it is an int or boolean data1
	  is the control value,	data2 can be any integer but must not be left
	  blank.

     getcontrol	<controltype> <pathindex> <nodeindex>
	  The getcontrol command gets the values of a control of type
	  controltype on the given node	and path and prints out	the values
	  returned in the VLControlValue struct.

     closevideo
	  The closevideo command disconnects from the video server.




									Page 2






vlcmd(1)							      vlcmd(1)



     help  The help command prints the command and arguments list.


     q|quit|exit
	  The q,quit or	exit command exits vlcmd.

SEE ALSO    [Toc]    [Back]

      
      
     vlinfo(1),	vidtomem(1), memtovid(1), videoin(1), videoout(1)


									PPPPaaaaggggeeee 3333
[ Back ]
 Similar pages
Name OS Title
VkForkIO IRIX Command-line interface to shell command component
VkTextIO IRIX Command-line interface text component
fccli IRIX FibreVault Status/Configuration Command Line Interface
hardware Tru64 Command line interface for managing hardware components
apt-get Linux APT package handling utility -- command-line interface
perfex IRIX Command line interface to processor event counters
partition HP-UX display information about the Partition Command Line Interface
hwmgr Tru64 Command line interface for managing hardware components
vintovout IRIX Video Library video output from video input tool
sysman_cli Tru64 Command line interface to SysMan system management data.
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service