 |
| |
An IDLgrMPEG object creates an MPEG movie file from an array of image frames.
See IDLgrMPEG::Init
IDLgrMPEG::CleanupThe IDLgrMPEG:: Cleanup procedure method performs all cleanup on the object. IDLgrMPEG is described above.
NOTE: Cleanup methods are special lifecycle methods , and as such cannot be called outside the context of object destruction. This means that in most cases, you cannot call the Cleanup method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Cleanup method from within the Cleanup method of the subclass.
IDLgrMPEG::GetPropertyThe IDLgrMPEG:: GetProperty procedure method retrieves the value of a property or group of properties for the MPEG object. IDLgrMPEG is described above.
Any keyword to IDLgrMPEG::Init
IDLgrMPEG::InitThe IDLgrMPEG:: Init function method initializes the MPEG object. IDLgrMPEG is described above.
NOTE: Init methods are special lifecycle methods , and as such cannot be called outside the context of object creation. This means that in most cases, you cannot call the Init method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Init method from within the Init method of the subclass.
Properties retrievable via IDLgrMPEG::GetProperty
Set this keyword to a 2-element array specifying the dimensions (in pixels) of each of the images to be used as frames for the movie. If this property is not specified, the dimensions of the first image loaded will be used. Once IDLgrMPEG::Put has been called, this keyword can no longer be set.
Set this keyword to a string representing the name of the file in which the encoded MPEG sequence is to be stored. The default is
'idl.mpg'
.
Set this keyword to one of the following values to specify the type of MPEG encoding to use:
Set this keyword to one of the following integer values to specify the frame rate used in creating the MPEG file:
Set this keyword to indicate that frames in the encoded MPEG file should be interlaced. The default is non-interlaced.
Set this keyword to a value in the range from 0 (low quality) to 100 (high quality) indicating the quality at which the MPEG stream is to be stored. Higher quality factors result in lower rates of compression. The default is 100.
Set this keyword to a two-element vector, [ xscale , yscale ], indicating the scale factors to be stored with the MPEG file as hints for playback. The default is [1.0, 1.0], indicating that the movie should be played back at the dimensions of the stored image frames.
Set this keyword to save statistical information about MPEG encoding for the supplied image frames in a file when the IDLgrMPEG::Save method is called. The information will be saved in a file with a name that matches that specified by the FILENAME keyword, with the extension "
.stat
". By default, statistics are not saved.
IDLgrMPEG::PutThe IDLgrMPEG:: Put procedure method puts a given image into the MPEG sequence at the specified frame. Note that all images in a given MPEG movie must have matching dimensions. If no dimensions were explicitly specified when the MPEG object was initialized, the dimensions will be set according to the dimensions of the first image. IDLgrMPEG is described above.
An instance of an IDLgrImage object or a m x n or 3 x m x n array representing the image to be loaded at the given frame.
An integer specifying the index of the frame at which the image is to be added. Frame indices start at zero. If Frame is not supplied, the frame number used will be one more than the last frame that was put. Frame number need not be consecutive; in case of a gap in frame numbers, the frame before the gap is repeated to fill the space.
IDLgrMPEG::SaveThe IDLgrMPEG:: Save procedure method encodes and saves the MPEG sequence to the specified filename. IDLgrMPEG is described above.
IDLgrMPEG::SetPropertyThe IDLgrMPEG:: SetProperty procedure method sets the value of a property or group of properties for the legend. IDLgrMPEG is described above.
Any keyword to IDLgrMPEG::Init