Vegas 4 Scripting API Summary


Copyright (c) 2003 Sonic Foundry, Inc.
Revision Date: May. 12, 2003.

This document provides a summary of all public classes, properties, and methods exposed by the Vegas 4 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.
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.
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.
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.
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.
Vegas Class Represents the Vegas application.
enum MediaType

Enumeration of media types.

Inherits from: System.Enum
Fields: Summary:
MediaType.Unknown unknown media type
MediaType.Audio audio media type
MediaType.Video video media type
enum ChannelRemapping

Enumeration of audio channel remapping modes.

Inherits from: System.Enum
Fields: Summary:
ChannelRemapping.None no channel remapping
ChannelRemapping.DisableLeft disable left channel
ChannelRemapping.DisableRight disable right channel
ChannelRemapping.MuteLeft mute left channel
ChannelRemapping.MuteRight mute right channel
ChannelRemapping.Mono mono
ChannelRemapping.Swap swap channels
enum VideoResampleMode

Enumeration of video resampling modes.

Inherits from: System.Enum
Fields: Summary:
VideoResampleMode.Smart resample if needed
VideoResampleMode.Force force resample
VideoResampleMode.Disable don't resample
enum EnvelopeType

Enumeration of envelope types.

Inherits from: System.Enum
Fields: Summary:
EnvelopeType.Volume audio track volume
EnvelopeType.Pan audio track pan
EnvelopeType.BusA send audio bus A
EnvelopeType.BusB send audio bus B
EnvelopeType.BusC send audio bus C
EnvelopeType.BusD send audio bus D
EnvelopeType.BusE send audio bus E
EnvelopeType.BusF send audio bus F
EnvelopeType.BusG send audio bus G
EnvelopeType.BusH send audio bus H
EnvelopeType.BusI send audio bus I
EnvelopeType.BusJ send audio bus J
EnvelopeType.BusK send audio bus K
EnvelopeType.BusL send audio bus L
EnvelopeType.BusM send audio bus M
EnvelopeType.BusN send audio bus N
EnvelopeType.BusO send audio bus O
EnvelopeType.BusP send audio bus P
EnvelopeType.BusQ send audio bus Q
EnvelopeType.BusR send audio bus R
EnvelopeType.BusS send audio bus S
EnvelopeType.BusT send audio bus T
EnvelopeType.BusU send audio bus U
EnvelopeType.BusV send audio bus V
EnvelopeType.BusW send audio bus W
EnvelopeType.BusX send audio bus X
EnvelopeType.BusY send audio bus Y
EnvelopeType.BusZ send audio bus Z
EnvelopeType.Composite video track composite level
EnvelopeType.FadeToColor video track fade to color
EnvelopeType.MotionBlurLength video bus track motion blur length
EnvelopeType.VideoSupersampling video bus track video super-sampling
EnvelopeType.Fade not used
EnvelopeType.Velocity video event velocity
EnvelopeType.AutomationMin minimum id for audio effect automation
EnvelopeType.AutomationMax maximum id for audio effect automation
enum CurveType

Enumeration of envelope curve types.

Inherits from: System.Enum
Fields: Summary:
CurveType.Invalid invalid envelope curve type
CurveType.Sharp cubic sharp fade
CurveType.Slow logarithmic slow fade
CurveType.None no fade (hold)
CurveType.Linear linear fade
CurveType.Fast logarithmic fast fade
CurveType.Smooth cubic smooth fade
enum RulerFormat

Enumeration of ruler formats.

Inherits from: System.Enum
Fields: Summary:
RulerFormat.Samples samples
RulerFormat.Time time
RulerFormat.Seconds seconds
RulerFormat.TimeAndFrames time and frames
RulerFormat.AbsoluteFrames absolute frames
RulerFormat.MeasuresAndBeats measures and beats
RulerFormat.SmpteNonDrop SMPTE non-drop
RulerFormat.Smpte30 SMPTE 30 frames per second
RulerFormat.SmpteDrop SMPTE drop frame
RulerFormat.SmpteEBU SMPTE EBU
RulerFormat.SmpteFilmSync SMPTE 24 frames per second
RulerFormat.FeetAndFrames16mm Feet and Frames (16mm)
RulerFormat.FeetAndFrames35mm Feet and Frames (35mm)
RulerFormat.AudioCDTime Audio CD time
enum BeatValue

Enumeration of beat values.

Inherits from: System.Enum
Fields: Summary:
BeatValue.Whole Whole Note
BeatValue.Half Half Note
BeatValue.Quarter Quarter Note
BeatValue.Eighth Eighth Note
BeatValue.Sixteenth 16th Note
BeatValue.ThirtySecond 32nd Note
enum AudioBusMode

Enumeration of audio bus modes.

Inherits from: System.Enum
Fields: Summary:
AudioBusMode.Stereo Stereo (2 channels)
AudioBusMode.Surround Surround (5.1)
enum AudioResampleQuality

Enumeration of audio resample quality modes.

Inherits from: System.Enum
Fields: Summary:
AudioResampleQuality.Preview preview (lower) quality
AudioResampleQuality.Good good quality
AudioResampleQuality.Best best quality
enum VideoFieldOrder

Enumeration of video field orderings.

Inherits from: System.Enum
Fields: Summary:
VideoFieldOrder.ProgressiveScan progressive scan (multimedia)
VideoFieldOrder.UpperFieldFirst interlaced (upper field first)
VideoFieldOrder.LowerFieldFirst interlaced (lower field first)
enum VideoRenderQuality

Enumeration of video render quality modes.

Inherits from: System.Enum
Fields: Summary:
VideoRenderQuality.Draft draft quality
VideoRenderQuality.Preview preview quality
VideoRenderQuality.Good good quality
VideoRenderQuality.Best best quality
enum VideoDeinterlaceMethod

Enumeration of video deinterlace methods.

Inherits from: System.Enum
Fields: Summary:
VideoDeinterlaceMethod.None no deinterlacing
VideoDeinterlaceMethod.BlendFields deinterlace by blend fields
VideoDeinterlaceMethod.InterpolateFields deinterlace by interpolation
enum MotionBlurType

Enumeration of motion blur types.

Inherits from: System.Enum
Fields: Summary:
MotionBlurType.Gaussian gaussian
MotionBlurType.Pyramid pyramid
MotionBlurType.Box box
MotionBlurType.AsymmetricGaussian asymmetric gaussian
MotionBlurType.AsymmetricPyramid asymmetric pyramid
MotionBlurType.AsymmetricBox asymmetric box
enum ImageFileFormat

Enumeration of image file formats.

