Declaration: MIDI.h
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MOrderableCollectible
Inherited By:
TMIDIChannelPacket
TMIDISetTempoPacket
Purpose:
The base class for all MIDI packet types. Representing time-stamped MIDI data, a packet consists of a time stamp and data bytes. The data bytes are accessed 0 through N -1, where byte 0 is the status byte. All packets should have a status byte.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Derived classes can override to interpret specific MIDI messages, each of which assigns specific meaning to the data bytes following the status byte. If you add data fields, then you should also derive MIDI ports to transmit derived classes of TMIDIPacket instead of slicing.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- TMIDIPacket ()
- TMIDIPacket (const TTime & timeStamp, Byte status)
- TMIDIPacket (const TTime & timeStamp, Byte status, Byte byte1)
- TMIDIPacket (const TTime & timeStamp, Byte status, Byte byte1, Byte byte2)
- TMIDIPacket (const TTime & timeStamp, const Byte buffer [], DataIndex length)
- TMIDIPacket (const TMIDIPacket &)
- TMIDIPacket (const TTime & timeStamp, DataIndex length)
Interface Category:
API.
Purpose:
- Default constructor.
- Constructor for a 1-byte packet.
- Constructor for a 2-byte packet.
- Constructor for a 3-byte packet.
- Constructor for a long packet.
- Copy constructor.
- Protected constructor.
Calling Context:
- Called by the stream-in operators and to construct an uninitialized packet.
- Call this function directly.
- Call this function directly.
- Call this function directly.
- Call this function directly.
- Call this function directly.
- Called by derived classes to construct a packet of a known length, where the data will be filled out later.
Parameters:
- Takes no parameters.
- const TTime & timeStamp -The time stamp.
- Byte status -The status byte.
- const TTime & timeStamp -The time stamp.
- Byte status -The status byte.
- Byte byte1 -The data.
- const TTime & timeStamp -The time stamp.
- Byte status -The status byte.
- Byte byte1 -The data.
- Byte byte2 -The data.
- const TTime & timeStamp -The time stamp.
- const Byte buffer [] -The data.
- DataIndex length -The length of the data.
- const TMIDIPacket & -The object to copy.
- const TTime & timeStamp -The time stamp.
- DataIndex length -The length of the data.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ TMIDIPacket ()
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.
Member Function: TMIDIPacket::operator=
TMIDIPacket & operator =(const TMIDIPacket &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Call this function directly.
Parameters:
- const TMIDIPacket & -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:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::GetTimeStamp
void GetTimeStamp (TTime &) const
Interface Category:
API.
Purpose:
Gets the time stamp.
Calling Context:
Call this function directly.
Parameters:
- TTime & -Assigned the time stamp.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::SetTimeStamp
void SetTimeStamp (const TTime &)
Interface Category:
API.
Purpose:
Sets the time stamp.
Calling Context:
Call this function directly.
Parameters:
- const TTime & -The time stamp to assign.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::GetStatus
Byte GetStatus () const
Interface Category:
API.
Purpose:
Gets the status byte.
Calling Context:
Call this function directly.
Parameters:
Return Value:
The status byte.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::GetData
- Byte GetData (DataIndex index) const
- void GetData (Byte * buffer, DataIndex length, DataIndex startPos =0) const
Interface Category:
API.
Purpose:
- Gets a particular data byte.
- Gets a group of bytes starting at a given position.
Calling Context:
- Call this function directly.
- Call this function directly.
Parameters:
- DataIndex index -The position of the specified byte.
- Byte * buffer -The destination of the data.
- DataIndex length -The length of the specified data.
- DataIndex startPos =0 -The start position of the specified data.
Return Value:
- The data byte.
- None.
Exceptions:
Throws TMIDIException::kDataIndexOutOfRange if applicable.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::GetDataLength
DataIndex GetDataLength () const
Interface Category:
API.
Purpose:
Gets the length of the data.
Calling Context:
Call this function directly.
Parameters:
Return Value:
The length.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::SetStatus
virtual void SetStatus (Byte)
Interface Category:
API.
Purpose:
Sets the status byte. Note that this will not change the length of the data.
Calling Context:
Call this function directly.
Parameters:
- Byte -The status byte to assign.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::SetData
virtual void SetData (DataIndex index, Byte byte)
Interface Category:
API.
Purpose:
Sets a particular data byte.
Calling Context:
Call this function directly.
Parameters:
- DataIndex index -The specified position.
- Byte byte -The specified byte.
Return Value:
None.
Exceptions:
Throws TMIDIException::kDataIndexOutOfRange if applicable.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::SetDataAndLength
- virtual void SetDataAndLength (Byte status)
- virtual void SetDataAndLength (Byte status, Byte byte1)
- virtual void SetDataAndLength (Byte status, Byte byte1, Byte byte2)
- virtual void SetDataAndLength (const Byte buffer [], DataIndex length, DataIndex startPos =0)
Interface Category:
API.
Purpose:
- Sets byte 0, and sets the length to 1.
- Sets bytes 0 and 1, and sets the length to 2.
- Sets bytes 0, 1, and 2, and sets the length to 3.
- Sets the data at the start position, and sets the length.
Calling Context:
- Call this function directly.
- Call this function directly.
- Call this function directly.
- Call this function directly.
Parameters:
- Byte status -Byte 0.
- Byte status -Byte 0.
- Byte byte1 -Byte 1.
- Byte status -Byte 0.
- Byte byte1 -Byte 1.
- Byte byte2 -Byte 2.
- const Byte buffer [] -The data.
- DataIndex length -The length of the data.
- DataIndex startPos =0 -The start position.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::AppendData
- virtual void AppendData (const TMIDIPacket & fromPacket)
- virtual void AppendData (const Byte buffer [], DataIndex length)
Interface Category:
API.
Purpose:
- Appends data from a packet to this packet.
- Appends data from a buffer to this packet.
Calling Context:
- Call this function directly.
- Call this function directly.
Parameters:
- const TMIDIPacket & fromPacket -The source packet.
- const Byte buffer [] -The source buffer.
- DataIndex length -The length of data in the source buffer.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::operator<<=
virtual TStream & operator <<= (TStream & fromWhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Call this function directly.
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: TMIDIPacket::operator>>=
virtual TStream & operator >>=(TStream & toWhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Call this function directly.
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.
Member Function: TMIDIPacket::Hash
virtual long Hash () const
Interface Category:
API.
Purpose:
Generates a hash value.
Calling Context:
Called by collections.
Parameters:
Return Value:
The hash value.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsGreaterThan
virtual bool IsGreaterThan (const MOrderableCollectible * obj) const
Interface Category:
API.
Purpose:
Determines if the packet is greater than another packet, first by time stamp and then by data, if necessary.
Calling Context:
Call this function directly.
Parameters:
- const MOrderableCollectible * obj -The MOrderableCollectible to be compared.
Return Value:
Returns true if the packet is greater than the other, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsLessThan
virtual bool IsLessThan (const MOrderableCollectible * obj) const
Interface Category:
API.
Purpose:
Determines if the packet is less than another packet, first by time stamp and then by data, if necessary.
Calling Context:
Call this function directly.
Parameters:
- const MOrderableCollectible * obj -The MOrderableCollectible to be compared.
Return Value:
Returns true if the packet is less than the other packet, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsChannelMessage
bool IsChannelMessage () const
Interface Category:
API.
Purpose:
Determines if the packet is a MIDI channel message.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the packet is a MIDI channel message, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSystemExclusiveMessage
bool IsSystemExclusiveMessage () const
Interface Category:
API.
Purpose:
Determines if the packet is a MIDI system exclusive message.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the packet is a system exclusive message, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSystemMessage
bool IsSystemMessage () const
Interface Category:
API.
Purpose:
Determines if the packet is a MIDI system message.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the packet is a system message, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsMetaEvent
bool IsMetaEvent () const
Interface Category:
API.
Purpose:
Determines if the packet is a MIDI meta event.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the packet is a meta event, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsNoteOff
bool IsNoteOff () const
Interface Category:
API.
Purpose:
Determines if the packet is a MIDI Note Off message or a MIDI Note On message with a velocity equal to zero.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the packet is a Note Off or a Note On with a velocity equal to zero, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsNoteOn
bool IsNoteOn () const
Interface Category:
API.
Purpose:
Determines if the packet is a MIDI Note On message with a nonzero velocity.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the packet is a Note On with a nonzero velocity, otherwise returns false.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSequencerSpecific
bool IsSequencerSpecific () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsKeySignature
bool IsKeySignature () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsTimeSignature
bool IsTimeSignature () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSMPTEOffset
bool IsSMPTEOffset () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSetTempo
bool IsSetTempo () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsEndOfTrack
bool IsEndOfTrack () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsChannelPrefix
bool IsChannelPrefix () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsCuePoint
bool IsCuePoint () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsMarker
bool IsMarker () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsLyric
bool IsLyric () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsInstrumentName
bool IsInstrumentName () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSequenceOrTrackName
bool IsSequenceOrTrackName () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsCopyrightNotice
bool IsCopyrightNotice () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsTextEvent
bool IsTextEvent () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSequenceNumber
bool IsSequenceNumber () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSystemReset
bool IsSystemReset () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsActiveSensing
bool IsActiveSensing () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsStop
bool IsStop () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsContinue
bool IsContinue () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsStart
bool IsStart () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsTimingClock
bool IsTimingClock () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsEndOfSystemExclusive
bool IsEndOfSystemExclusive () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsTuneRequest
bool IsTuneRequest () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSongSelect
bool IsSongSelect () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSongPositionPointer
bool IsSongPositionPointer () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsMTCQuarterFrame
bool IsMTCQuarterFrame () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsSystemExclusive
bool IsSystemExclusive () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsPolyModeOn
bool IsPolyModeOn () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsMonoModeOn
bool IsMonoModeOn () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsOmniModeOn
bool IsOmniModeOn () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsOmniModeOff
bool IsOmniModeOff () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsAllNotesOff
bool IsAllNotesOff () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsLocalControl
bool IsLocalControl () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsResetAllControllers
bool IsResetAllControllers () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsPitchWheelChange
bool IsPitchWheelChange () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsChannelPressure
bool IsChannelPressure () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsProgramChange
bool IsProgramChange () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsControlChange
bool IsControlChange () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TMIDIPacket::IsPolyKeyPressure
bool IsPolyKeyPressure () const
Interface Category:
API.
Purpose:
Identifies message type.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if type matches, false otherwise.
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.