Vegas Scripting API Summary

This document provides a summary of all public classes, properties, and methods exposed by the Vegas scripting API. It is intended as a reference for script writers. For an overview on how to run scripts in Vegas, please refer to the Vegas Online Help manual. We encourage you to post questions, comments, ideas, and solutions to the Vegas - Scripting discussion forum.

Class Index: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Table of Contents

MediaType Enum	Enumeration of media types.
ChannelRemapping Enum	Enumeration of audio channel remapping modes.
VideoResampleMode Enum	Enumeration of video resampling modes.
EnvelopeType Enum	Enumeration of envelope types.
CurveType Enum	Enumeration of envelope curve types.
RulerFormat Enum	Enumeration of ruler formats.
BeatValue Enum	Enumeration of beat values.
AudioBusMode Enum	Enumeration of audio bus modes.
AudioChannelFlags Enum	Enumeration of audio channel flags (speaker positions).
AudioResampleQuality Enum	Enumeration of audio resample quality modes.
VideoFieldOrder Enum	Enumeration of video field orderings.
VideoRenderQuality Enum	Enumeration of video render quality modes.
VideoDeinterlaceMethod Enum	Enumeration of video deinterlace methods.
MotionBlurType Enum	Enumeration of motion blur types.
ImageFileFormat Enum	Enumeration of image file formats.
RenderStatus Enum	Enumeration of return values for render commands.
VideoAlphaType Enum	Enumeration of video alpha modes.
PanType Enum	Enumeration of audio pan settings.
LowPassFilterQuality Enum	Enumeration of low-pass filter qualities
VideoKeyframeType Enum	Enumeration of video key frame interpolation types.
AppChangeFlag Enum	Enumeration of application change flags
ProjectChangeFlag Enum	Enumeration of project change flags
CompositeMode Enum	Video track composite modes.
VideoColor Class	Represents a color used in various video properties
BaseList Class	Base class for most collections in the Vegas object model.
BaseListEnumerator Class	Base class for enumerators of Vegas collections.
Timecode Class	Represents a time or length in Vegas.
EffectPreset Class	Represents a set of predefined parameter values for an effect key frame.
EffectPresets Class	Collection of parameter presets for an effect.
PlugInNode Class	Represents a node in the hierarchy of plug-in effects, transitions, and generators.
RenderTemplate Class	Represents a render template.
RenderTemplates Class	Collection of templates for a render plug-in.
Renderer Class	Represents a render plug-in.
Renderers Class	Collection of render plug-ins.
EnvelopePoint Class	Represents an envelope point.
EnvelopePoints Class	Collection of points in an envelope.
Envelope Class	Represents an envelope.
Envelopes Class	Collection of envelopes.
Keyframe Class	Represents a video effect key frame.
Keyframes Class	Collection of effect key frames.
Effect Class	Represents an instance of an effect, transitions, or generator.
Effects Class	Collection of plug-in effects.
MediaStream Class	Represents a media stream.
AudioStream Class	Represents an audio stream.
VideoStream Class	Represents a video stream.
MediaStreams Class	Collection of media streams.
Media Class	Represents a media file referenced by a Vegas project.
Subclip Class	Represents a subclip of a media file.
MediaPool Class	Collection of media used in a project.
MediaPoolEnumerator Class	Enumerator of media referenced by a project.
MediaBin Class	Represents a node in the hierarchy of media bins.
Take Class	Represents a take for an event.
Takes Class	Collection of takes associated with an event.
Fade Class	Represents the fade (in or out) of an event.
VideoMotion Class	Represents the motion of a video event.
VideoMotionVertex Class	Represents a vertex used in video motion key frames.
VideoMotionBounds Class	Represents a 4 sided bounds polygon used in video motion key frames.
VideoMotionKeyframe Class	Represents a key frame for video event motion parameters.
VideoMotionKeyframes Class	Collection of video motion key frames for a video event.
TrackEvent Class	Represents a track event.
AudioEvent Class	Represents an audio event.
VideoEvent Class	Represents an video event.
TrackEvents Class	Collection of track events.
Track Class	Represents an audio or video track.
AudioTrack Class	Represents an audio track.
VideoTrack Class	Represents a video track.
Tracks Class	Collection of tracks in a project.
BusTracks Class	Collection of bus tracks.
BusTrack Class	Represents a bus track.
AudioBusTrack Class	Represents an audio bus track.
VideoBusTrack Class	Represents a video bus track.
TrackEventGroup Class	Represents a group of track events.
TrackEventGroups Class	Collection of track event groups.
Marker Class	Represents a marker on the project's time line.
CDMarker Class	Represents a CD track index marker.
MarkerCommandType Class	Command marker types
CommandMarker Class	Represents a command marker.
Region Class	Represents a region marker on the project time line.
CDRegion Class	Represents a CD track region marker.
Markers Class	Collection of time line markers.
VideoProperties Class	Base class for objects that represent video properties.
ProjectVideoProperties Class	Represents a project's video properties.
PreviewVideoProperties Class	Represents a project's preview video properties.
AudioProperties Class	Base class for objects that represent audio properties.
ProjectAudioProperties Class	Represents a project's audio properties.
RulerProperties Class	Represents a project's ruler properties.
SummaryProperties Class	Represents a project's summary properties.
AudioCDProperties Class	Represents a project's audio CD properties.
Project Class	Represents the currently opened project.
RenderArgs Class	Arguments for a render operation
Vegas Class	Represents the Vegas application.
ScriptArg Class	Script argment name/value pair.
ScriptArgs Class	Represents a list of script argments.

enum MediaType

Enumeration of media types.