Inherits from: System.Enum
Fields: Summary:
ImageFileFormat.PNG PNG format
ImageFileFormat.JPEG JPEG format
enum RenderStatus

Enumeration of return values for render commands.

Inherits from: System.Enum
Fields: Summary:
RenderStatus.Unknown unknown render status
RenderStatus.Complete render completed
RenderStatus.Canceled render canceled
RenderStatus.Failed render failed
RenderStatus.Quit application was quit mid-render
enum VideoAlphaType

Enumeration of video alpha modes.

Inherits from: System.Enum
Fields: Summary:
VideoAlphaType.Undefined undefined alpha mode
VideoAlphaType.None no alpha channel
VideoAlphaType.Straight straight alpha channel
VideoAlphaType.Premultiplied premultiplied alpha
VideoAlphaType.PremultipliedDirty premultiplied (dirty)
enum PanType

Enumeration of audio pan settings.

Inherits from: System.Enum
Fields: Summary:
PanType.Add add
PanType.ConstantPower constant power
PanType.Balance balance
PanType.Notch3Db notched at 3 Db
PanType.Notch6Db Notched at 6Db
PanType.Unknown unknown/invalid pan type
enum LowPassFilterQuality

Enumeration of low-pass filter qualities

Inherits from: System.Enum
Fields: Summary:
LowPassFilterQuality.Preview Preview quality
LowPassFilterQuality.Good good quality
LowPassFilterQuality.Best best quality
enum VideoKeyframeType

Enumeration of video key frame interpolation types.

Inherits from: System.Enum
Fields: Summary:
VideoKeyframeType.Linear linear interpolation
VideoKeyframeType.Hold hold first value
VideoKeyframeType.Slow slow (accelerating) interpolation
VideoKeyframeType.Fast fast (decelerating) interpolation
VideoKeyframeType.Smooth smooth interpolation
VideoKeyframeType.Sharp sharp interpolation
class VideoColor

Represents a color used in various video properties

Inherits from: System.Object
Public Constructors: Summary:
VideoColor(UInt32 argb) Construct a new video color from a combined color value.
Parameters:
argb: a combined color value
VideoColor(Byte r, Byte g, Byte b, Byte a) Construct a new video color from separate color values.
Parameters:
r: the red component
g: the green component
b: the blue component
a: the alpha component
VideoColor(Byte r, Byte g, Byte b) Construct a new video color (with full alpha) from separate color values.
Parameters:
r: the red component
g: the green component
b: the blue component
Public Properties: Summary:
Byte A Get or set the alpha component of the color.
Byte R Get or set the red component of the color.
Byte G Get or set the green component of the color.
Byte B Get or set the blue component of the color.
Public Methods: Summary:
virtual String ToString() Returns a string representation of the color.
UInt32 ToArgb() Returns the 32-bit unsigned integer representation of the color (0xAARRGGBB).
abstract class BaseList

Base class for most collections in the Vegas object model.

Inherits from: System.Object
Public Properties: Summary:
Int32 Count Get the number of items in the collection.
Boolean IsSynchronized Indicates whether access to the collection is thread safe.
Object SyncRoot Get the object that can be used to to synchronize access to the collection.
Boolean IsFixedSize Indicates whether the collection has a fixed size.
Boolean IsReadOnly Indicates whether the collection is read only.
Object Item Get the nth item in the collection.
Public Methods: Summary:
virtual Void CopyTo(Array array, Int32 index) Copies the items in the collection to an array.
Parameters:
array: destination array
index: start index in the array
virtual IEnumerator GetEnumerator() Get a new enumerator for the collection.
virtual Int32 Add(Object item) Add an item to the collection.
Parameters:
item: object to add
virtual Void Clear() Removes all items from the collection.
virtual Boolean Contains(Object item) Indicates whether the given object is a member of the collection.
Parameters:
item: object whose membership is determined
virtual Int32 IndexOf(Object item) Get the index of the given object in the collection.
Parameters:
item: object whose index is determined
virtual Void Insert(Int32 index, Object item) Inserts the object at the given index.
Parameters:
index: zero-based index
item: object to insert
virtual Void Remove(Object item) Removes the given object from the collection.
Parameters:
item: object to be removed
virtual Void RemoveAt(Int32 index) Removes the object at the given index.
Parameters:
index: index of item to be removed
class BaseListEnumerator

Base class for enumerators of Vegas collections.

Inherits from: System.Object
Public Properties: Summary:
Object Current Get the current object in the enumeration.
Public Methods: Summary:
virtual Boolean MoveNext() Move to the next object in the enumeration.
virtual Void Reset() Reset the enumeration.
class Timecode

Represents a time or length in Vegas.

Inherits from: System.Object
Public Constructors: Summary:
Timecode() Create a new time code representing zero time.
Timecode(Double milliseconds) Create a new time code from a number of milliseconds
Parameters:
milliseconds: number of milliseconds
Timecode(String timestamp) Create a new time code from a time stamp string.
Parameters:
timestamp: a string representation of the new time code
Public Properties: Summary:
Int64 FrameCount Get or set the number of frames represented by the time code.
Public Methods: Summary:
virtual String ToString() Get the time code's string representation using the current project's ruler format.
String ToString(RulerFormat format) Get the time code's string representation using the given ruler format.
Parameters:
format: ruler format to use for cooersion
Void FromString(String timestamp) Set the time code from a string representation using the current project's ruler format.
Parameters:
timestamp: a string representation of the new time code
Void FromString(String timestamp, RulerFormat format) Set the time code from a string representation using the given ruler format.
Parameters:
timestamp: a string representation of the new time code
format: ruler format to use for cooersion
Double ToMilliseconds() Convert the time code to a number of milliseconds.
static Boolean operator <(Timecode left, Timecode right) Indicates whether one time code is less than another.
Parameters:
left: left hand side of operator
right: right hand side of operator
static Boolean operator >(Timecode left, Timecode right) Indicates whether one time code is greater than another.
Parameters:
left: left hand side of operator
right: right hand side of operator
static Boolean operator <=(Timecode left, Timecode right) Indicates whether one time code is less than or equal to another.
Parameters:
left: left hand side of operator
right: right hand side of operator
static Boolean op_GreaterThanOrEqual(Timecode left, Timecode right) Indicates whether one time code is greater than or equal to another.
Parameters:
left: left hand side of operator
right: right hand side of operator
static Timecode operator +(Timecode left, Timecode right) Add one time code to another.
Parameters:
left: left hand side of operator
right: right hand side of operator
static Timecode operator -(Timecode left, Timecode right) Subtract one time code to another.
Parameters:
left: left hand side of operator
right: right hand side of operator
static Timecode operator ++(Timecode value) Increment a time code by one frame.
Parameters:
value: Timecode value to increment
static Timecode operator --(Timecode value) Decrement a time code by one frame.
Parameters:
value: Timecode value to increment
virtual Int32 CompareTo(Object other) Compares this time code to another.
Parameters:
other: Timecode object which is compared to this instance.
class EffectPreset

