Reserved Commands

Introduction

This page list all reserved commands of Snowmix and their syntax. A reserved command is a word sequence which has a built-in functionality. Reserved commands super seeds any definition made by the Snowmix command command create. As such, while it is possible to create a command with a name similar to the first word of a reserved command, it can not be executed.

Nearly all commands can be executed as part of an ini file, executed as part of created Snowmix commands, given interactively over a TCP control connection or executed from within Snowmix's embedded Tcl interpreter.

Some commands can only be used inside a command macro and for the overlay commands, these only have an effect if they are inside a command macro set to be executed by the command. The conditional commands are only useful when used within a command macro. A command macro is created with the command command create.

Overview

The reserved commands can be split up into the following groups of commands:

• Audio Feed commands.
• Audio Mixer commands.
• Audio Sink commands.
• Bg commands.
• Feed commands.
• General commands.
• Image commands.
• Macros and conditionals.
• Monitor commands.
• OpenGL Shape commands.
• Shape Commands.
• Placed Shape commands.
• OpenGL Placed Shape commands.
• Python Interpreter commands.
• Tcl Interpreter commands.
• Text commands.
• Virtual Feed commands.

The audio feed group of commands are commands for creating and manipulating audio feeds within Snowmix. The commands are:

• audio feed add - Create an audio feed or list created audio feeds.
• audio feed add silence - Add silent samples to an audio feed.
• audio feed close - Force close an audio feed.
• audio feed channels - Configure channels for an audio feed or list channels for created audio feeds.
• audio feed ctr isaudio - Define control connection as input for audio and start audio feed.
• audio feed delay - Configure initial delay for audio feed or list configured initial delay for audio feeds.
• audio feed drop - Drop samples for an audio feed.
• audio feed format - Configure input format for an audio feed or list format for created audio feeds.
• audio feed info - List rarely changing audio feed info.
• audio feed maxplaces - List or change max number of audio feeds.
• audio feed move volume - Set animation parameters for volume level for an audio feed or list animation parameters for volume level for created audio feeds.
• audio feed mute - Mute or unmute an audio feed or list mute status for created audio feeds.
• audio feed rate - Configure sample rate for an audio feed or list sample rates for created audio feeds.
• audio feed status - List frequently changing audio feed information.
• audio feed verbose - Set verbose level for audio feeds.
• audio feed volume - Set volume level for an audio feed or list volume level for created audio feeds.
• audio feed help - List syntax for available audio feed commands.

The audio mixer group of commands are commands for creating and manipulating audio mixers within Snowmix. The commands are:

• audio mixer add - Create an audio mixer or list created audio mixers.
• audio mixer add silence - Add silent samples to a created mixer.
• audio mixer drop - Drop samples for a created mixer.
• audio mixer channels - Set channels for an audio mixer or listed created audio mixers.
• audio mixer info - List audio mixer info.
• audio mixer maxplaces - List or change max number of audio mixers.
• audio mixer mute - Set mute on/off for an audio mixer or list mute state for created audio mixers.
• audio mixer queue - List status for audio mixer queues.
• audio mixer rate - Set sample rate for an audio mixer or list sample rates for created audio mixers.
• audio mixer source - List audio mixer source info and status.
• audio mixer source feed - Set an audio feed as source for a created audio mixer.
• audio mixer source mixer - Set an audio mixer as source for a created audio mixer.
• audio mixer source add silence - Add silent samples to an audio mixer's source.
• audio mixer source delete - Delete an added source for a created audio mixer.
• audio mixer source drop - Drop samples for a created audio mixer's source.
• audio mixer source invert - Invert samples for an audio mixer's source.
• audio mixer source map - Set how channels are mapped when mixing an audio mixer's source.
• audio mixer source maxdelay - Set the maximum delay a queue of a source for a created audio mixer can have.
• audio mixer source mindelay - Set the minimu delay a queue of a source for a created audio mixer can have.
• audio mixer source move volume - Set animation parameters for changing an audio mixer's source volume.
• audio mixer source - Set mute on/off for an audio mixer's source.
• audio mixer source - Set pause parameters for an audio mixer's source.
• audio mixer source - Set RMS threshold for an audio mixer's source.
• audio mixer source - Set volume for an audio mixer's source.
• audio mixer start - Start and audio mixer.
• audio mixer status - List status of a created audio mixer.
• audio mixer stop - Stop a created and started audio mixer.
• audio mixer verbose - Set verbose level for the CAudioMixer Class.
• audio mixer volume - Set the volume level for an audio mixer or list audio volume level for created audio mixers.
• audio mixer help - List syntax for audio mixer commands.

