All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.image.DSequence

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.std.image.CDSequence
                   |
                   +----quicktime.std.image.DSequence

public final class DSequence
extends CDSequence
This class is used for decompressing a sequence of images. The Movie Toolbox handles the details of decompressing image sequences in QuickTime movies. If you need to decompress other sequences, your application can use this class.

See Also:
CDSequence, CSequence

Constructor Index

 o DSequence(ImageDescription, EncodedImage, QDGraphics, QDRect, Matrix, Region, int, int, CodecComponent)
This constructor allows you to pass a compressed sample so the codec can perform preflighting before the first decompressFrame call.
 o DSequence(ImageDescription, QDGraphics, QDRect, Matrix, Region, int, int, CodecComponent)
Creating an instance of this class signals the beginning of the process of decompressing a sequence of frames.

Method Index

 o decompressFrame(ByteEncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrame(EncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrame(IntEncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrame(RawEncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrameS(ByteEncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrameS(EncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrameS(IntEncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrameS(RawEncodedImage, int)
Your application calls this method to decompress one of a sequence of frames.
 o decompressFrameWhen(ByteEncodedImage, int, ICMFrameTime)
Queues a frame for decompression and specifies the time at which decompression will begin.
 o decompressFrameWhen(EncodedImage, int, ICMFrameTime)
Queues a frame for decompression and specifies the time at which decompression will begin.
 o decompressFrameWhen(IntEncodedImage, int, ICMFrameTime)
Queues a frame for decompression and specifies the time at which decompression will begin.
 o decompressFrameWhen(RawEncodedImage, int, ICMFrameTime)
Queues a frame for decompression and specifies the time at which decompression will begin.
 o flush()
Stops a decompression sequence, aborting processing of any queued frames.
 o getImageBuffer()
This method helps you determine the location of the offscreen image buffer allocated by the decompressor.
 o getScreenBuffer()
This method enables you to determine the location of the offscreen buffer allocated by the decompressor.
 o hitTestData(EncodedImage, QDPoint, int)
The HitTestDSequenceData function allows the calling application to perform hit testing on compressed data.
 o invalidate(Region)
Notifies the Image Compression Manager that the destination port for the given image decompression sequence has been invalidated.
 o ptInData(EncodedImage, QDPoint)
Tests to see if an image contains data at a given point.
 o setAccuracy(int)
This method adjusts the decompression accuracy for this sequence.
 o setGraphicsMode(GraphicsMode)
This method sets the mode used when drawing the decompressed image.
 o setMask(Region)
This method assigns a clipping region to the sequence.
 o setMatrix(Matrix)
This method assigns a mapping matrix to the sequence.
 o setMatte(PixMap, QDRect)
This method assigns a blend matte to the sequence.
 o setSrcRect(QDRect)
This method defines the portion of the image to decompress.
 o setTransferMode(int, QDColor)
This method sets the mode used when drawing the decompressed image.
 o shieldCursor()
Hides the cursor during decompression operations.

Constructors

 o DSequence
 public DSequence(ImageDescription desc,
                  QDGraphics port,
                  QDRect srcRect,
                  Matrix matrix,
                  Region mask,
                  int flags,
                  int accuracy,
                  CodecComponent codec) throws QTException
Creating an instance of this class signals the beginning of the process of decompressing a sequence of frames.

QuickTime::DecompressSequenceBegin

Parameters:
desc - an ImageDescription object which describes the compressed data
port - a QDGraphics for the destination image. This may NOT be null.
srcRect - a QDRect defining the portion of the image to decompress, or null to use the rectangle defined in the ImageDescription associated with this sequence
matrix - a Matrix that specifies how to transform the image during decompression
mask - a RgnHandle which defines a clipping region in the destination coordinate system, or null
flags - flags providing further control information
accuracy - the accuracy desired in the decompressed image
codec - a Decompressor identifier
 o DSequence
 public DSequence(ImageDescription desc,
                  EncodedImage data,
                  QDGraphics port,
                  QDRect srcRect,
                  Matrix matrix,
                  Region mask,
                  int flags,
                  int accuracy,
                  CodecComponent codec) throws QTException
This constructor allows you to pass a compressed sample so the codec can perform preflighting before the first decompressFrame call.

QuickTime::DecompressSequenceBeginS

Parameters:
desc - an ImageDescription object which describes the compressed data
data - encoded image data
port - a QDGraphics for the destination image. This may NOT be null.
srcRect - a QDRect defining the portion of the image to decompress, or null to use the rectangle defined in the ImageDescription associated with this sequence
matrix - a Matrix that specifies how to transform the image during decompression
mask - a RgnHandle which defines a clipping region in the destination coordinate system, or null
flags - flags providing further control information
accuracy - the accuracy desired in the decompressed image
codec - a Decompressor identifier
Returns:
the unique sequence id

Methods

 o decompressFrameS
 public int decompressFrameS(EncodedImage data,
                             int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrameS

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrameS
 public int decompressFrameS(ByteEncodedImage data,
                             int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrameS

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrameS
 public int decompressFrameS(IntEncodedImage data,
                             int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrameS

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrameS
 public int decompressFrameS(RawEncodedImage data,
                             int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrameS

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrame
 public int decompressFrame(EncodedImage data,
                            int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrame

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrame
 public int decompressFrame(ByteEncodedImage data,
                            int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrame

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrame
 public int decompressFrame(IntEncodedImage data,
                            int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrame

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrame
 public int decompressFrame(RawEncodedImage data,
                            int inFlags) throws StdQTException
Your application calls this method to decompress one of a sequence of frames.

QuickTime::DecompressSequenceFrame

Parameters:
data - encoded image data
inFlags - flags providing further control information
Returns:
the outFlags value
 o decompressFrameWhen
 public int decompressFrameWhen(ByteEncodedImage data,
                                int inFlags,
                                ICMFrameTime frameTime) throws StdQTException
Queues a frame for decompression and specifies the time at which decompression will begin.

QuickTime::DecompressSequenceFrameWhen

Parameters:
data - encoded image data
inFlags - flags providing further control information
frameTime - an ICMFrameTime object that contains the frame's time information, including the time at which the frame should be displayed, its duration, and the movie's playback rate.
Returns:
the outFlags value
 o decompressFrameWhen
 public int decompressFrameWhen(IntEncodedImage data,
                                int inFlags,
                                ICMFrameTime frameTime) throws StdQTException
Queues a frame for decompression and specifies the time at which decompression will begin.

QuickTime::DecompressSequenceFrameWhen

Parameters:
data - encoded image data
inFlags - flags providing further control information
frameTime - an ICMFrameTime object that contains the frame's time information, including the time at which the frame should be displayed, its duration, and the movie's playback rate.
Returns:
the outFlags value
 o decompressFrameWhen
 public int decompressFrameWhen(RawEncodedImage data,
                                int inFlags,
                                ICMFrameTime frameTime) throws StdQTException
Queues a frame for decompression and specifies the time at which decompression will begin.

QuickTime::DecompressSequenceFrameWhen

Parameters:
data - encoded image data
inFlags - flags providing further control information
frameTime - an ICMFrameTime object that contains the frame's time information, including the time at which the frame should be displayed, its duration, and the movie's playback rate.
Returns:
the outFlags value
 o decompressFrameWhen
 public int decompressFrameWhen(EncodedImage data,
                                int inFlags,
                                ICMFrameTime frameTime) throws StdQTException
Queues a frame for decompression and specifies the time at which decompression will begin.

QuickTime::DecompressSequenceFrameWhen

Parameters:
data - encoded image data
inFlags - flags providing further control information
frameTime - an ICMFrameTime object that contains the frame's time information, including the time at which the frame should be displayed, its duration, and the movie's playback rate.
Returns:
the outFlags value
 o setGraphicsMode
 public void setGraphicsMode(GraphicsMode mode) throws StdQTException
This method sets the mode used when drawing the decompressed image.

QuickTime::SetDSequenceTransferMode

Parameters:
mode - the transfer mode to use when drawing the decompressed image
 o setTransferMode
 public void setTransferMode(int mode,
                             QDColor opColor) throws StdQTException
This method sets the mode used when drawing the decompressed image.

QuickTime::SetDSequenceTransferMode

Parameters:
mode - the transfer mode to use when drawing the decompressed image
opColor - an QDColor object to be used in addPin, subPin, blend and transparent operations. If null, the opColor is left unchanged.
 o setSrcRect
 public void setSrcRect(QDRect srcRect) throws StdQTException
This method defines the portion of the image to decompress.

QuickTime::SetDSequenceSrcRect

Parameters:
srcRect - a QDRect object defining the portion of the object to decompress
 o setMatrix
 public void setMatrix(Matrix matrix) throws StdQTException
This method assigns a mapping matrix to the sequence.

QuickTime::SetDSequenceMatrix

Parameters:
matrix - a Matrix object that specifies how to transform the image during decompression
 o setMask
 public void setMask(Region mask) throws StdQTException
This method assigns a clipping region to the sequence.

QuickTime::SetDSequenceMask

Parameters:
mask - a Region object which is applied to the desitnation image. If null then masking is stopped.
 o setMatte
 public void setMatte(PixMap matte,
                      QDRect matteRect) throws StdQTException
This method assigns a blend matte to the sequence.

QuickTime::SetDSequenceMatte

Parameters:
matte - a PixMap object which contains a blend matte
matteRect - a QDRect object which defines the boundary of the matte
 o setAccuracy
 public void setAccuracy(int accuracy) throws StdQTException
This method adjusts the decompression accuracy for this sequence.

QuickTime::SetDSequenceAccuracy

Parameters:
accuracy - the accuracy desired in the decompressed image
 o getImageBuffer
 public QDGraphics getImageBuffer() throws StdQTException
This method helps you determine the location of the offscreen image buffer allocated by the decompressor.

QuickTime::GetDSequenceImageBuffer

Returns:
a QDGraphics object which is the graphics world for the image buffer
 o getScreenBuffer
 public QDGraphics getScreenBuffer() throws StdQTException
This method enables you to determine the location of the offscreen buffer allocated by the decompressor.

QuickTime::GetDSequenceScreenBuffer

Returns:
a QDGraphics object which is the graphics world for the screen buffer
 o ptInData
 public boolean ptInData(EncodedImage data,
                         QDPoint where) throws StdQTException
Tests to see if an image contains data at a given point.

QuickTime::PtInDSequenceData

Parameters:
data - encoded image data
where - a Point object, (0,0) is upper left corner of the image
Returns:
true if the compressed data contains data at the point specified by the where parameter. false if the specified point falls within a blank portion of the image.
 o hitTestData
 public boolean hitTestData(EncodedImage data,
                            QDPoint where,
                            int hitFlags) throws StdQTException
The HitTestDSequenceData function allows the calling application to perform hit testing on compressed data.

QuickTime::HitTestDSequenceData

Parameters:
data - compressed data in the format specified by the description of the DSequence.
where - A QuickDraw Point (0,0) based at the top-left corner of the image.
hitFlags - indicates the hit-testing behaviour that is sought
Returns:
true if the compressed data contains data at the point specified by the where parameter.
 o flush
 public void flush() throws StdQTException
Stops a decompression sequence, aborting processing of any queued frames.

QuickTime::CDSequenceFlush

 o invalidate
 public void invalidate(Region invalRgn) throws StdQTException
Notifies the Image Compression Manager that the destination port for the given image decompression sequence has been invalidated.

QuickTime::CDSequenceInvalidate

Parameters:
invalRgn - a Region describing the invalid portion of the image
 o shieldCursor
 public void shieldCursor() throws StdQTException
Hides the cursor during decompression operations.

QuickTime::ICMShieldSequenceCursor


All Packages  Class Hierarchy  This Package  Previous  Next  Index