Represents a set of predefined parameter values for an effect key frame.

Inherits from: System.Object
Public Properties: Summary:
String Name Get the name of the preset.
Public Methods: Summary:
virtual String ToString() Describe the preset as a string.
class EffectPresets

Collection of parameter presets for an effect.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Properties: Summary:
Boolean IsFixedSize Indicates whether the collection has a fixed size.
Boolean IsReadOnly Indicates whether the collection is read only.
class PlugInNode

Represents a node in the hierarchy of plug-in effects, transitions, and generators.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Properties: Summary:
Boolean IsFixedSize Indicates whether the collection has a fixed size.
String Name Get the name of the plug-in.
Boolean IsVideo Indicates whether or the the plug-in operates on video data.
Boolean IsAudio Indicates whether or the the plug-in operates on audio data.
Boolean IsContainer Indicates whether or the the node contains children.
Boolean IsReadOnly Indicates whether or the the node is read only.
Boolean CanCreateSubnodes Indicates whether or the the node can add child nodes.
Boolean IsDisabled Indicates whether or the the plug-in is disabled.
Boolean IsPackage Indicates whether or the the plug-in node is a package of other plug-ins.
Boolean IsAutomatable Indicates whether or the the plug-in is automatable.
Public Methods: Summary:
PlugInNode GetChild(Int32 index) Get the nth child of this node.
Parameters:
index: index of child node
PlugInNode GetChildByName(String name) Get a child node my name.
Parameters:
name: name of child node
class RenderTemplate

Represents a render template.

Inherits from: System.Object
Public Properties: Summary:
String Name Get the name of the render template.
class RenderTemplates

Collection of templates for a render plug-in.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Properties: Summary:
Boolean IsFixedSize Indicates whether the collection has a fixed size.
Boolean IsReadOnly Indicates whether the collection is read only.
class Renderer

Represents a render plug-in.

Inherits from: System.Object
Public Properties: Summary:
RenderTemplates Templates Get the collection of render templates for the render plug-in.
String Name Get the name of the render plug-in (same as FileTypeName).
String FileTypeName Get the name of the file type created by the render plug-in.
String FileExtension Get the file extension associated with the render plug-in.
Public Methods: Summary:
virtual String ToString() Combines the FileTypeName and FileExtension strings.
class Renderers

Collection of render plug-ins.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Properties: Summary:
Boolean IsFixedSize Indicates whether the collection has a fixed size.
Boolean IsReadOnly Indicates whether the collection is read only.
class EnvelopePoint

Represents an envelope point.

Inherits from: System.Object
Public Constructors: Summary:
EnvelopePoint(Timecode x, Double y, CurveType curveType) Create a new envelope point.
Parameters:
x: position of envelope point
y: value of envelope point
curveType: type of curve
EnvelopePoint(Timecode x, Double y) Create a new envelope point.
Parameters:
x: position of envelope point
y: value of envelope point
Public Properties: Summary:
Timecode X Get or set the time-wise position of the envelope point.
Double Y Get or set the value of the envelope point.
CurveType Curve Get or set the type of curve following the envelope point.
Public Methods: Summary:
Boolean IsValid() Indicates whether the envelope point has been added.
class EnvelopePoints

Collection of points in an envelope.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add a point to an envelope.
Parameters:
item: EnvelopePoint object to add
virtual Void Remove(Object item) Remove a point from an envelope.
Parameters:
item: EnvelopePoint object to remove
virtual Void Clear() Removes all envelope points from the collection except the first.
virtual Boolean Contains(Object item) Indicates if a point is contained in the collection.
Parameters:
item: EnvelopePoint or Timecode to test for membership.
EnvelopePoint GetPointAtX(Timecode x) Get the point (if any) at the given time code.
Parameters:
x: position of envelope point
class Envelope

Represents an envelope.

Inherits from: System.Object
Public Constructors: Summary:
Envelope(EnvelopeType type) Create a new envelope.
Parameters:
type: type of envelope
Public Properties: Summary:
EnvelopeType Type Get the type of envelope.
String Name Get the name of the envelope.
Int32 Index Get the index of the envelope.
Double Min Get the minimum value for points in the envelope.
Double Max Get the maximum value for points in the envelope.
Double Neutral Get the neutral value for points in the envelope.
EnvelopePoints Points Get the envelope's collection of points.
Public Methods: Summary:
Boolean IsValid() Indicates whether the envelope has been added.
Double ValueAt(Timecode position) Get the Y value of the envelope at the given position.
Parameters:
position: X position for value returned
class Envelopes

Collection of envelopes.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add an envelope to the collection.
Parameters:
item: Envelope object to add
virtual Void Remove(Object item) Remove an envelope from the collection.
Parameters:
item: Envelope object to remove
Boolean HasEnvelope(EnvelopeType type) Indicates whether the collection contains an envelope of the given type.
Parameters:
type: envelope type
class Keyframe

Represents a video effect key frame.

Inherits from: System.Object
Public Constructors: Summary:
Keyframe(Timecode position) Create a new key frame.
Parameters:
position: position of new key frame
Public Properties: Summary:
Timecode Position Get or set the position of the key frame.
VideoKeyframeType Type Get or set the interpolation type for this key frame.
String Preset Set the parameters preset for this key frame.
Public Methods: Summary:
Boolean IsValid() Indicates whether the key frame has been added to an effect.
class Keyframes

Collection of effect key frames.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add a key frame.
Parameters:
item: Keyframe object to add
virtual Void Remove(Object item) Remove a key frame.
Parameters:
item: Keyframe object to add
class Effect

Represents an instance of an effect, transitions, or generator.

Inherits from: System.Object
Public Constructors: Summary:
Effect(PlugInNode plugIn) Create a new effect.
Parameters:
plugIn: plug-in to use for the effect
Public Properties: Summary:
PlugInNode PlugIn Get the effect's plug-in.
String Description Get the effect's plug-in description.
Keyframes Keyframes Get the collection of key frames for the effect.
EffectPresets Presets Get the collection of effect presets.
String Preset Set the effect parameters preset for the first key frame.
Public Methods: Summary:
Boolean IsValid() Indicates whether the effect has been added.
class Effects

Collection of plug-in effects.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add an effect.
Parameters:
item: Effect object to add
virtual Void Remove(Object item) Remove an effect.
Parameters:
item: Effect object to remove
class MediaStream

