Class: TMovieSequence

Declaration: Movie.h

Taxonomy Categories:

Member Functions:

TMovieSequence
~TMovieSequence
operator>>=
operator<<=
operator=
Hash
GetDuration
CreatePreferredTypeList
ChoosePreferredType
CreateSubrange
First
Last
Before
After
Member
Count
OrphanAll
Orphan
AdoptFirst
AdoptLast
AdoptBefore
AdoptAfter
CreateSequenceIterator

Interface Category:

API.

Inherits From:

TMediaSequence

Inherited By:

TQuickTimeMovie

Purpose:

Defines a media sequence derived class. The audio/video cassette.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to represent different types of Movie data, for example, platform-specific.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMovieSequence::TMovieSequence

TMovieSequence ()
TMovieSequence (const TMovieSequence & aMovieData)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and to create an empty object.
Call this function directly.

Parameters:

Takes no parameters.
const TMovieSequence & aMovieData -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::~TMovieSequence

virtual ~ TMovieSequence ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call this function directly.

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: TMovieSequence::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call this function directly.

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: TMovieSequence::operator=

TMovieSequence & operator =(const TMovieSequence &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly.

Parameters:

const TMovieSequence & -The object to be assigned to.

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: TMovieSequence::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns a hash value.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

long -The hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::GetDuration

virtual void GetDuration (TTime & duration) const

Interface Category:

API.

Purpose:

Returns the duration of the object.

Calling Context:

Call this function directly.

Parameters:

TTime & duration -The duration returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::CreatePreferredTypeList

virtual void CreatePreferredTypeList (TSequenceOf<TMediaType> &) const

Interface Category:

API.

Purpose:

Some sequences can supply data in a number of formats. This function fills in the TSequenceOf parameter with the types of movie data the movie sequence supports. The movie data types are represented by TMovieType.

Calling Context:

Call this function directly.

Parameters:

TSequenceOf<TMediaType> & theTypes -The list of types returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::ChoosePreferredType

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

Interface Category:

API.

Purpose:

Given a collection of movie types, returns the type that the sequence can most easily supply. Some sequences can supply data in a number of formats.

Calling Context:

Call this function directly.

Parameters:

const TSequenceOf<TMediaType> & theChoices -The list of types to choose from.

Return Value:

TMediaType* -The preferred type from the given list or NIL if none is chosen.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::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:

Call this function directly.

Parameters:

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

Return Value:

TMediaSequence* -The new subsequence of the media sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::First

virtual TMediaSequence * First () const

Interface Category:

API.

Purpose:

Returns the first sequence in the movie.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the first sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::Last

virtual TMediaSequence * Last () const

Interface Category:

API.

Purpose:

Returns the last sequence in the movie.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the last sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::Before

virtual TMediaSequence * Before (const TMediaSequence &) const

Interface Category:

API.

Purpose:

Returns the sequence before a given sequence.

Calling Context:

Call this function directly.

Parameters:

const TMediaSequence & -The reference sequence.

Return Value:

A pointer to the sequence before the reference sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::After

virtual TMediaSequence * After (const TMediaSequence &) const

Interface Category:

API.

Purpose:

Returns the sequence after a given sequence.

Calling Context:

Call this function directly.

Parameters:

const TMediaSequence & -The reference sequence.

Return Value:

A pointer to the sequence after the reference sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::Member

virtual TMediaSequence * Member (const TMediaSequence &) const

Interface Category:

API.

Purpose:

Determines if the sequence is a member of the collection.

Calling Context:

Call this function directly.

Parameters:

const TMediaSequence & -The sequence in question.

Return Value:

NIL if not a member, otherwise a pointer to the sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::Count

virtual long Count () const

Interface Category:

API.

Purpose:

Counts the sequences in the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The number of sequences in the collection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::OrphanAll

virtual void OrphanAll ()

Interface Category:

API.

Purpose:

Orphans all sequences in the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::Orphan

virtual void Orphan (const TMediaSequence &)

Interface Category:

API.

Purpose:

Orphans a sequence in the collection.

Calling Context:

Call this function directly.

Parameters:

const TMediaSequence & -The sequence to orphan.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::AdoptFirst

virtual void AdoptFirst (TMediaSequence *)

Interface Category:

API.

Purpose:

Adopts a new sequence as the first sequence. The storage responsibility is assumed by the collection.

Calling Context:

Call this function directly.

Parameters:

TMediaSequence * -The sequence to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::AdoptLast

virtual void AdoptLast (TMediaSequence *)

Interface Category:

API.

Purpose:

Adopts a new sequence as the last sequence. The storage responsibility is assumed by the collection.

Calling Context:

Call this function directly.

Parameters:

TMediaSequence * -The sequence to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::AdoptBefore

virtual void AdoptBefore (const TMediaSequence & existing, TMediaSequence *)

Interface Category:

API.

Purpose:

Adopts a new sequence before an existing sequence. The storage responsibility is assumed by the collection.

Calling Context:

Call this function directly.

Parameters:

const TMediaSequence & existing -The reference sequence.
TMediaSequence * -The sequence to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::AdoptAfter

virtual void AdoptAfter (const TMediaSequence & existing, TMediaSequence *)

Interface Category:

API.

Purpose:

Adopts a new sequence after an existing sequence. The storage responsibility is assumed by the collection.

Calling Context:

Call this function directly.

Parameters:

const TMediaSequence & existing -The reference sequence.
TMediaSequence * -The sequence to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMovieSequence::CreateSequenceIterator

virtual TSequenceOfIterator < TMediaSequence > * CreateSequenceIterator () const

Interface Category:

API.

Purpose:

Creates an iterator for the sequence.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to an iterator over the sequence. You must delete it.

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.