Class: TMediaRange

Declaration: TimeMedia.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Specification of a subrange of a media sequence---use with CreateSubrange.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TMediaRange::TMediaRange

TMediaRange ()
TMediaRange (const TTime & start, const TTime & duration)
TMediaRange (const TMediaRange &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a media range with the specified time values.
Copy constructor.

Calling Context:

Call directly to create an object for streaming into.
Call directly to create a media range with specified times.
Call directly to copy an object.

Parameters:

Takes no parameters.
const TTime & start -The time that the subrange begins. You can pass in TSeconds, TMilliseconds, TSamples, or any TTime derived class.
const TTime & duration -The duration of the subrange. You can pass in TSeconds, TMilliseconds, TSamples, or any TTime derived class.
const TMediaRange & -The media range to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMediaRange::~TMediaRange

virtual ~ TMediaRange ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call directly 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: TMediaRange::operator=

TMediaRange & operator =(const TMediaRange &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call directly when an object is assigned to another compatible object. Used by TMediaSequence derived classes.

Parameters:

const TMediaRange & -The media range 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: TMediaRange::GetStart

virtual void GetStart (TTime & start) const

Interface Category:

API.

Purpose:

Used to determine the start time of the media range.

Calling Context:

Call directly to determine the start time of the media range. Used by TMediaSequence derived classes.

Parameters:

TTime & start -The time that the media range begins. You can pass in TSeconds, TMilliseconds, TSamples, or any TTime derived class.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMediaRange::GetDuration

virtual void GetDuration (TTime & duration) const

Interface Category:

API.

Purpose:

Used to determine the duration of the media range.

Calling Context:

Call directly to determine the duration of the media range. Used by TMediaSequence derived classes.

Parameters:

TTime & duration -The duration of the media range. You can pass in TSeconds, TMilliseconds, TSamples, or any TTime derived class.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMediaRange::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call directly to stream in data. Used by TMediaSequence derived classes.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call directly to stream out data. Used by TMediaSequence derived classes.

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.

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