The audio sink group of commands are commands for creating and manipulating audio sinks within Snowmix. The commands are:

• audio sink add - Create an audio sink or list created audio sinks.
• audio sink add silence - Add silent samples to an audio sink.
• audio sink channels - Configure channels for an audio sink or list channel settings for created audio sinks.
• audio sink ctr isaudio - Define control connection as output for audio and start audio sink.
• audio sink drop - Drop samples for an audio sink.
• audio sink fadefactor - List or change how fast RMS values fade down.
• audio sink file - Set a file as destination for audio sink.
• audio sink format - Configure input format for an audio sink or list format for created audio sinks.
• audio sink info - List rarely changing audio sink info.
• audio sink maxplaces - List or change max number of audio sinks.
• audio sink move volume - Set animation parameters for volume level for an audio sink or list animation parameters for volume level for created audio sinks.
• audio sink mute - Mute or unmute an audio sink or list mute status for created audio sinks.
• audio sink queue - List queue information for created audio sinks.
• audio sink queue maxdelay - Set maximum delay for a queue for a created audio sink. Obsolete.
• audio sink rate - Configure sample rate for an audio sink or list sample rates for created audio sinks.
• audio sink source - Set audio sink source for a created audio sink or list sources for created audio sinks.
• audio sink start - Start a created audio sink or list state for created audio sinks.
• audio sink status - List status data for created audio sinks.
• audio sink stop - Stop a created and started audio sink or list state of created audio sinks.
• audio sink tcp - Connect audio sink output to a remote Snowmix audio feed input or tcp listener.
• audio sink verbose - Set verbose level for the CAudioSink Class.
• audio sink volume - Set volume level for an audio sink or list volume level for created audio sinks.
• audio sink help - List syntax for available audio sink commands.

The bg group of commands are commands for controlling bg (background) job settings. The commands are:

• bg add - add a bg worker (a program thread).
• bg delete - delete a bg worker (a program thread).
• bg fill - list or set how a new empty main mixer frame is filled.
• bg help - list command syntax for bg commands.
• bg info - list bg settings.
• bg verbose - set or list bg verbosity.

The feed group of commands are commands for creating and manipulating video feeds within Snowmix. The commands are:

• feed add - add a place holder for a feed.
• feed buffers - print debugging information on feed buffers.
• feed clip - sets a clip (cutout) window for the stack or overlay command.
• feed chroma angle - list or set angle for chroma keying for feed.
• feed chroma color - list or set color and/or alpha for chroma keying for feed.
• feed chroma info - list info for chroma keying for feed.
• feed chroma key - list or set the key (color or snapshot) for chroma keying for feed.
• feed chroma level - list or set black/white/noise level for chroma keying for feed.
• feed chroma snapshot - list snapshot status or take snapshot for chroma keying for feed.
• feed chroma state - list state, enable or disable chroma keying for feed.
• feed chroma table - list or set YUV to RGB conversion table used for chroma keying for feed.
• feed chroma threads - list or set number of threads used for chroma keying for feed.
• feed coor - set where the feed should be overlayed when using the stack or overlay command.
• feed cutout - sets a cutout (clip) window for the stack or overlay command. End of life. Use feed clip.
• feed drop - drop feed frames in feed input buffer.
• feed flip - flip feed horizontal, vertical or both.
• feed fast overlay - overlay a feed with a specific set of settings.
• feed filter - list or set the scaling/overlaying method for a feed.
• feed format - list or set input format for feed.
• feed geometry - set the feed geometry.
• feed help - print the syntax for feed commands.
• feed idle - set timeout and idle image for a feed stalled/disconnected.
• feed info - print information on feeds.
• feed list - print detailed information on feeds.
• feed keeplast - list or set frame periods to keep last frame after disconnect.
• feed name - set or change the name of a feed.
• feed onchange state - execute a command on feed state change.
• feed overlay - overlay a specific feed or list of ids.
• feed par - set pixel aspect ratio (usually to set different from 1:1),.
• feed pixel - get pixel value for a specific coordinate in feed frame.
• feed premultiply - multiply incoming feed frames with alpha value or values (needed for transparancy and green/blue-screen.
• feed snapshot - list snapshot info or take a snapshot for the snapshot buffer.
• feed scale - scale overlay feed to a fraction (m/n) where m and n are positive integer greater than zero.
• feed socket - set the feed's control socket for input from GStreamer shmsink.
• feed shift - set where the feed should be overlayed when using the stack or overlay command. End of life. Use feed coor.
• feed live/recorded - set whether the feed is a live feed or a recorded feed.

Monitor commands are commands for controlling a local monitor (video) for Snowmix. A monitor can display video or images or both depending on configuration. The commands are:

• monitor info - List monitor info.
• monitor add - List, add or delete a monitor.
• monitor aspect - List or set aspect setting for monitor.
• monitor bg - List or enable/disable using bg worker (thread) for filling a monitor window.
• monitor center - List or set center setting for monitor.
• monitor coor - List or set coordinates for placing monitor on screen/display.
• monitor display - List or set display to use for placing monitor on screen/display.
• monitor geometry - List or set geometry for monitor.
• monitor scaling - List or enable/disable scaling for monitor.
• monitor source - List or set source for monitor (feed, image, system frame).
• monitor verbose - List or set verbose level for monitor.
• monitor help - List syntax for monitor commands.

General commands are commands that typical either affects Snowmix parameters system wide and/or not easily fit within the other catagories. The commands are:

• help - list help of base/system commands.
• include - Include an ini file or a snowmix library (slib).
• maxplaces - Set max number of objects for strings, fonts, texts, images, imageplaces, video feeds, virtual feeds, audio feeds, audio mixers, audio sinks, glshape, gltexture, glvector, glarray, glvbo, glplaced.
• message - Write a message to control connection.
• messagef - Write a message to control connection and prepend current output frame number.
• messagec - Write a message to another control connection.
• overlay finish - Setting command macro to execute before output.
• overlay pre - Setting command macro to execute at frame rate before mixing the system frame.
• png write - Write output frame to a png file.
• quit - Quit/exit Snowmix.
• require version - Check that the version of Snowmix match the required version for the ini file.
• select - Select a video feed as the base frame.
• stack - Mix (stack) video feeds onto base frame.
• stat - List status and configuration of feeds.
• system ctr port - Set the control port number (TCP port listening for incoming connections). Use 'ctr' or 'control' or 'cont'.
• system ctr id - List unique controller id.
• system ctr onclose - List or set command to execute for current controller upon closing.
• system frame rate - Set the frame rate by which Snowmix will produce output frames.
• system frame write - Write current system mixer frame to file.
• system geometry - Set the size of the (system) video mixer output frame.
• system host allow - Control which hosts can establish a control connection.
• system info - List system information.
• system keyhandler - Set keyboard input handler for monitor.
• system mixer - Set system to either always mix or to only mix when a GStreamer shmsink is connected to Snowmix.
• system mousehandler - Set mouse input (click) handler for monitor.
• system mousemotion - Set (enable) mouse motion input for monitor.
• system name - Set the name of the Snowmix session.
• system output buffers - Set the number of frames allocated for output.
• system output delay - Delay the output stream a specified number of frames
• system output freeze - Freeze video output by outputting the same static frame.
• system output info - List configured settings for output.
• system output mode - Sets the video output mode.
• system output reset - Reset (close) the output connection.
• system output status - List the status of the output connection.
• system socket - Set the mixer's control socket for output to GStreamer shmsrc
• system stacking - List, enable or disable feed stacking for system mixer frame.
• verbose - Be verbose to print more information.

The glshape group of commands are commands for creating and manipulating glshapes within Snowmix. The commands are:

• glshape add - Add a place holder for a glshape or list created glshapes. NOE.
• glshape arcxz - Within a glshape draw a 3D arc xz plane. NOE.
• glshape arcyz - Within a glshape draw a 3D arc yz plane. NOE.
• glshape array - List, add or delete a place holder for an array. NOE.
• glshape array value - List or add values to an array. NOE.
• glshape array modify - Change one or more values in an array. NOE.
• glshape begin - Within a glshape start delimiter of the vertices of a primitive or a group of like primitives. glBegin().
• glshape blendfunc - Within a glshape specify pixel arithmetic. glBlendFunc().
• glshape clear - Within a glshape clear buffers to preset values. glClear().
• glshape clearcolor - Within a glshape specify clear values for the color buffers. glClearColor().
• glshape client - Within a glshape enable/disable client state. glEnableClientState().
• glshape color - Within a glshape set the current color and possibly alpha. glColor().
• glshape color pointer - Within a glshape set texcoord color pointer. glColorPointer().
• glshape context - Specify which OpenGL context to use. NOE.
• glshape cullface - Set cullface. glCullFace().
• glshape disable - Within a glshape disable server-side GL capabilities. glDisable().
• glshape drawarray - Within a glshape draw/render primitives from array of data. glDrawArrays().
• glshape enable - Within a glshape enable server-side GL capabilities. glEnable().
• glshape end - Within a glshape end delimiter of the vertices of a primitive or a group of like primitives. glEnd().
• glshape entry - Activate or inactivate an entry in a glshape. NOE.
• glshape finish - Within a glshape block until all GL execution is complete. glFinish().
• glshape flush - Within a glshape force execution of GL commands in finite time. glFlush().
• glshape frustrum - Within a glshape multiply the current matrix by a perspective matrix. glFrustum().
• glshape glucylinder - Within a glshape draw a cylinder. gluCylinder().
• glshape gludisk - Within a glshape draw a disk. gluDisk().
• glshape gludrawstyle - Within a glshape specify the draw style desired for quadrics. gluQuadricDrawStyle().
• glshape glunormals - Within a glshape specify what kind of normals are desired for quadrics. gluQuadricNormals().
• glshape gluorientation - Within a glshape specify inside/outside orientation for quadrics. gluQuadricOrientation().
• glshape glupartialdisk - Within a glshape draw an arc of a disk. gluPartialDisk().
• glshape gluperspective - Within a glshape set up a perspective projection matrix. gluPerspective().
• glshape glusphere - Within a glshape draw a sphere. gluSphere().
• glshape glutexture - Within a glshape specify if texturing is desired for quadrics. gluQuadricTexture().
• glshape if (osmesa|glx) - Within a glshape conditional execution of a glshape command depending on OpenGL context type. Outside a glshape conditional execution of a Snowmix command depending on OpenGL context type. NOE.
• glshape icon - Iconify/un-iconify window used for GPU acceleration.
• glshape info - List glshape info data. NOE.
• glshape inshape - Within a glshape include a glshape. NOE.
• glshape light - Within a glshape set light source parameters. glLightf().
• glshape lightv - Within a glshape set light source vector parameters. glLightfv().
• glshape list - List a glshape. NOE.
• glshape loadidentity - Within a glshape replace the current matrix with the identity matrix. glLoadIdentity().
• glshape materialv - Within a glshape specify materialvector parameters for the lighting model. glmaterialfv().
• glshape matrixmode - Within a glshape set matrix mode to either projection, modelview, texture or color. glMatrixMode().
• glshape maxplaces - List or set maximum number of shapes, textures, vectors, arrays, vbos and placed shapes. NOE.
• glshape modify - Modify parameters within an entry in a glshape. NOE.
• glshape moveentry - Move or delete an entry in a glshape. NOE
• glshape normal - Within a glshape set the current normal vector. glNormal().
• glshape normal pointer - Within a glshape define an array of normal pointer. glNormalPointer().
• glshape noop - Within a glshape add an entry with no effect. NOE.
• glshape ortho - Within a glshape multiply the current matrix with an orthographic matrix. glOrtho().
• glshape popmatrix - Within a glshape pop the current matrix stack. glPopMatrix().
• glshape pushmatrix - Within a glshape push the current matrix stack. glPushMatrix().
• glshape recursion - Within a glshape change the maximum allowed recursion level. NOE.
• glshape rotate - Within a glshape multiply the current matrix by a rotation matrix. glRotate().
• glshape scale - Within a glshape multiply the current matrix by a general scaling matrix. glScale().
• glshape scissor - Within a glshape define the scissor box. glScissor().
• glshape shademodel - Within a glshape select flat or smooth shading. glShadeModel().
• glshape snowmix - Within a glshape execute a Snowmix command. NOE.
• glshape translate - Within a glshape multiply the current matrix by a translation matrix. glTranslate().
• glshape texcoord - Within a glshape set the current texture 1D/2D/3D/4D coordinates. glTexCoord().
• glshape texcoord pointer - Within a glshape define an array of texture coordinates. glTexCoordPointer().
• glshape texfilter2d - Within a glshape setting the min and mag filter for texture. glTexParameteri() for MIN_FILTER and MAG_FILTER.
• glshape texture add - Create/delete a place holder for a texture or list created textures. NOE.
• glshape texture bind - Within a glshape bind a texture. glGenTextures(), glBindtexture(), glTexImage2D(), gluBuild2DMipmaps(), glTexParameteri().
• glshape texture source - Set source of a texture. NOE.
• glshabe vbo add - Create/delete a place holder for a Vertex Buffer Object or list craeated VBOs. No simple OpenGL equivalent.
• glshabe vbo config - Define the configuration of a Vertex Buffer Object. No simple OpenGL equivalent.
• glshabe vbo data - Define the data set for a configured VBO. No simple OpenGL equivalent.
• glshabe vbo indices - Define the indices of the data set for a configured VBO. No simple OpenGL equivalent.
• glshabe vbo - Within a glshape include a VBO. No simple OpenGL equivalent.
• glshape vector add - Create/delete a vector place holder or list created vectors. NOE.
• glshape vector value - Set the values of a 2, 3 and 4 dimensional vector. NOE.
• glshape verbose - Set the verbose level for gl COpenGLVideo Class.
• glshape vertex - Within a glshape specify a 1D, 2D, 3D or 4D vertex. glVertex().
• glshape help form - List valid <form> parameters. NOE.
• glshape help mode - List valid <mode> parameters. NOE.
• glshape help factor - List valid <factor> parameters. NOE.
• glshape help filter - List valid <near filter> and <mag filter> parameters. NOE.
• glshape help light - List valid parameters for light. NOE.
• glshape help modify - List the type of glshape entries that can be changed with the glshape modify command. NOE.
• glshape help client_state - List the the array modes or states available for the "glshape client" command . NOE.
• glshape help arraymode - . List the array_modes available for the "glshape drawarray". NOE.
• glshape help cullmode - . List the cull modes that can be used with the command "glshape cullface". NOE.

NOE = "No OpenGL equivalent".

The placed glshape group of commands are commands for creating and manipulating placed glshapes within Snowmix. The commands are:

• glshape copyback - Copy back OpenGL mixed result to Snowmix main frame or to a loaded image. Image will be created if it does not exist.
• glshape [ place ] overlay - Execute and possibly overlay placed glshapes.
• glshape place - Create/delete a place holder for a placed glshape or list created placed shapes.
• glshape place alpha - Set alpha for a placed glshape or list alpha for placed glshapes.
• glshape place coor - Set coordinates for a placed glshape or list coordinates for placed glshapes.
• glshape place move alpha - Animate/move alpha dynamically for a placed glshape.
• glshape place move coor - Animate/move coordinates dynamically for a placed glshape.
• glshape place move rotation - Animate/move rotation dynamically for a placed glshape.
• glshape place move rgb - Animate/move rgb dynamically for a placed glshape.
• glshape place move scale - Animate/move scale dynamically for a placed glshape.
• glshape place rgb - Set color for a placed glshape or list colors for placed glshapes.
• glshape place rotation - Set rotation for a placed glshape or list rotation for placed glshapes.
• glshape place scale - Set scale for a placed glshape or list scale for placed glshapes.
• glshape place help - List syntax for glshape place commands.

The image group of commands are commands for creating and manipulating images within Snowmix. The commands are:

• image align - Set or list horizontal and vertical alignment of a placed image.
• image alpha - Set or list the alpha for a placed image.
• image anchor - Set or list anchor a placed image.
• image clip - Set or list clip parameters for a placed image.
• image coor - Set or list coordinates for a placed image.
• image filter - Set or list the filter method for mixing/overlaying a placed image.
• image flip - List image flipped state or flip image vertically, horizontally or both.
• image geometry - List the geometry for placed image.
• image image - Set or list the image source (loaded image) of a placed image.
• image index - Convert a loaded image into an indexed loaded image.
• image index incr - Increment index for a loaded indexed image.
• image index load - Load an image as an indexed image.
• image index loadasync - Load asynchronously an image as an indexed image.
• image index set - List or set index for a loaded indexed image.
• image load - Load an image.
• image loadasync - Load an image asynchronously (in the background).
• image maxplaces - Set or list maximum number of loaded or placed images..
• image matrix - Set or list the Cairo Graphics transformation matrix.
• image move alpha - Set or list animation settings for alpha for a placed image.
• image move clip - Set or list animation settings for clip for a placed image.
• image move coor - Set or list animation settings for coordinates for a placed image.
• image move offset - Set or list animation settings for offset for a placed image.
• image move rotation - Set or list animation settings for rotation for a placed image.
• image move scale - Set or list animation settings for scale for a placed image.
• image name - Set or list the name of a loaded image.
• image offset - List or set offset of a loaded image (relevant for offset rotation of a placed image).
• image overlay - Overlay a placed image.
• image pixel - List or set loaded image pixel RGBA value.
• image place - Place a loaded image.
• image premultiply - Turn alpha premultiply on/off for loading images or alpha premultiply a loaded image with either a single value or individual alpha pixel value.
• image rotation - Set or list rotation for a placed image.
• image scale - Set or list the scale for a placed image.
• image source - Set (create) or list the source of an image. Source can be feed, image or mixer frame.
• image verbose - Set the verbose level for image commands.
• image write - Write a loaded image to disk as a raw BGRA copy or png file (if extension is png).

The group of command macro commands and conditionals is a group of commands that can be used to create and manipulate command macros. The commands are:

• command addatline - Add a line to a command macro
• command afterend - Sets the execution pointer of a command macro to point after the end of the command macro. Further execution of the command macro has no effect.
• command at - Orders the execution of a command at an absolute or relative time in the future.
• command create - Create a command macro
• command delete - Delete a command macro
• command deleteline - Delete a line in a command macro.
• command end - Signals the end of a command macro being created.
• command help - List the command macro commands
• command list - List the name of command macros or the content of a specific command macro.
• command pointer atline - Set the execution pointer of a command macro to point at a specific line in the macro.
• command pop - Pop one or more lines from the end of a command macro.
• command push - Push a single line of command to the end of a command macro.
• command restart - Reset the execution pointer of command macro to point at the beginning of a command macro and reset any internal counters within the command macro.

The following are the conditional commands possible to use within a command macro:

The Python group of commands are commands for interfacing to the built-in Python Interpreter of Snowmix. The commands are:

• python eval - Evaluate Python command in the interpreter.
• python exec - Evaluate Python script by command macro name.
• python reset - Delete Python interpreter and initialize new.
• python help - List Python command syntax.

The built-in Python interpreter supports the following methods for communication between Snowmix internals and the interpreter

• snowmix.info(...)
• snowmix.parse(...)
• snowmix.parses(...)
• snowmix.message(...)

The snowmix.info supports the following arguments:

The shape group of commands are commands for creating and manipulating shapes within Snowmix. The commands are:

• shape add - Add/delete a shape place holder or list created shape place holders.
• shape alphaadd - Add a value to the current alpha value within a shape.
• shape alphamul - Multiply current alpha value with a value within a shape.
• shape alpharestore - Restore from stack a saved alpha value within a shape.
• shape alphasave - Save to stack the current alpha value within a shape.
• shape arc_cw - Define an arc element clock wise within a shape.
• shape arc_ccw - Define an arc element counter clock wise within a shape.
• shape clip - Perform clipping along the path within a shape.
• shape closepath - Close path in a shape.
• shape curveto - Define absolute a curve element in a shape.
• shape curverel - Define relative a curve element in a shape.
• shape feed - Include in a shape a video feed.
• shape fill - Define a fill operation within a shape.
• shape fill preserve - Define a fill operation within a shape and preserve the path.
• shape filter - Set filter/overlay algorithm for overlaying/scaling/rotating an image or feed in a shape.
• shape help - List shape syntax overview.
• shape help modify - List shape entry types that can be modified.
• shape modify - Modify parameters within an entry in a shape.
• shape info - List shape info data.
• shape image - Include in a shape a loaded image.
• shape inshape - Include shape in a shape.
• shape line width - Set line width in a shape.
• shape line join - Set how lines are joined in a shape.
• shape line cap - Set how lines are ended in a shape.
• shape lineto - Define a line segment in a shape drawing absolute within the shape.
• shape linerel - Define a line segment in a shape drawing relative within the shape.
• shape list - List defined shapes or list definition of a specific shape
• shape mask pattern - Define a pattern mask for a shape.
• shape maxplaces - Set or list maximum number of shapes, patterns and placed shapes.
• shape moveentry - Move or delete an entry, a line, within a shape
• shape moverel - Move to a relative coordinate in a shape within a shape.
• shape moveto - Move to an absolute coordinate in a shape within a shape.
• shape newpath - Start a new path within a shape.
• shape offset - Set a geometry offset within a shape.
• shape overlay - Overlay placed shape. See "shape place overlay".
• shape operator - Define operator for adding/subtracting/overlaying within a shape.
• shape paint - Define a paint operation within a shape.
• shape pattern add - Create/delete a pattern place holder or list pattern place holders.
• shape pattern radial - Define a radial pattern.
• shape pattern linear - Define a linear pattern.
• shape pattern stoprgb - Define stop points within a linear or radial pattern.
• shape rectangle - Define a rectangle within a shape.
• shape recursion - Define allowed recursion level within a shape.
• shape restore - Restore a save context within a shape.
• shape rotation - Define a relative or absolute rotation within a shape.
• shape save - Save a context within a shape.
• shape scale - Scale absolute or relative within a shape.
• shape source alphamul - Multiply a constant to the alpha value within a shape.
• shape source rgb - Set RGB value within a shape.
• shape source rgba - Set RGB and alpha channel value within a shape.
• shape source pattern - Add a pattern to a shape.
• shape stroke - Perform a stroke within a shape.
• shape stroke preserve - Perform a stroke within a shape and preserve path.
• shape translate - Move coordinate system within a shape.
• shape transform - Add a coordinate, rotation and scale transformation to a shape.
• shape verbose - Set verbose level within the CVideoShape Class.

The placed shape group of commands are commands for creating and manipulating placed shapes within Snowmix. The commands are:

• shape [place] overlay - Overlay a shape.
• shape place - place a shape or list placed shapes.
• shape place alpha - Set/change/list the alpha value for a placed shape.
• shape place anchor - Set/change/list the anchor value for a placed shape.
• shape place coor - Set/change/list the set of coordinate for a placed shape.
• shape place move alpha - Set/change/list alpha animation settings for placed shapes.
• shape place move coor - Set/change/list coordinate animation settings for placed shapes.
• shape place move offset - Set/change/list offset animation settings for placed shapes.
• shape place move rotation - Set/change/list rotation animation settings for placed shapes.
• shape place move scale - Set/change/list scale animation settings for placed shapes.
• shape place overlay - Overlay one or more placed shapes (used in "overlay finish" macro).
• shape place offset - Set/change/list the offset for a placed shape.
• shape place rgb - Set/change/list the base color for a placed shape.
• shape place rotation - Set/change/list the rotation for a placed shape.
• shape place scale - Set/change/list the scale for a placed shape.
• shape place shape - Set/change/list the shape for a placed shape.
• shape place status - List status of placed shapes.
• shape place help - List syntax for place shape commands.

The Tcl group of commands are commands for interfacing to the built-in Tcl Interpreter of Snowmix. The commands are:

• tcl eval - Evaluate tcl command in the interpreter.
• tcl exec - Evaluate tcl script by command macro name.
• tcl reset - Delete interpreter and initialize new.
• tcl help - List tcl command syntax.

The commands snowmix info and snowmix parse are available within the Tcl Interpreter as Tcl functions or procedures to get access from within the Interpreter to Snowmix settings and to execute from within the interpreter Snowmix commands respectively:

The Tcl commands are:

• snowmix info audio (feed | sink) (info | status | extended | syntax) (format | ids | maxid | nextavail | <id_list\>)
• snowmix info audio mixer (info | status | extended | source info | source status | source extended | syntax) (format | ids | maxid | nextavail | <id_list>)
• snowmix info command ( names | list | at | syntax ) [ format | <name> ]
• snowmix info feed (geometry | status | extended | state | pixel <x> <y> | syntax) (format | ids | maxid | nextavail | <id_list>)
• snowmix info glshape (info | list | place | move | alpha | texture | vector | array | vbo | vbodata) ( format | ids | maxid | nextavail | <id_list> )
• snowmix info image (load | place | move | extended | pixel <x> <y> | syntax) (format | ids | maxid | nextavail | <id_list>)
• snowmix info output ((info | status) [ format ]) | syntax
• snowmix info system (info | status | maxplaces | overlay | syntax) [ format ]
• snowmix info shape ( syntax | ( ( info | list | place | move | alpha | pattern | pdata) ( format | ids | maxid | nextavail | <id_list>) )
• snowmix info system (info | status | maxplaces | overlay | syntax) [ format ]
• snowmix info text (string | font | place | move | backgr | linpat | syntax) (format | ids | maxid | nextavail | <id_list>)
• snowmix info (vfeed | virtual feed) (place | move | extended | syntax) (format | ids | maxid | nextavail | <id_list>)
• snowmix parse <snowmix command>
  Top

The text group of commands are commands for creating and manipulating texts within Snowmix. The commands are:

• text align - Align place text or list alignment for placed text.
• text alpha - Set alpha for placed text or list alpha value for placed texts.
• text anchor - Anchor placed text or list anchoring for placed text.
• text backgr - Set/remove background for placed text or list values for background for placed texts.
• text backgr alpha - Set alpha for background for placed text or list alpha value for background for placed texts.
• text backgr clip - Set clip parameters for background for placed text or list clip parameters for background for placed texts.
• text backgr linpat - Define a linear pattern set for background for placed text or list values for linear pattern sets for background for placed texts.
• text backgr move alpha - Set animation value for alpha for background for placed text or list values for animation for alpha for background for placed texts.
• text backgr move clip - Set animation value for clip for background for placed text or list values for animation for clip for background for placed texts.
• text backgr round - Set round or rectangle corners for background for placed text or list values for corners of background for placed text.
• text backgr rgb - Set colour and optional alpha for background for placed text or list colour and alpha for background for placed texts.
• text clip - Set relative clip parameters for placed text or list relative clip parameters for placed texts.
• text clipabs - Set absolute clip parameters for placed text or list absolute clip parameters for placed texts.
• text coor - Change coordinates for placed text or list coordinates for placed texts.
• text font - Define a font set or list defined font sets.
• text font available - List available fonts on system.
• text grow - Let the number of characters shown for a placed text grow/increase or diminish/decrease.
• text help - List help for text commands.
• text maxplaces - List or set maximum number of text strings, text fonts and placed texts.
• text move alpha - Set animation value for alpha for placed text or list values for animation for alpha for placed texts.
• text move clip - Set animation value for clip for placed text or list values for animation for clip for placed texts.
• text move coor - Set animation value for coordinates for placed text or list values for animation for coordinates for placed texts.
• text move rotation - Set animation value for rotation for placed text or list values for animation for rotation for placed texts.
• text move scale - Set animation value for scale for placed text or list values for animation for scale for placed texts.
• text overlay - Overlay placed text.
• text place - Place text or list placed texts.
• text place font - Change font set for placed text or list font set for placed texts.
• text place string - Set the string id to use for a placed text or list used string id for placed texts.
• text repeat move - Define a placed text as rolling text and set parameters or list rolling text parameters for placed texts.
• text rgb - Set colour for placed text or list colour values for placed texts.
• text rotation - Set rotation for placed text or list rotation values for placed texts.
• text scale - Set scale for placed text or list scale values for placed texts.
• text string - Define a string to be used for a placed text or list defined strings.
• text string concat - Concatenate two strings possibly into a third string

The virtual feed group of commands are commands for creating and manipulating virtual feeds within Snowmix. The commands are:

• vfeed add - Add or delete a virtual feed place holder or list virtual feeds.
• vfeed align - Set or list horizontal and vertical alignment of a virtual feed.
• vfeed alpha - Set or list the alpha for a virtual feed.
• vfeed anchor - Set or list anchor the virtual feed.
• vfeed coor - Set or list a virtual feeds coordinates.
• vfeed clip - Set or list clip parameters for virtual feed.
• vfeed filter - Set or list the filter method for mixing/overlaying the virtual feed.
• vfeed geometry - List the geometry for virtual feed.
• vfeed help - List the syntax for vfeed commands.
• vfeed place rect - Set or list a virtual feed.
• vfeed maxplaces - List or set maximum number of virtual feeds.
• vfeed move alpha - Set or list animation settings for alpha for virtual feed.
• vfeed move clip - Set or list animation settings for clip for virtual feed.
• vfeed move coor - Set or list animation settings for coordinates for virtual feed.
• vfeed move offset - Set or list animation settings for offset for virtual feed.
• vfeed move rotation - Set or list animation settings for rotation for virtual feed.
• vfeed move scale - Set or list animation settings for scale for virtual feed.
• vfeed overlay - Overlay virtual feeds.
• vfeed rotation - Set or list rotation for virtual feed.
• vfeed scale - Set or list the scale for virtual feed.
• vfeed source - Set or list the source of a virtual feed.