This chapter describes the structures and types defined in the header file MMDefs.h
:
Multimedia Definitions Structures and Types
Multimedia Definitions Constants
Multimedia Definitions Functions and Macros
Multimedia Definitions Structures and Types
MMCodecClassID Typedef
Purpose
The class ID of a decoder or encoder object.
Declared In
MMDefs.h
Prototype
typedef int32_t MMCodecClassID
MMDestID Typedef
Purpose
The ID of a multimedia destination object.
Declared In
MMDefs.h
Prototype
typedef int32_t MMDestID
MMEvent Typedef
Purpose
Declared In
MMDefs.h
Prototype
typedef int32_t MMEvent
MMFilterID Typedef
Purpose
Declared In
MMDefs.h
Prototype
typedef int32_t MMFilterID
MMSessionClassID Typedef
Purpose
The class ID of a session subclass.
Declared In
MMDefs.h
Prototype
typedef int32_t MMSessionClassID
MMSessionID Typedef
Purpose
Declared In
MMDefs.h
Prototype
typedef int32_t MMSessionID
MMSourceID Typedef
Purpose
The ID of a multimedia source object.
Declared In
MMDefs.h
Prototype
typedef int32_t MMSourceID
MMStreamID Typedef
Purpose
Declared In
MMDefs.h
Prototype
typedef int32_t MMStreamID
MMTrackID Typedef
Purpose
Declared In
MMDefs.h
Prototype
typedef int32_t MMTrackID
Multimedia Definitions Constants
Complex Property Values Enum
Purpose
Specifies a more complex type of value stored in a property set.
Declared In
MMDefs.h
Constants
-
P_MM_RECT_TYPE = MM_TYPE_CODE('Rct')
- A
RectangleType
structure. -
P_MM_FORMAT_TYPE = MM_TYPE_CODE('Fmt')
- A
MMFormat
object.
Enumerations Enum
Purpose
Specifies the beginning and end of an enumeration.
Declared In
MMDefs.h
Constants
-
P_MM_ENUM_BEGIN = 0
- Tells a function to begin the enumeration.
-
P_MM_ENUM_END = -1
- Returned by a function when there are no more values to enumerate.
Miscellaneous Constants
Purpose
Other constants defined in MMDefs.h
.
Declared In
MMDefs.h
Constants
-
#define P_MM_INVALID_ID 0
- Specifies an invalid ID.
-
#define P_MM_TYPE_CODE_MASK 0x7f7f7f00
- Mask of all
MMTypeCode
values. -
#define P_MM_TYPE_CODE_SHIFT 8
- Amount to shift to get
MMTypeCode
values.
MMPropInfoType Typedef
Purpose
Specifies the type of data to retrieve from a property set.
Declared In
MMDefs.h
Prototype
typedef int32_t MMPropInfoType
Constants
-
P_MM_PROP_INFO_DEFAULT
- Obtain the default value.
-
P_MM_PROP_INFO_MINIMUM
- Obtain the minimum value.
-
P_MM_PROP_INFO_MAXIMUM
- Obtain the maximum value.
-
P_MM_PROP_INFO_READABLE
- Returns whether the value is readable.
-
P_MM_PROP_INFO_WRITABLE
- Returns whether the value is writable.
-
P_MM_PROP_INFO_TYPE_CODE
- Returns the type of value stored for the property.
Comments
The function MMPropertyInfo()
uses these values to obtain specific information from a property set.
MMSeekOrigin Typedef
Purpose
A multimedia application uses these constants to specify where to being a seek operation.
Declared In
MMDefs.h
Prototype
typedef int8_t MMSeekOrigin
Constants
-
P_MM_SEEK_ORIGIN_BEGIN
- Start at the beginning of the file.
-
P_MM_SEEK_ORIGIN_CURRENT
- Start at the current location.
-
P_MM_SEEK_ORIGIN_END
- Start at the end of the file.
See Also
MMTypeCode Typedef
Purpose
Specifies the type of value stored in a property or MMFormat
object.
Declared In
MMDefs.h
Prototype
typedef int32_t MMTypeCode
Constants
-
P_MM_UNDEFINED_TYPE = MM_TYPE_CODE(0)
- Not defined.
-
P_MM_WILD_TYPE = MM_TYPE_CODE('wld')
- Wild.
-
P_MM_RAW_TYPE = MM_TYPE_CODE('raw')
- Raw data.
-
P_MM_INT8_TYPE = MM_TYPE_CODE('i08')
- 8-bit integer.
-
P_MM_INT16_TYPE = MM_TYPE_CODE('i16')
- 16-bit integer.
-
P_MM_INT32_TYPE = MM_TYPE_CODE('i32')
- 32-bit integer.
-
P_MM_INT64_TYPE = MM_TYPE_CODE('i64')
- 64-bit integer.
-
P_MM_BOOL_TYPE = MM_TYPE_CODE('bol')
- Boolean value.
-
P_MM_STRING_TYPE = MM_TYPE_CODE('str')
- String value.
Object Property Key Bases Enum
Purpose
Used to construct base values for the property keys used by different objects.
Declared In
MMDefs.h
Constants
-
P_MM_PROP_OBJECT_MASK = 0xFF000000L
- Mask of all object property key base values.
-
P_MM_PROP_OBJECT_SESSION = (1L << 24)
- Identifies session object property keys.
-
P_MM_PROP_OBJECT_CONTENT = (2L << 24)
- Identifies multimedia content property keys.
-
P_MM_PROP_OBJECT_SOURCE = (3L << 24)
- Identifies source object property keys.
-
P_MM_PROP_OBJECT_DEST = (4L << 24)
- Identifies destination object property keys
-
P_MM_PROP_OBJECT_STREAM = (5L << 24)
- Identifies stream object property keys.
-
P_MM_PROP_OBJECT_TRACK = (6L << 24)
- Identifies track object property keys.
-
P_MM_PROP_OBJECT_DEVICE = (7L << 24)
- Not currently used.
-
P_MM_PROP_OBJECT_SESSION_CLASS = (8L << 24)
- Identifies session subclass properties.
-
P_MM_PROP_OBJECT_CODEC_CLASS = (9L << 24)
- Identifies codec object property keys.
Property Base Enum
Purpose
Used to construct property key constants.
Declared In
MMDefs.h
Constants
-
P_MM_STANDARD_PROP_BASE = 0x00010000L
- Identifies PalmSource-defined property keys.
-
P_MM_USER_PROP_BASE = 0x00020000L
- Identifies licensee-defined property keys.
-
P_MM_PRIVATE_PROP_BASE = 0x00030000L
- Identifies private property keys.
Property Key Base Values Enum
Purpose
Base values for property key constants used by various objects.
Declared In
MMDefs.h
Constants
-
P_MM_SESSION_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_SESSION
- Base value for session object property keys.
-
P_MM_CONTENT_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_CONTENT
- Base value for content property keys.
-
P_MM_SOURCE_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_SOURCE
- Base value for source object property keys.
-
P_MM_DEST_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_DEST
- Base value for destination object property keys
-
P_MM_STREAM_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_STREAM
- Base value for stream object property keys.
-
P_MM_TRACK_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_TRACK
- Base value for track object property keys.
-
P_MM_DEVICE_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_DEVICE
- Not currently used.
-
P_MM_SESSION_CLASS_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_SESSION_CLASS
- Base value for session subclass properties.
-
P_MM_CODEC_CLASS_PROP_BASE = P_MM_STANDARD_PROP_BASE | P_MM_PROP_OBJECT_CODEC_CLASS
- Base value for codec object property keys.
Session Event Causes Enum
Purpose
Values for the MMSessionEvent
eventCause
field.
Declared In
MMDefs.h
Constants
-
P_MM_EVENT_CAUSE_UNKNOWN = 0x01
- The cause is unknown.
-
P_MM_EVENT_CAUSE_REQUESTED_BY_APP = 0x02
- The application requested that the event occur.
-
P_MM_EVENT_CAUSE_END_OF_STREAM = 0x03
- All tracks stopped because there is no more data to write or to read.
-
P_MM_EVENT_CAUSE_INVALID_STREAM = 0x04
- All tracks stopped because bad data was detected in the stream.
-
P_MM_EVENT_CAUSE_STORAGE_FULL = 0x05
- All tracks stopped because the destination storage is full.
-
P_MM_EVENT_CAUSE_CUSTOM_BASE = 0x1000
- Base value after which you may add your own custom events.
Session Notifications Enum
Purpose
Notifications sent by the session when something occurs. These are used as values for the MMSessionEvent
eventCode
field.
Declared In
MMDefs.h
Constants
-
P_MM_EVENT_SESSION_STATE_CHANGED = 0x01
- Sent to the client process when a session's state changes such as from ready to running to stopped.
-
P_MM_EVENT_SESSION_MARKER_EXPIRED = 0x02
- Sent to the client process when a marker requested by the application has been reached on a particular track.
-
P_MM_EVENT_SESSION_DELETING = 0x03
- The session is in the process of being deleted.
-
P_MM_EVENT_SESSION_WARNING = 0x04
- A recoverable error has occurred during the session.
-
P_MM_EVENT_CUSTOM_BASE = 0x1000
- Base value after which licensees may add their own custom events.
Multimedia Definitions Functions and Macros
MM_TYPE_CODE Macro
Purpose
Used to construct MMTypeCode
values.
Declared In
MMDefs.h
Prototype
#define MM_TYPE_CODE (
code
)
Parameters
Returns
One of the MMTypeCode
values.