![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TDocumentComponentStationery
Inherited By:
TAudioStationery
TMIDIStationery
TMovieStationery
Purpose:
TMediaStationery is a document-related class that is derived from TDocumentComponentStationery. The primary function of this class is to provide a convenient means of creating an instance of the different media document types, such as movie, MIDI, and audio data. Each document type consists of a media model and a media presenter state.
TMediaStationery and its derived classes provide a convenient way for creating a compound document consisting of a media model and a media presenter state. TMediaStationery also allows the media documents to be created easily in the Workspace.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Derived classes represent a different form of media data, either movie, audio, or MIDI data.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
virtual ~ TMediaStationery ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
- TMediaStationery ()
- TMediaStationery (TMediaSequence * sequenceToAdopt)
- TMediaStationery (const TMediaStationery &)
Interface Category:
API.
Purpose:
- Default constructor.
- Constructor that creates a new TMediaStationery object from a pointer to a TMediaSequence object.
- Copy constructor.
Calling Context:
- Called by the stream-in operators and derived classes.
- Called to create a media stationery. Normally, you should use this constructor.
- Called to copy a stationery object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual long Hash () const
Interface Category:
API.
Purpose:
Returns the hash value that uniquely identifies this object within its type. Hash values are used to build dictionaries of objects.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the hash value that uniquely identifies this object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
bool operator ==(const TMediaStationery &) const
Interface Category:
API.
Purpose:
Tests for equality between the specified TMediaStationery object and this TMediaStationery object.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if both objects are equal; otherwise, returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
bool operator != (const TMediaStationery &) const
Interface Category:
API.
Purpose:
Tests for inequality between the specified TMediaStationery object and this TMediaStationery object.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if both objects are different; otherwise, returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TStream & operator >>=(TStream & towhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
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.
virtual TStream & operator <<= (TStream & fromwhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
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 no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TMediaStationery::CreateDocument
virtual TDocumentReference CreateDocument(const TMultiBinStorageMechanism &)
Interface Category:
API.
Purpose:
Creates an instance of the media document.
Calling Context:
Called to create an instance of the media document.
Parameters:
Return Value:
Returns a pointer to the newly created TDocumentReference object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TModel * CreateModel()
Interface Category:
API.
Purpose:
Creates an instance of the media model.
Calling Context:
Called to create an instance of the media model.
Parameters:
Return Value:
Returns a pointer to the newly created TModel object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TMediaStationery::CreateModelPresenterState
virtual TModelPresenterState * CreateModelPresenterState ()
Interface Category:
API.
Purpose:
Creates an instance of the media presenter state. This function is called by the Presentation framework when the framework creates and opens a document.
Calling Context:
Called by the Presentation framework to create an instance of the media presenter state.
Parameters:
Return Value:
Returns a pointer to the newly created TModelPresenterState object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void AdoptSequence (TMediaSequence *)
Interface Category:
API.
Purpose:
Deletes the current sequence and then adopts the new sequence.
Calling Context:
Call this function directly.
Parameters:
- TMediaSequence * -A pointer to the media sequence that is to be adopted.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TMediaStationery::OrphanSequence
virtual TMediaSequence * OrphanSequence ()
Interface Category:
API.
Purpose:
Returns a media sequence that had been previously adopted. The currently referenced media sequence is set to NIL.
Calling Context:
Called directly when the media sequence is no longer to be used.
Parameters:
Return Value:
Returns a pointer to the media sequence that is orphaned.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TMediaSequence * GetSequence () const
Interface Category:
API.
Purpose:
Returns a reference to the media sequence.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a pointer to the media sequence object.
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.
Copyright©1995 Taligent,Inc. All rights reserved.