Class: TMediaComponentType

Declaration: TimeMedia.h

Taxonomy Categories:

Member Functions:

TMediaComponentType
~TMediaComponentType
operator=
GetMediaComponentType
GetComponent
GetPlayer
GetConveniencePlayer
GetInputDevice
GetOutputDevice
operator<<=
operator>>=
Hash

Interface Category:

API.

Inherits From:

TMediaType

Inherited By:

None.

Purpose:

This class represents the media type and component category of media components.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Not intended to be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMediaComponentType::TMediaComponentType

TMediaComponentType ()
TMediaComponentType (const TMediaComponentType &)
TMediaComponentType (const TToken & mediaTypeName, const TToken & componentTypeName)

Interface Category:

API.

Purpose:

Default constructor. Defaults to the generic media type returned by GetMedia and the default component category returned by GetComponent.
Copy constructor.
Creates a TMediaType, allowing the media type value and component category value to be specified.

Calling Context:

Call directly to create a default object that will immediately be assigned to or streamed into. Used by TimeMediaRegistryServer.
Call directly to copy an object. Used by TimeMediaRegistryServer.
Call directly to create a fully specified audio type. Callers can use TMediaType::GetAudio, TMediaType::GetGraphic, or TMediaType::GetMIDI along with GetPlayer, GetConveniencePlayer, GetInputDevice, and GetOutputDevice to create a combination of predefined types, or they can pass in TTokens that they have defined. Called by TMediaComponent and derived classes.

Parameters:

Takes no parameters.
const TMediaComponentType & -The media component type you want to copy.
const TToken & mediaTypeName -The media type token value.
const TToken & componentTypeName -The component type token value.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::~TMediaComponentType

virtual ~ TMediaComponentType ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call directly to destroy an object. Used by TimeMediaRegistryServer.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::operator=

TMediaComponentType & operator =(const TMediaComponentType &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call directly when an object is assigned to another compatible object. Used by TimeMediaRegistryServer.

Parameters:

const TMediaType & -The source object for the assignment.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::GetMediaComponentType

TToken GetMediaComponentType () const

Interface Category:

API.

Purpose:

Provides access to the data member associated with this class.

Calling Context:

Call directly to determine the component category. Used by TimeMediaRegistryServer and Media UI Framework.

Parameters:

Takes no parameters.

Return Value:

TToken -Contains the value of the component type.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::GetComponent

static const TToken & GetComponent ()

Interface Category:

API.

Purpose:

Defines a default component type value.

Calling Context:

Call directly when creating a TMediaComponentType. Used by TMediaComponent derived classes.

Parameters:

Takes no parameters.

Return Value:

A TToken containing the predefined default component value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::GetPlayer

static const TToken & GetPlayer ()

Interface Category:

API.

Purpose:

Defines a player type value for derived classes of TPlayer.

Calling Context:

Call directly when creating a TMediaComponentType. Used by TPlayer derived classes.

Parameters:

Takes no parameters.

Return Value:

A TToken containing the predefined player value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::GetConveniencePlayer

static const TToken & GetConveniencePlayer ()

Interface Category:

API.

Purpose:

Defines a convenience player type value for TSound, TMIDI, TMovie, and so on.

Calling Context:

Call directly when creating a TMediaComponentType. Used by TSound, TMIDI, TMovie.

Parameters:

Takes no parameters.

Return Value:

A TToken containing the predefined convenience player value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::GetInputDevice

static const TToken & GetInputDevice ()

Interface Category:

API.

Purpose:

Defines an input device type value for analog-to-digital converters, and so on.

Calling Context:

Call directly when creating a TMediaComponentType.

Parameters:

Takes no parameters.

Return Value:

A TToken containing the predefined input device value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::GetOutputDevice

static const TToken & GetOutputDevice ()

Interface Category:

API.

Purpose:

Defines an output device type value for digital-to-analog converters, and so on.

Calling Context:

Call directly when creating a TMediaComponentType.

Parameters:

Takes no parameters.

Return Value:

A TToken containing the predefined output device value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call directly to stream in data. Used by TimeMediaRegistryServer.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call directly to stream out data. Used by TimeMediaRegistryServer.

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TMediaComponentType::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called by collection classes.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value.

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.