MM Developer's Guide
MM Interfaces | MM Methods | MM Types and Misc API

IMoaMmPropOwner

Interface ID: IID_IMoaMmPropOwner
Pointer type: PIMoaMmPropOwner
Inheritance: IMoaUnknown
Header file: mmiservc.h

Description

IMoaMmPropOwner is the base interface for multimedia interfaces that support properties. This interface provides a general mechanism for defining and specifying a variety of properties. Interfaces inheriting from IMoaMmPropOwner can be found throughout this API.

The Xtra interfaces IMoaMmXAsset and IMoaMmXSpriteActor inherit from this interface. This enables Xtra developers to define custom properties for their media assets.

Various objects in Director provide interfaces that inherit from IMoaMmPropOwner. The categories of properties defined in Director include:

• player
• movie
• cast properties
• cast member
• score access
• score frame
• score sound
• score sprite
  

For a complete listing of Director properties and their values, see "Properties" in the Director Types and Miscellaneous API.

Methods

Property owner methods

GetProp()
SetProp()

GetProp()

Syntax

GetProp(PIMoaMmPropOwnerThis,

MoaMmSymbolsymbol,
PMoaMmValuepPropValue)

Parameters

This

Pointer to the IMoaMmPropOwner interface

symbol

MoaMmSymbolSymbol representing the property whose value to retrieve

pPropValue

PMoaMmValuePointer to MoaMmValue to retrieve property value

Returns

kMoaErr_NoErr	Property exists and value was returned
kMoaErr_BadParam	Invalid pPropValue passed in
kMoaMmErr_PropertyNotFound	Property isn't supported by this class
kMoaMmErr_InternalError	Property exists but couldn't get due to internal error
kMoaMmErr_NoMemForString	Couldn't allocate memory for string value data
kMoaErr_OutOfMem	Couldn't allocate memory for other value data

Description

Gets the current value of the property represented by symbol, and returns it in pPropValue.

SetProp()

Syntax

SetProp(PIMoaMmPropOwnerThis,

MoaMmSymbolsymbol,
ConstPMoaMmValuepPropValue)

Parameters

This

Pointer to the IMoaMmPropOwner interface

symbol

MoaMmSymbolSymbol representing the property whose value to retrieve

pPropValue

ConstPMoaMmValuePointer to MoaMmValue to retrieve property value

Returns

kMoaErr_NoErr	Property exists and value was set
kMoaErr_BadParam	Invalid pPropValue passed in
kMoaMmErr_PropertyNotFound	Property isn't supported by this class
kMoaMmErr_InternalError	Property exists, value ok, failed due to internal error
kMoaMmErr_NoMemForString	Couldn't allocate memory for setting string value data
kMoaErr_OutOfMem	Couldn't allocate memory for setting other value data
kMoaMmErr_IntegerExpected	Type mismatch: integer value expected
kMoaMmErr_SymbolExpected	Type mismatch: symbol value expected
kMoaMmErr_FloatExpected	Type mismatch: float value expected
kMoaMmErr_StringExpected	Type mismatch: string value expected
kMoaMmErr_PointExpected	Type mismatch: point value expected
kMoaMmErr_RectExpected	Type mismatch: rect value expected
kMoaMmErr_ValueTypeMismatch	Type mismatch: other value expected (non-specific)
kMoaDrErr_CastMemberExpected	Director only. Type mismatch: CMRef expected

Description

Sets the current value of the property represented by symbol to the value passed in pPropValue.