Script Dictionary of VideoSummary

VS Suite: VideoSummary specific classes and commands

Classes

• Class application (application) pl. = applications: The VideoSummary application.
  Properties
  • caption type (CaptionType): Type of caption
  • cell height (integer): Height of image cell in pixels
  • cell width (integer): Width of image cell in pixels
  • compression factor (float): Compression factor for saving image.
  • compression method (CompMethodType): Compression method for TIFF image.
  • direction type (DirectionType): Direction of cell arrangement
  • font size (integer): Size of font for caption text
  • magnification scale (float): Magnification (shrinking) scale of frames
  • number of columns (integer): Number of columns in summary image
  • number of rows (integer): Number of rows in summary image
  • postfix number (integer): The first number for postfix of image filenames when saving separately
  • saving separately (boolean): Saves built image separately for each cell if this value is true
  • spacing (integer): Number of pixels between cells in summary image
  • spanning interval (float): Time in seconds for spanning in constant interval
  • spanning type (SpanningType): Type of spanning method through the movie
  • still rendering (boolean): Boolean value indicating if still rendering image now. (read only)
  Supported Commands
  • build, load movie, save image

Commands

• Command build: Build up a summary image.
• Command load movie: Load a movie file.
  • in (alias): The movie file from which to extract frames.
• Command save image: Save a summary image into a file.
  • in (alias): The file in which to save the image. (optional)

Enumerations

• Enumeration CaptionType
  • none: No caption.
  • number: Numbers from 1 to N.
  • time: Time stamp from the beginning of the movie.
• Enumeration CompMethodType
  • LZW: Lempel-Ziv-Welch compression.
  • none: No compression.
  • pack bits: PackBits compression.
• Enumeration DirectionType
  • down: Arranges the cells from top to bottom.
  • up: Arranges the cells from bottom to top.
• Enumeration SpanningType
  • constant interval: Even time span in constant interval.
  • even: Even time span throughout the target duration.
  • stepwise: Frame by frame from the beginning of target duration.