Represents a media stream.

Inherits from: System.Object
Public Properties: Summary:
MediaType MediaType Get the stream's media type.
Timecode Offset Get the start offset of the media stream.
Timecode Length Get the length of the media stream.
class AudioStream

Represents an audio stream.

Inherits from: Sony.MediaSoftware.Vegas.MediaStream
Public Properties: Summary:
UInt32 SampleRate Get the audio stream's sample rate.
UInt32 BitDepth Get the audio stream's bit depth.
Int32 Channels Get the audio stream's number of channels.
String Format Get the audio stream's encoding format.
Int64 AverageDataRate Get the audio stream's average data rate.
class VideoStream

Represents a video stream.

Inherits from: Sony.MediaSoftware.Vegas.MediaStream
Public Properties: Summary:
Int32 Width Get the video stream's pixel width.
Int32 Height Get the video stream's pixel height.
Double FrameRate Get the video stream's frame rate.
VideoFieldOrder FieldOrder Get or set the video stream's field order.
Double PixelAspectRatio Get or set the video stream's pixel aspect ratio.
Int32 ColorDepth Get the video stream's color depth.
VideoAlphaType AlphaChannel Get or set the video stream's alpha channel type.
Int64 AverageDataRate Get the video stream's average data rate.
String Format Get the video stream's encoding format.
VideoColor BackgroundColor Get or set the video stream's background color.
class MediaStreams

Collection of media streams.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Properties: Summary:
Boolean IsFixedSize Indicates whether the collection has a fixed size.
Boolean IsReadOnly Indicates whether the collection is read only.
Public Methods: Summary:
MediaStream GetItemByMediaType(MediaType type, Int32 index) Get the nth media stream of a given media type.
Parameters:
type: media type of stream
index: type-wise zero-based index of media stream
class Media

Represents a media file referenced by a Vegas project.

Inherits from: System.Object
Public Constructors: Summary:
Media(String path) Create a new media file reference.
Parameters:
path: full path of media file
Media(PlugInNode generator, String presetName) Create a media reference based on a generator plug-in.
Parameters:
generator: generator plug-in to use
presetName: name of plug-in preset to use
Public Properties: Summary:
MediaStreams Streams Get the collection of media streams.
Effects Effects Get the collection of effects associated with the media.
String FilePath Get the full path of the media file.
String KeyString Get the key string for generated media.
Boolean UseCustomTimecode Get or set whether custom time code is used for the media.
Timecode TimecodeIn Get or set the start time code for the media.
Timecode TimecodeOut Get the end time code for the media.
Timecode Length Get the length of the media.
RulerFormat RulerFormat Get or set the ruler format used to represent the media's time code.
String Comment Get or set the comment for the media.
String TapeName Get or set the tape name associated with the media.
Int64 AverageDataRate Get the average total data rate in bytes per second.
Int32 UseCount Get the number of references to the media in the project.
Public Methods: Summary:
Boolean IsValid() Indicates whether the media file is valid.
Boolean IsGenerated() Indicates whether the media is generated by a plug-in.
Boolean IsImageSequence() Indicates whether the media is an image sequence.
Int32 StreamCount(MediaType type) Get the number of streams of a particular media type.
Parameters:
type: media type of streams to count
Boolean HasAudio() Indicated whether the media contains audio streams.
Boolean HasVideo() Indicated whether the media contains video streams.
class MediaPool

Collection of media used in a project.

Inherits from: System.Object
Public Properties: Summary:
Int32 Count Get the number of media objects in the collection.
Boolean IsSynchronized Indicates whether access to the collection is thread safe.
Object SyncRoot Get the object that can be used to to synchronize access to the collection.
Boolean IsFixedSize Indicates whether the collection has a fixed size.
Boolean IsReadOnly Indicates whether the collection is read only.
Object Item Get a media object by name (file path).
ICollection Keys not supported
ICollection Values not supported
MediaBin RootMediaBin Get the top level media bin.
Public Methods: Summary:
virtual Void CopyTo(Array array, Int32 index) Copies the items in the collection to an array.
Parameters:
array: destination array of media pool items
index: start index for items in the array
virtual Void Add(Object , Object ) not supported (use the Media object constructor)
Parameters:
:
:
virtual Void Clear() not supported
virtual Boolean Contains(Object key) Indicates whether the given object is contained in the media pool.
Parameters:
key: full path of media file
virtual IDictionaryEnumerator GetEnumerator() Get a new enumerator for the media pool.
virtual Void Remove(Object key) Remove the given media object from the pool.
Parameters:
key: full path of media file
Media Find(String path) Find a media object whose file path is the given string.
Parameters:
path: full path of media file or display name of generated media
class MediaPoolEnumerator

Enumerator of media referenced by a project.

Inherits from: System.Object
Public Properties: Summary:
Object Current Get the current media object in the enumeration.
DictionaryEntry Entry Get the dictionary entry for the current item.
Object Key Get the key string (file path) of the current item.
Object Value Get the current media object in the enumeration.
Public Methods: Summary:
virtual Boolean MoveNext() Move to the next object in the enumeration.
virtual Void Reset() Reset the enumeration.
class MediaBin

Represents a node in the hierarchy of media bins.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Constructors: Summary:
MediaBin(String name) Create a new media bin.
Parameters:
name: name of new media bin
Public Properties: Summary:
String Name Get or set the name of the media bin.
MediaBin Parent Get the parent of this media bin.
Public Methods: Summary:
Boolean IsValid() Indicates whether the media bin is the root or has been added to a parent.
Boolean IsRoot() Indicates whether the media bin is the top-level bin.
virtual Int32 Add(Object item) Add a new media bin or media object.
Parameters:
item: MediaBin or Media object to add
virtual Void Remove(Object item) Remove a media bin or media object.
Parameters:
item: media bin or media object to remove
virtual Int32 IndexOf(Object item) Get the index of the given media bin or media object.
Parameters:
item: object whose index is determined
class Take

Represents a take for an event.

Inherits from: System.Object
Public Constructors: Summary:
Take(MediaStream mediaStream, Boolean makeActive, String name) Creates a new take.
Parameters:
mediaStream: media stream object to use for take
makeActive: make take active when added
name: name of new take
Take(MediaStream mediaStream, Boolean makeActive) Creates a new take.
Parameters:
mediaStream: media stream object to use for take
makeActive: make take active when added
Take(MediaStream mediaStream) Creates a new take.
Parameters:
mediaStream: media stream object to use for take
Public Properties: Summary:
Int32 Index Get the index of the take in its event's collection of takes.
String MediaPath Get the path of the media file associated with the take.
String Name Get or set the name of the take.
Int32 StreamIndex Get the index of the media stream associated with the take.
Timecode Offset Get or set the start time of the take's media stream.
Timecode Length Get the length of the take's media stream.
Timecode AvailableLength Get the length of time available in the take's media stream.
Boolean IsActive Indicates whether or not the take is active.
Public Methods: Summary:
Boolean IsValid() Indicates whether the take has been added to an event.
class Takes

