Class: TQuickTimeAudioSequence

Declaration: QuickTime.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAudioSequence

Inherited By:

None.

Purpose:

A derived class of TAudioSequence that wraps the sound track of a QuickTime movie.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class should not be derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TQuickTimeAudioSequence::TQuickTimeAudioSequence

TQuickTimeAudioSequence ()
TQuickTimeAudioSequence (const TQuickTimeAudioSequence &)

Interface Category:

API.

Purpose:

Default constructor. Unitinitialized sequence.
Copy constructor.

Calling Context:

Called to create an undefined object that will immediately be assigned to or streamed into.
Called to copy an object.

Parameters:

Takes no parameters.
const TQuickTimeAudioSequence & -The audio sequence to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::~TQuickTimeAudioSequence

virtual ~ TQuickTimeAudioSequence ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::IsReadOnly

virtual bool IsReadOnly () const

Interface Category:

API.

Purpose:

Determines whether the sequence cannot be written.

Calling Context:

Called to see if the sequence cannot be written. Called by clients of the class.

Parameters:

Takes no parameters.

Return Value:

Returns true if the sequence cannot be written, otherwise returns false.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::SeekToSample

virtual void SeekToSample (TSamples :: Position position)

Interface Category:

API.

Purpose:

Seeks to a specific sample position in the sequence.

Calling Context:

Called to seek to a specific sample. Called by clients of the class.

Parameters:

TSamples :: Position position -The position to seek to.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::CreateSubrange

virtual TMediaSequence * CreateSubrange (const TMediaRange & range) const

Interface Category:

API.

Purpose:

Creates a new audio sequence that is a subset of the audio sequence. The range specifies the start time and duration of the subset.

Calling Context:

Called to create a subset of an audio sequence. Unlike DeepCopy, CreateSubrange does not copy any actual data, just references to the data. This is an inexpensive operation. Called by clients of the class.

Parameters:

const TMediaRange & range -A range specifying the start and duration of the subset.

Return Value:

TMediaSequence* -A new audio sequence that is a subset of the original.

Exceptions:

Throws TTimeMediaException::kInvalidSubrange if the duration of the subrange exceeds the current duration of the sequence.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::operator=

TQuickTimeAudioSequence & operator =(const TQuickTimeAudioSequence &)

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 TQuickTimeAudioSequence & -The audio sequence to copy.

Return Value:

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

Exceptions:

Throws TTimeMediaException::kUnableToCopyObject if the source object is not read-only.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

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

Parameters:

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

Return Value:

Throws TTimeMediaException::kUnableToStreamObject if the sequence is not read-only.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::GetDurationInSamples

virtual TSamples :: Position GetDurationInSamples () const

Interface Category:

API.

Purpose:

Returns the duration in samples.

Calling Context:

Called to get the duration. Called by clients of the class.

Parameters:

Takes no parameters.

Return Value:

The duration in samples.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::Write

virtual TSamples :: Position Write (const TMemorySurrogate & dataToWrite, TSamples :: Position numberOfSamplesToWrite)

Interface Category:

API.

Purpose:

Writes data to the sequence.

Calling Context:

Called when manipulating data.

Parameters:

const TMemorySurrogate & dataToWrite -The data to write.
TSamples :: Position numberOfSamplesToWrite -The number of samples to write.

Return Value:

The number of samples written.

Exceptions:

Throws TTimeMediaException::kReadOnlySequence if IsReadOnly==true.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::Read

virtual TSamples :: Position Read (TMemorySurrogate & fillThis, TSamples :: Position numberOfSamplesToRead)

Interface Category:

API.

Purpose:

To read data from the sequence.

Calling Context:

Called when accessing the data.

Parameters:

TMemorySurrogate & fillThis -Where to put the data.
TSamples :: Position numberOfSamplesToRead -How much data to read.

Return Value:

The number of samples read.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TQuickTimeAudioSequence::GetPositionInSamples

virtual TSamples :: Position GetPositionInSamples () const

Interface Category:

API.

Purpose:

To get the current position.

Calling Context:

Called when getting the current position.

Parameters:

Takes no parameters.

Return Value:

The position in samples.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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