Class: TQuickTimeVideoSequence

Declaration: QuickTime.h

Taxonomy Categories:

Member Functions:

TQuickTimeVideoSequence
~TQuickTimeVideoSequence
GetNumberOfGraphics
GetCurrentGraphicIndex
SetCurrentGraphicIndex
GetCurrentGraphic
Append
GetCurrentGraphicDuration
GetDuration
CreatePreferredTypeList
ChoosePreferredType
CreateSubrange
GetTime
SetTime
GetMaximumBounds
TransformBy
GetLooseFitBounds
GetGeometricBounds
Draw
IsReadOnly
operator=
operator>>=
operator<<=
Hash

Interface Category:

API.

Inherits From:

TGraphicSequence

Inherited By:

None.

Purpose:

An abstraction for a video sequence stored in a QuickTime movie.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class should not be derived from.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TQuickTimeVideoSequence::TQuickTimeVideoSequence

TQuickTimeVideoSequence ()
TQuickTimeVideoSequence (const TQuickTimeVideoSequence &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and to create an empty object.
Called to copy an object.

Parameters:

Takes no parameters.
const TQuickTimeVideoSequence & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through. Throws TVideoException::kUnknownDataFormat if the data format is not recognized.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::~TQuickTimeVideoSequence

virtual ~ TQuickTimeVideoSequence ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetNumberOfGraphics

virtual unsigned long GetNumberOfGraphics () const

Interface Category:

API.

Purpose:

Returns the number of graphics that are in the sequence.

Calling Context:

Called to determine the number of graphics in a sequence.

Parameters:

Takes no parameters.

Return Value:

unsigned long -The number of graphics in the sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetCurrentGraphicIndex

virtual GraphicIndex GetCurrentGraphicIndex () const

Interface Category:

API.

Purpose:

Returns the index of the current graphic.

Calling Context:

Called to find the index of the current graphic.

Parameters:

Takes no parameters.

Return Value:

TGraphicSequence::GraphicIndex -The current graphic index.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::SetCurrentGraphicIndex

virtual void SetCurrentGraphicIndex (GraphicIndex index)

Interface Category:

API.

Purpose:

Sets the index of the current graphic. The index is zero-based, and can be equal to or less than the number of graphics in the sequence.

Calling Context:

Called to set the current index.

Parameters:

GraphicIndex index -The new index.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetCurrentGraphic

virtual MGraphic * GetCurrentGraphic () const

Interface Category:

API.

Purpose:

Returns a pointer to the MGraphic that corresponds to the current index.

Calling Context:

Called to get the current graphic.

Parameters:

Takes no parameters.

Return Value:

MGraphic* -The current graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::Append

virtual void Append (MGraphic * graphicToAdopt, const TTime & duration)

Interface Category:

API.

Purpose:

Appends the given graphic to the end of the graphic sequence.

Calling Context:

Called to append an MGraphic to a sequence.

Parameters:

MGraphic * graphicToAdopt -The graphic to append to the sequence.
const TTime & duration -The duration of the appended graphic.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetCurrentGraphicDuration

virtual void GetCurrentGraphicDuration (TTime & duration) const

Interface Category:

API.

Purpose:

Returns the duration of the current graphic.

Calling Context:

Called to get the duration of the current graphic.

Parameters:

TTime & duration -The place to put the duration.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetDuration

virtual void GetDuration (TTime & duration) const

Interface Category:

API.

Purpose:

Returns the duration of the object.

Calling Context:

Called to determine the duration of the object. Called by clients of the class.

Parameters:

TTime & duration -The TTime to set to the duration.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::CreatePreferredTypeList

virtual void CreatePreferredTypeList (TSequenceOf<TMediaType> &) const

Interface Category:

API.

Purpose:

Creates a list of preferred TGraphicTypes for use in type negotiation.

Calling Context:

Called by clients to do type negotiation. Called by clients of the class.

Parameters:

TSequenceOf<TMediaType> & theTypes -The place to put the list of types to be returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::ChoosePreferredType

virtual TMediaType * ChoosePreferredType (const TSequenceOf<TMediaType> &) const

Interface Category:

API.

Purpose:

Chooses a preferred TGraphicType from the given list of types.

Calling Context:

Called by clients to do type negotiation.

Parameters:

const TSequenceOf<TMediaType> & theChoices -The list of types to choose from or NIL if no selection can be made.

Return Value:

TMediaType* -The preferred type from the given list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::CreateSubrange

virtual TMediaSequence * CreateSubrange (const TMediaRange & range) const

Interface Category:

API.

Purpose:

Creates a new object that is a subsequence of the media sequence.

Calling Context:

Called to create a subsequence of a media sequence. Called by clients of the class.

Parameters:

const TMediaRange & range -The start and duration for the subsequence.

Return Value:

TMediaSequence* -The subsequence of the media sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetTime

virtual void GetTime (TTime & time) const

Interface Category:

API.

Purpose:

Returns the current time within the object's duration.

Calling Context:

Called by clients of the class. Called by clients of the class.

Parameters:

TTime & time -The time returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::SetTime

virtual void SetTime (const TTime & time)

Interface Category:

API.

Purpose:

Sets the current time within the object's duration.

Calling Context:

Called by clients of the class. Called by clients of the class.

Parameters:

const TTime & time -The new current time.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetMaximumBounds

virtual TGRect GetMaximumBounds () const

Interface Category:

API.

Purpose:

Returns the maximum bounds the object has at any time in its duration.

Calling Context:

Called to find the maximum bounds. Called by clients of the class.

Parameters:

Takes no parameters.

Return Value:

TGRect -The maximum bounds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::TransformBy

virtual void TransformBy (const TGrafMatrix &)

Interface Category:

API.

Purpose:

Transforms the video sequence by the specified transformation matrix.

Calling Context:

Called to transform the images in a video sequence by a matrix. Called by clients of the class.

Parameters:

const TGrafMatrix & -The transformation matrix.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetLooseFitBounds

virtual TGRect GetLooseFitBounds (const TGrafPort * =NIL) const

Interface Category:

API.

Purpose:

Returns the loose fit bounds of the TVideoImage buffer.

Calling Context:

Called to get the loose fit bounds of the TVideoImage buffer. Called by clients of the class.

Parameters:

const TGrafPort * =NIL -The graf port to use.

Return Value:

A TGRect that describes the loose fit bounds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::GetGeometricBounds

virtual TGRect GetGeometricBounds () const

Interface Category:

API.

Purpose:

Returns the geometric bounds of the TVideoImage buffer.

Calling Context:

Called to get the geometric bounds of the TVideoImage buffer. Called by clients of the class.

Parameters:

Takes no parameters.

Return Value:

A TGRect that describes the geometric bounds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::Draw

virtual void Draw (TGrafPort & port) const

Interface Category:

API.

Purpose:

Draws the current TVideoImage.

Calling Context:

Called to draw the current TVideoImage. Called by clients of the class.

Parameters:

TGrafPort & port -The destination for drawing.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::IsReadOnly

virtual bool IsReadOnly () const

Interface Category:

API.

Purpose:

Determines whether the sequence is read-only.

Calling Context:

Called to determine if the sequence is read-only. Called by clients of the class.

Parameters:

Takes no parameters.

Return Value:

Returns true if the sequence is read-only.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::operator=

TQuickTimeVideoSequence & operator =(const TQuickTimeVideoSequence & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Called by clients of the class.

Parameters:

const TQuickTimeVideoSequence & source -The object to copy.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. Called by clients of the class.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. Called by clients of the class.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the versions don't match.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeVideoSequence::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called when this object is put into a collection.

Parameters:

Takes no parameters.

Return Value:

The hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.