Collection of takes associated with an event.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add a take to an event.
Parameters:
item: Take object to add
virtual Void Remove(Object item) Remove a take from an event.
Parameters:
item: Take object to remove
class Fade

Represents the fade (in or out) of an event.

Inherits from: System.Object
Public Properties: Summary:
Timecode Length Get or set the length of the fade.
CurveType Curve Get or set the type of curve of the fade.
CurveType ReciprocalCurve Get or set the type of curve of the inverse fade.
Single Gain Get or set the peak gain of the fade.
Object Transition Get or set the transition effect used in the fade.
Public Methods: Summary:
Boolean RemoveTransition() Remove any transition effect used in the fade.
class VideoMotion

Represents the motion of a video event.

Inherits from: System.Object
Public Properties: Summary:
Boolean ScaleToFill Get or set whether to scale the video to fill the output.
VideoMotionKeyframes Keyframes Get the collection of video motion key frames.
class VideoMotionVertex

Represents a vertex used in video motion key frames.

Inherits from: System.Object
Public Constructors: Summary:
VideoMotionVertex(Single x, Single y) Create a new video motion vertex.
Parameters:
x: x coordinate
y: y coordinate
Public Properties: Summary:
Single X Get or set the x (horizontal) coordinate.
Single Y Get or set the y (horizontal) coordinate.
Public Methods: Summary:
virtual String ToString() Converts the vertex to a string for display.
class VideoMotionBounds

Represents a 4 sided bounds polygon used in video motion key frames.

Inherits from: System.Object
Public Constructors: Summary:
VideoMotionBounds(VideoMotionVertex topLeft, VideoMotionVertex topRight, VideoMotionVertex bottomRight, VideoMotionVertex bottomLeft) Create a new video motion bounds polygon.
Parameters:
topLeft: top left vertex
topRight: top right vertex
bottomRight: bottom right vertex
bottomLeft: bottom left vertex
VideoMotionBounds(Single topLeftX, Single topLeftY, Single topRightX, Single topRightY, Single bottomRightX, Single bottomRightY, Single bottomLeftX, Single bottomLeftY) Create a new video motion bounds polygon.
Parameters:
topLeftX: X coordinate of top left vertex
topLeftY: Y coordinate of top left vertex
topRightX: X coordinate of top right vertex
topRightY: Y coordinate of top right vertex
bottomRightX: X coordinate of bottom right vertex
bottomRightY: Y coordinate of bottom right vertex
bottomLeftX: X coordinate of bottom left vertex
bottomLeftY: Y coordinate of bottom left vertex
Public Properties: Summary:
VideoMotionVertex TopLeft Get or set the top left vertex.
VideoMotionVertex TopRight Get or set the top right vertex.
VideoMotionVertex BottomRight Get or set the bottom right vertex.
VideoMotionVertex BottomLeft Get or set the bottom left vertex.
class VideoMotionKeyframe

Represents a key frame for video event motion parameters.

Inherits from: System.Object
Public Constructors: Summary:
VideoMotionKeyframe(Timecode position) Create a new video motion key frame.
Parameters:
position: position of key frame
Public Properties: Summary:
Timecode Position Get or set the position of the video motion key frame.
VideoMotionVertex TopLeft Get the top left vertex.
VideoMotionVertex TopRight Get the top right vertex.
VideoMotionVertex BottomRight Get the bottom right vertex.
VideoMotionVertex BottomLeft Get the bottom left vertex.
VideoMotionVertex Center Get or set the center of rotation.
VideoMotionBounds Bounds Get or set the video motion keyframe's bounds polygon.
Double Rotation Get or set the rotation angle (in radians)
VideoKeyframeType Type Get or set the interpolation type for this key frame.
Public Methods: Summary:
Boolean IsValid() Indicates whether key frame has been added.
Void MoveBy(VideoMotionVertex delta) Translate all vertices by the given x and y distances
Parameters:
delta: x and y distances
Void ScaleBy(VideoMotionVertex delta) Scale all vertices by the given x and y factors
Parameters:
delta: x and y scale factors
Void RotateBy(Double delta) Rotate all vertices by the given angle
Parameters:
delta: angle of rotation (in radians)
class VideoMotionKeyframes

Collection of video motion key frames for a video event.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add a video motion key frame to an event.
Parameters:
item: VideoMotionKeyframe object to add
virtual Void Remove(Object item) Remove a video motion key frame to an event.
Parameters:
item: VideoMotionKeyframe object to remove
abstract class TrackEvent

Represents a track event.

Inherits from: System.Object
Public Properties: Summary:
MediaType MediaType Get the event's media type.
Track Track Get or set the event's track.
Takes Takes Get the event's collection of takes.
Take ActiveTake Get or set the event's active take.
Fade FadeIn Get an object that represents the event's fade in.
Fade FadeOut Get an object that represents the event's fade out.
Int32 Index Get the event's index in its track's collection of events.
String Name Get or set the event's name.
Timecode Start Get or set the event's start time.
Timecode Length Get or set the event's length.
Double PlaybackRate Get or set the event's playback rate.
Boolean Mute Get or set whether the event is muted.
Boolean Locked Get or set whether the event is locked.
Boolean Loop Get or set whether the event is looped.
Boolean Selected Get or set whether the event is selected.
Public Methods: Summary:
abstract Boolean IsAudio() Indicates if the event's media type is audio.
abstract Boolean IsVideo() Indicates if the event's media type is video.
Boolean IsValid() Indicates if the event has been added to a track.
Void AdjustStartLength(Timecode start, Timecode length, Boolean adjustLeft) Adjusts the event's start time and length.
Parameters:
start: new start of event
length: new length of event
adjustLeft: whether to adjust the start (true) or end (false) of the event's take
TrackEvent Split(Timecode offset) Split the event at the given offset.
Parameters:
offset: position of the split relative to the event start.
TrackEvent Copy(Track destination, Timecode start) Copy the event and place it in the given track at the given start time.
Parameters:
destination: destination track of duplicate event.
start: start time of duplicate event.
Void AdjustPlaybackRate(Double rate, Boolean adjustStart) Adjusts the event's playback rate.
Parameters:
rate: new playback rate
adjustStart: whether to alter the start or the end of the event's take
class AudioEvent

Represents an audio event.

