Declaration: MIDI.h
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TMIDIChannelPacket
Inherited By:
None.
Purpose:
Provides convenient access to a MIDI Note On message.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Derive to provide more information.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- TMIDINoteOnPacket ()
- TMIDINoteOnPacket (const TTime & timeStamp, Channel, Note, Velocity)
- TMIDINoteOnPacket (const TMIDIPacket &)
- TMIDINoteOnPacket (const TMIDINoteOnPacket &)
Interface Category:
API.
Purpose:
- Default constructor. The data values are undefined.
- Constructor.
- Constructor.
- Copy constructor.
Calling Context:
- Called by the stream-in operators and to create an undefined object.
- Call this function directly.
- Call this function directly.
- Call this function directly.
Parameters:
- Takes no parameters.
- const TTime & timeStamp -The time stamp.
- Channel -The channel.
- Note -The note value.
- Velocity -The velocity value.
- const TMIDIPacket & -The packet to convert.
- const TMIDINoteOnPacket & -The packet to copy.
Return Value:
None.
Exceptions:
- Throws no exceptions, passes all exceptions through.
- Throws no exceptions, passes all exceptions through.
- Throws TMIDIException::kInvalidStatus if not a Note On message.
- Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ TMIDINoteOnPacket ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
- TMIDINoteOnPacket & operator =(const TMIDINoteOnPacket &)
- TMIDINoteOnPacket & operator =(const TMIDIPacket &)
Interface Category:
API.
Purpose:
- Assignment operator.
- Assignment operator that converts a TMIDIPacket.
Calling Context:
- Call this function directly.
- Call this function directly.
Parameters:
Return Value:
A non-const reference to the left-hand side object.
Exceptions:
- Throws no exceptions, passes all exceptions through.
- Throws TMIDIException::kInvalidStatus if not a Note On message.
Concurrency:
Multithread safe.
Other Considerations:
None.
Note GetNote () const
Interface Category:
API.
Purpose:
Gets the note value.
Calling Context:
Call this function directly.
Parameters:
Return Value:
The note value.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
void SetNote (Note)
Interface Category:
API.
Purpose:
Sets the note value.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Velocity GetVelocity () const
Interface Category:
API.
Purpose:
Gets the velocity.
Calling Context:
Call this function directly.
Parameters:
Return Value:
The velocity value.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
void SetVelocity (Velocity)
Interface Category:
API.
Purpose:
Sets the velocity.
Calling Context:
Call this function directly.
Parameters:
- Velocity -The velocity value.
Return Value:
None.
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.
Copyright©1995 Taligent,Inc. All rights reserved.