Inherits from: Sony.MediaSoftware.Vegas.TrackEvent
Public Constructors: Summary:
AudioEvent(Timecode start, Timecode length, String name) Creates a new audio event.
Parameters:
start: start time of event
length: length of event
name: name of event
AudioEvent(Timecode start, Timecode length) Creates a new audio event.
Parameters:
start: start time of event
length: length of event
AudioEvent(Timecode start) Creates a new audio event.
Parameters:
start: start time of event
AudioEvent() Creates a new audio event.
Public Properties: Summary:
MediaType MediaType Get the event's media type.
Boolean Normalize Get or set whether to normalize audio data.
Boolean InvertPhase Get or set whether to invert the phase of audio data.
ChannelRemapping Channels Get or set how audio channels are remapped.
Public Methods: Summary:
virtual Boolean IsAudio() Indicates if the event's media type is audio.
virtual Boolean IsVideo() Indicates if the event's media type is video.
Double RecalculateNorm() Forces the audio event to recalculate its normalization gain.
class VideoEvent

Represents an video event.

Inherits from: Sony.MediaSoftware.Vegas.TrackEvent
Public Constructors: Summary:
VideoEvent(Timecode start, Timecode length, String name) Creates a new video event.
Parameters:
start: start time of event
length: length of event
name: name of event
VideoEvent(Timecode start, Timecode length) Creates a new video event.
Parameters:
start: start time of event
length: length of event
VideoEvent(Timecode start) Creates a new video event.
Parameters:
start: start time of event
VideoEvent() Creates a new video event.
Public Properties: Summary:
MediaType MediaType Get the event's media type.
Envelopes Envelopes Get the video event's collection of envelopes.
Effects Effects Get the video event's collection of effects.
Double UnderSampleRate Get or set the undersample rate for video events.
Boolean MaintainAspectRatio Get or set whether to maintain the video aspect ratio.
Boolean ReduceInterlace Get or set whether to reduce video interlacing.
VideoResampleMode ResampleMode Get or set the method by which video frames are resampled.
VideoMotion VideoMotion Get an object that represents the event's motion settings.
Public Methods: Summary:
virtual Boolean IsAudio() Indicates if the event's media type is audio.
virtual Boolean IsVideo() Indicates if the event's media type is video.
class TrackEvents

Collection of track events.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add an event to a track.
Parameters:
item: TrackEvent object to add
virtual Void Remove(Object item) Remove an event from a track.
Parameters:
item: TrackEvent object to remove
abstract class Track

Represents an audio or video track.

Inherits from: System.Object
Public Properties: Summary:
MediaType MediaType Get the track's media type.
TrackEvents Events Get the collection of track events.
Envelopes Envelopes Get the collection of track envelopes.
Effects Effects Get the collection of track effects.
String Name Get or set the name of the track.
Timecode Length Get the length of the track.
Int32 Index Get the index of the track in the collection of all tracks.
Int32 DisplayIndex Get the display index of the track.
Boolean Solo Get or set whether the track is soloed.
Boolean Mute Get or set whether the track is muted.
Boolean Hidden Get or set whether the track is hidden.
Boolean Locked Get or set whether the track is locked.
Boolean Selected Get or set whether the track is selected.
BusTrack BusTrack Get or set the bus to which the track is routed.
Public Methods: Summary:
abstract Boolean IsAudio() Indicates if the track's media type is audio.
abstract Boolean IsVideo() Indicates if the track's media type is video.
Boolean IsValid() Indicates if the track has been added to the project.
class AudioTrack

Represents an audio track.

Inherits from: Sony.MediaSoftware.Vegas.Track
Public Constructors: Summary:
AudioTrack(Int32 index, String name) Creates a new audio track.
Parameters:
index: display index of new track
name: name of new track
AudioTrack(Int32 index) Creates a new audio track.
Parameters:
index: display index of new track
AudioTrack() Creates a new audio track.
Public Properties: Summary:
MediaType MediaType Get the track's media type.
Boolean InvertPhase Get or set whether the track's audio is phase inverted.
Public Methods: Summary:
virtual Boolean IsAudio() Indicates if the track's media type is audio.
virtual Boolean IsVideo() Indicates if the track's media type is video.
class VideoTrack

Represents a video track.

Inherits from: Sony.MediaSoftware.Vegas.Track
Public Constructors: Summary:
VideoTrack(Int32 index, String name) Creates a new video track.
Parameters:
index: display index of new track
name: name of new track
VideoTrack(Int32 index) Creates a new video track.
Parameters:
index: display index of new track
VideoTrack() Creates a new video track.
Public Properties: Summary:
MediaType MediaType Get the track's media type.
VideoColor TopFadeColor Get or set the track's top fade color (video only).
VideoColor BottomFadeColor Get or set the track's bottom fade color (video only).
Public Methods: Summary:
virtual Boolean IsAudio() Indicates if the track's media type is audio.
virtual Boolean IsVideo() Indicates if the track's media type is video.
class Tracks

Collection of tracks in a project.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add a track to the project.
Parameters:
item: Track object to add
virtual Void Remove(Object item) Remove a track from the project.
Parameters:
item: Track object to remove
class BusTracks

Collection of bus tracks.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add a bus track to the project.
Parameters:
item: object to be added
virtual Void Remove(Object item) Remove a bus track from the project.
Parameters:
item: object to be removed
virtual Void Clear() Removes all bus tracks from the collection except the master audio and video.
abstract class BusTrack

Represents a bus track.

Inherits from: System.Object
Public Properties: Summary:
MediaType MediaType Get the media type of the bus track.
String Name Get the name of the bus track.
String Description Get or set the description of the bus track.
Envelopes Envelopes Get the bus track's collection of envelopes.
Effects Effects Get the bus track's collection of effects.
Public Methods: Summary:
Boolean IsValid() Indicates whether the bus track has been added.
abstract Boolean IsAudio() Indicates whether the media type of the bus track is audio.
abstract Boolean IsVideo() Indicates whether the bus track is the master video bus.
Boolean IsMaster() Indicates whether the bus track is the (audio or video) master bus.
class AudioBusTrack

Represents an audio bus track.

Inherits from: Sony.MediaSoftware.Vegas.BusTrack
Public Constructors: Summary:
AudioBusTrack() Create a new audio bus track.
Public Properties: Summary:
MediaType MediaType Get the media type of the bus track.
String Name Get the name of the audio bus track.
String Description Get or set the description of the audio bus track.
Boolean Solo Get or set whether of not the bus track is soloed.
Boolean Mute Get or set whether of not the bus track is muted.
PanType PanType Get or set the audio bus track pan type setting.
Public Methods: Summary:
virtual Boolean IsAudio() Indicates whether the media type of the bus track is audio.
virtual Boolean IsVideo() Indicates whether the bus track is the master video bus.
class VideoBusTrack

Represents a video bus track.

Inherits from: Sony.MediaSoftware.Vegas.BusTrack
Public Properties: Summary:
MediaType MediaType Get the media type of the bus track.
String Name Get the name of the bus track.
String Description Get the description of the video bus track.
VideoColor TopFadeColor Get or set the video bus track's top fade color.
VideoColor BottomFadeColor Get or set the video bus track's bottom fade color.
Boolean Bypass Get or set whether the video bus track's effects and envelopes are bypassed.
Public Methods: Summary:
virtual Boolean IsAudio() Indicates whether the media type of the bus track is audio.
virtual Boolean IsVideo() Indicates whether the bus track is the master video bus.
class Marker

Represents a marker on the project's time line.

Inherits from: System.Object
Public Constructors: Summary:
Marker(Timecode position) Create a new marker
Parameters:
position: position of new marker
Marker(Timecode position, String label) Create a new marker.
Parameters:
position: position of new marker
label: label of new marker
Public Properties: Summary:
Timecode Position Get or set the marker's position.
String Label Get or set the marker's label.
Public Methods: Summary:
Boolean IsValid() Indicates whether the marker has been added.
class CDMarker

Represents a CD track index marker.

Inherits from: Sony.MediaSoftware.Vegas.Marker
Public Constructors: Summary:
CDMarker(Timecode position) Create a new CD track index marker.
Parameters:
position: position of new CD marker
CDMarker(Timecode position, String label) Create a new CD track index marker.
Parameters:
position: position of new CD marker
label: label of new CD marker
class MarkerCommandType

Command marker types

Inherits from: System.Object
Public Constructors: Summary:
MarkerCommandType(String cmd) Constructs a command marker type with a custom type string
Parameters:
cmd: custom command string
Public Methods: Summary:
virtual String ToString() Converts marker command type to its string representation.
class CommandMarker

Represents a command marker.

Inherits from: Sony.MediaSoftware.Vegas.Marker
Public Constructors: Summary:
CommandMarker(Timecode position) Create a new command marker.
Parameters:
position: position of new command marker
CommandMarker(Timecode position, MarkerCommandType cmd, String param) Create a new command marker.
Parameters:
position: position of new command marker
cmd: type of new command marker
param: parameter of new command marker
CommandMarker(Timecode position, MarkerCommandType cmd, String param, String comment) Create a new command marker.
Parameters:
position: position of new command marker
cmd: type of new command marker
param: parameter of new command marker
comment: comment of new command marker
Public Properties: Summary:
String Label Not supported for command markers.
String Comment Get or set the command marker's comment.
MarkerCommandType CommandType Get the command marker's type.
String CommandParameter Get the command marker's parameter.
Public Methods: Summary:
Void SetCommand(MarkerCommandType cmdType, String param) Get the command marker's type and parameter.
Parameters:
cmdType: type of command
param: command parameter
class Region

Represents a region marker on the project time line.

Inherits from: Sony.MediaSoftware.Vegas.Marker
Public Constructors: Summary:
Region(Timecode position, Timecode length) Create a new region marker.
Parameters:
position: position of new region
length: length of new region
Region(Timecode position, Timecode length, String label) Create a new region marker.
Parameters:
position: position of new region
length: length of new region
label: label of new region
Public Properties: Summary:
Timecode Length Get or set the region marker's length.
class CDRegion

Represents a CD track region marker.

Inherits from: Sony.MediaSoftware.Vegas.Region
Public Constructors: Summary:
CDRegion(Timecode position, Timecode length) Create a new CD track region marker.
Parameters:
position: position of new CD region
length: length of new CD region
CDRegion(Timecode position, Timecode length, String label) Create a new CD track region marker.
Parameters:
position: position of new CD region
length: length of new CD region
label: label of new CD region
class Markers

Collection of time line markers.

Inherits from: Sony.MediaSoftware.Vegas.BaseList
Public Methods: Summary:
virtual Int32 Add(Object item) Add a marker to the project.
Parameters:
item: Marker object to add
virtual Void Remove(Object item) Remove a marker from the project.
Parameters:
item: Marker object to remove
class VideoProperties

Base class for objects that represent video properties.

Inherits from: System.Object
Public Properties: Summary:
Int32 Width Get or set the pixel width.
Int32 Height Get or set the pixel height.
Double FrameRate Get or set the frame rate.
VideoFieldOrder FieldOrder Get or set the field order.
Double PixelAspectRatio Get or set the pixel aspect ratio.
class ProjectVideoProperties

Represents a project's video properties.

Inherits from: Sony.MediaSoftware.Vegas.VideoProperties
Public Properties: Summary:
Int32 Width Get or set the pixel width.
Int32 Height Get or set the pixel height.
Double FrameRate Get or set the frame rate.
VideoFieldOrder FieldOrder Get or set the field order.
Double PixelAspectRatio Get or set the pixel aspect ratio.
VideoRenderQuality RenderQuality Get or set the render quality.
MotionBlurType MotionBlurType Get or set the motion blur type.
VideoDeinterlaceMethod DeinterlaceMethod Get or set the deinterlace method.
String PrerenderedFilesFolder Get or set the folder containing pre-rendered files.
class PreviewVideoProperties

Represents a project's preview video properties.

Inherits from: Sony.MediaSoftware.Vegas.VideoProperties
Public Properties: Summary:
VideoRenderQuality RenderQuality Get or set the preview render quality.
Boolean FullSize Get or set whether the video preview is rendered at full size.
class AudioProperties

Base class for objects that represent audio properties.

Inherits from: System.Object
Public Properties: Summary:
UInt32 SampleRate Get or set the sample rate.
UInt32 BitDepth Get or set the bit depth.
class ProjectAudioProperties

Represents a project's audio properties.

Inherits from: Sony.MediaSoftware.Vegas.AudioProperties
Public Properties: Summary:
UInt32 SampleRate Get or set the sample rate.
UInt32 BitDepth Get or set the bit depth.
AudioBusMode MasterBusMode Get or set the audio bus mode.
AudioResampleQuality ResampleQuality Get or set the audio resample quality.
Boolean LFELowpassFilterEnabled Get or set whether the LFE low-pass filter is enabled.
UInt32 LFELowpassFilterCutoffFrequency Get or set the LFE low-pass filter cutoff frequency.
LowPassFilterQuality LFELowpassFilterQuality Get or set the LFE low-pass filter quality.
String RecordedFilesFolder Get or set the folder containing recorded files.
class RulerProperties

Represents a project's ruler properties.

Inherits from: System.Object
Public Properties: Summary:
RulerFormat Format Get or set the ruler format.
Timecode StartTime Get or set the ruler start time.
Double BeatsPerMinute Get or set the beats per minute.
UInt32 BeatsPerMeasure Get or set the beats per measure.
BeatValue BeatValue Get or set the beat value.
class SummaryProperties

Represents a project's summary properties.

Inherits from: System.Object
Public Properties: Summary:
String Title Get or set the title.
String Artist Get or set the artist.
String Engineer Get or set the engineer.
String Copyright Get or set the copyright.
String Comments Get or set the comments.
class AudioCDProperties

Represents a project's audio CD properties.

Inherits from: System.Object
Public Properties: Summary:
String UPC Get or set the UPC code.
UInt32 FirstTrack Get or set the first track index.
class Project

Represents the currently opened project.

Inherits from: System.Object
Public Constructors: Summary:
Project(Boolean promptSave, Boolean showDialog) Creates a new Vegas project.
Parameters:
promptSave: prompt user to save existing project if needed
showDialog: show the new project dialog
Project() Creates a new Vegas project.
Public Properties: Summary:
Tracks Tracks Get the collection of tracks.
BusTracks BusTracks Get the collection of bus tracks.
MediaPool MediaPool Get the collection of media.
Markers Markers Get the collection of time line markers.
Markers Regions Get the collection of time line region markers.
Markers CDIndices Get the collection of CD index markers.
Markers CDTracks Get the collection of CD track markers.
Markers CommandMarkers Get the collection of command markers.
ProjectVideoProperties Video Get the object representing the project's video properties.
PreviewVideoProperties Preview Get the object representing the project's preview video properties.
ProjectAudioProperties Audio Get the object representing the project's audio properties.
RulerProperties Ruler Get the object representing the project's ruler properties.
SummaryProperties Summary Get the object representing the project's summary properties.
AudioCDProperties AudioCD Get the object representing the project's audio CD properties.
Timecode Length Get the length of the entire project.
Boolean IsModified Get whether the project has been modified.
String FilePath Get the full path of the project file.
Public Methods: Summary:
Void InsertTime(Timecode start, Timecode length) Inserts time into the project.
Parameters:
start: start of inserted time
length: length of inserted time
Void InsertTime() Inserts time into the project.
class Vegas

Represents the Vegas application.

Inherits from: System.Object
Public Properties: Summary:
String Version Get the version of Vegas.
Project Project Get the current Project
PlugInNode PlugIns Get the root plug-in node.
PlugInNode VideoFX Get the root plug-in node for video effects.
PlugInNode AudioFX Get the root plug-in node for audio effects.
PlugInNode Transitions Get the root plug-in node for video transitions.
PlugInNode Generators Get the root plug-in node for video generators.
Renderers Renderers Get the collection of render plug-ins.
Timecode Cursor Get or set the current cursor location.
Timecode SelectionStart Get or set the start of the selection region.
Timecode SelectionLength Get or set the length of the selection region.
Boolean LoopPlayback Get or set whether playback is looped around the selection.
Boolean BypassAllAudioFX Get or set whether all audio effects are bypassed.
Public Methods: Summary:
Boolean NewProject(Boolean promptSave, Boolean showDialog) Creates a new project.
Parameters:
promptSave: prompt user to save existing project if needed
showDialog: show the new project dialog
Boolean NewProject() Creates a new project.
Boolean SaveProject(String fileName) Saves the current project to disk.
Parameters:
fileName: full path and file name of project file
Boolean SaveProject() Saves the current project to disk.
Boolean OpenProject(String fileName) Opens a project file from disk.
Parameters:
fileName: full path and file name of project file
Boolean OpenProject() Opens a project file from disk.
RenderStatus Render(String outputFile, RenderTemplate renderTemplate, Timecode start, Timecode length) Renders the current project.
Parameters:
outputFile: full path of rendered output file
renderTemplate: render template to use
start: project start time of rendered output
length: length of rendered output
RenderStatus Render(String outputFile, RenderTemplate renderTemplate) Renders the current project.
Parameters:
outputFile: full path of rendered output file
renderTemplate: render template to use
RenderStatus SaveSnapshot(String outputFile, ImageFileFormat format, Timecode seekTime) Renders and saves a still image file to disk.
Parameters:
outputFile: full path of rendered output file
format: image file format
seekTime: project position of image
RenderStatus SaveSnapshot(String outputFile, ImageFileFormat format) Renders and saves a still image file to disk.
Parameters:
outputFile: full path of rendered output file
format: image file format
RenderStatus SaveSnapshot(Timecode seekTime) Renders and saves a still image file to the clipboard.
Parameters:
seekTime: project position of image
RenderStatus SaveSnapshot() Renders and saves a still image file to the clipboard.
Void UpdateUI() Redraws the Vegas user interface.
Void Exit() Quits the Vegas application upon completion of the script.


Class Index:

A:
AudioBusMode
AudioBusTrack
AudioCDProperties
AudioEvent
AudioProperties
AudioResampleQuality
AudioStream
AudioTrack

B:
BaseList
BaseListEnumerator
BeatValue
BusTrack
BusTracks

C:
CDMarker
CDRegion
ChannelRemapping
CommandMarker
CurveType

D:

E:
Effect
EffectPreset
EffectPresets
Effects
Envelope
EnvelopePoint
EnvelopePoints
Envelopes
EnvelopeType

F:
Fade

G:

H:

I:
ImageFileFormat

J:

K:
Keyframe
Keyframes

L:
LowPassFilterQuality

M:
Marker
MarkerCommandType
Markers
Media
MediaBin
MediaPool
MediaPoolEnumerator
MediaStream
MediaStreams
MediaType
MotionBlurType

N:

O:

P:
PanType
PlugInNode
PreviewVideoProperties
Project
ProjectAudioProperties
ProjectVideoProperties

Q:

R:
Region
Renderer
Renderers
RenderStatus
RenderTemplate
RenderTemplates
RulerFormat
RulerProperties

S:
SummaryProperties

T:
Take
Takes
Timecode
Track
TrackEvent
TrackEvents
Tracks

U:

V:
Vegas
VideoAlphaType
VideoBusTrack
VideoColor
VideoDeinterlaceMethod
VideoEvent
VideoFieldOrder
VideoKeyframeType
VideoMotion
VideoMotionBounds
VideoMotionKeyframe
VideoMotionKeyframes
VideoMotionVertex
VideoProperties
VideoRenderQuality
VideoResampleMode
VideoStream
VideoTrack

W:

X:

Y:

Z: