MM Developer's Guide
MM Interfaces | MM Methods | MM Types and Misc API
Interface ID: IID_IMoaMmXAsset
Pointer type:
PIMoaMmXAsset
Inheritance: IMoaMmPropOwner
Header file: mmixasst.h
- BeginImageAnimThumb(PIMoaMmXAssetThis,
- PIMoaMmGCpGC,
ConstPMoaRectpImageRect)
This
IMoaMmXAsset
interfacepGC
PIMoaMmGC
Pointer to IMoaMmGC interface for graphics context in which to draw pImageRect
ConstPMoaRect
Pointer to MoaRect specifying location and size of thumbnail kMoaErr_NoErr | Successful, ready to begin anim thumb drawing |
kMoaMmErr_NotImplementedClass | doesn't have an anim thumb |
kMoaMmErr_GCTypeNotSupported | Doesn't support supplied graphics context |
kMoaErr_OutOfMem | Couldn't prepare due to memory error |
kMoaMmErr_InternalError | Couldn't prepare due to internal error |
- CallFunction(PIMoaMmXAssetThis,
- MoaMmSymbolmethodName,
MoaLongnArgs,
ConstPMoaMmValuepArgs,
PMoaMmValuepResult)
This
IMoaMmXAsset
interfacemethodName
MoaMmSymbol
Symbol representing the scripting function
to call. nArgs
MoaLong
Number of arguments, excluding the reserved
value in pArgs[0] pArgs
ConstPMoaMmValue
Pointer to an argument array,
with the first valid argument at pArgs[1] pResult
PMoaMmValue
Pointer to a MoaMmValue instance to receive a result value, if any kMoaErr_NoErr | Function exists, operation successful |
kMoaErr_BadParam | Invalid nArgs, pArgs, or pResult |
kMoaMmErr_FunctionNotFound | Function not supported by this class |
kMoaErr_OutOfMem | Couldn't allocate memory to execute function |
kMoaMmErr_InternalError | Function exists, arguments ok, but couldn't execute |
kMoaMmErr_NoArgExpected | Wrong number of args: 0 expected |
kMoaMmErr_OneArgExpected | Wrong number of args: 1 expected |
kMoaMmErr_TwoArgsExpected | Wrong number of args: 2 expected |
kMoaMmErr_ThreeArgsExpected | Wrong number of args: 3 expected |
kMoaMmErr_FourArgsExpected | Wrong number of args: 4 expected |
kMoaMmErr_WrongNumberOfArgs | Wrong number of arguments, non- specific |
kMoaMmErr_IntegerExpected | Type mismatch: integer value argument expected |
kMoaMmErr_SymbolExpected | Type mismatch: symbol value argument expected |
kMoaMmErr_FloatExpected | Type mismatch: float value argument expected |
kMoaMmErr_StringExpected | Type mismatch: string value argument expected |
kMoaMmErr_PointExpected | Type mismatch: point value argument expected |
kMoaMmErr_RectExpected | Type mismatch: rect value argument expected |
kMoaMmErr_ValueTypeMismatch | Type mismatch: (non-specific) |
kMoaDrErr_CastMemberExpected | Director only. Type mismatch: CMRef expected |
- EndImageAnimThumb(PIMoaMmXAssetThis,
- PIMoaMmGCpGC,
ConstPMoaRectpImageRect)
This
IMoaMmXAsset
interfacepGC
PIMoaMmGC
Pointer to the IMoaMmGC interface for graphics context in which to draw pImageRect
ConstPMoaRect
Pointer to a MoaRect specifying location and size of thumbnail kMoaErr_NoErr | Successful, animation thumbnail sequence ended |
kMoaMmErr_NotImplemented | Asset doesn't have animated thumbnail |
- FinishPropsEditor(PIMoaMmXAssetThis,
- MoaBoolParamcommitChanges,
PMoaMmModifyFlagspModifyFlags)
This
IMoaMmXAsset
interfacecommitChanges
MoaBoolParam
Value reflecting whether user accepted
or canceled modifications to properties pModifyFlags
PMoaMmModifyFlags
Flag representing property modification
state of the Xtra kMoaErr_NoErr | Editing complete, changes committed (if appropriate) |
kMoaMmErr_NotImplemented | Asset doesn't have a property editor |
kMoaErr_OutOfMem | Couldn't commit due to memory error |
kMoaMmErr_InternalError | Couldn't commit due to an internal error |
Value | Description |
---|---|
kMoaMmModifyFlags_None | No media or properties have changed |
kMoaMmModifyFlags_Media | Media data has been modified |
kMoaMmModifyFlags_Props | Properties data has been modified |
- FreeMedia(PIMoaMmXAssetThis)
This
IMoaMmXAsset
interfacekMoaErr_NoErr | Media freed from memory (or no media to free) |
kMoaMmErr_FreeFailed | Media not freed. Host assumes media still in memory. |
- FreeProps(PIMoaMmXAssetThis)
This
IMoaMmXAsset
interfacekMoaErr_NoErr | Properties freed from memory (or no props to free) |
kMoaMmErr_FreeFailed | Properties not freed. Host assumes still in memory. |
- GetDefaultRect(PIMoaMmXAssetThis,
- PMoaRectpRect)
This
IMoaMmXAsset
interfacepRect
PMoaRect
Pointer to a MoaRect to receive the default rectangle kMoaErr_NoErr | Successful |
kMoaMmErr_NotImplemented | Asset doesn't require default rectangle (e.g., transition) |
- GetInMemMediaSize(PIMoaMmXAssetThis,
- MoaUlong FAR *pSizeBytes)
This
IMoaMmXAsset
interfacepSizeBytes
MoaUlong FAR *
Pointer to a MoaUlong to receive the in- memory size of the media asset kMoaErr_NoErr | Successful, value at pSizeBytes set |
- GetInMemPropsSize(PIMoaMmXAssetThis,
- MoaUlong FAR *pSizeBytes)
This
IMoaMmXAsset
interfacepSizeBytes
MoaUlong FAR *
Pointer to a MoaUlong to receive in- memory size of property data kMoaErr_NoErr | Successful, value at pSizeBytes set |
- GetProp(PIMoaMmXAssetThis,
- MoaMmSymbolsymbol,
PMoaMmValuepPropValue)
This
IMoaMmXAsset
interfacesymbol
MoaMmSymbol
MoaMmSymbolrepresenting
the property to get pPropValue
PMoaMmValue
Pointer to MoaMmValue to receive the value requested kMoaErr_NoErr | Property exists, value returned |
kMoaErr_BadParam | Invalid pPropValue |
kMoaMmErr_PropertyNotFound | Property not supported by this asset |
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 |
- GetStreamOutMediaSize(PIMoaMmXAssetThis,
- MoaUlong FAR *pSizeBytes)
This
IMoaMmXAsset
interfacepSizeBytes
MoaUlong FAR *
Pointer to a MoaUlong to receive the storage size of the media asset kMoaErr_NoErr | Successful, value at pSizeBytes set |
- GetStreamOutPropsSize(PIMoaMmXAssetThis,
- MoaUlong FAR *pSizeBytes)
This
IMoaMmXAsset
interfacepSizeBytes
MoaUlong FAR *
Pointer to a MoaUlong to receive the total amount of property data kMoaErr_NoErr |
Successful, value at pSizeBytes set |
- ImageStaticThumb(PIMoaMmXAssetThis,
- PIMoaMmGCpGC,
ConstPMoaRectpImageRect)
This
IMoaMmXAsset
interfacepGC
PIMoaMmGC
Pointer to IMoaMmGC interface for graphics context in which to draw pImageRect
ConstPMoaRect
Pointer to MoaRect specifying location and size of thumbnail kMoaErr_NoErr | Successful, static thumb drawn |
kMoaMmErr_NotImplemented | Asset doesn't have a static thumb |
kMoaMmErr_GCTypeNotSupported | Doesn't support supplied GC type |
kMoaErr_OutOfMem | Couldn't draw due to memory error |
kMoaMmErr_InternalError | Couldn't draw due to an internal error |
- InvokeAboutBox(PIMoaMmXAssetThis)
This
IMoaMmXAsset
interfacekMoaErr_NoErr | Successful, property editor invoked. |
kMoaMmErr_NotImplemented | Class doesn't have a property editor |
kMoaErr_OutOfMem | Couldn't invoke due to memory error |
kMoaMmErr_InternalError | Couldn't invoke due to an internal error |
- InvokeMediaEditor(PIMoaMmXAssetThis,
- PMoaMmModifyFlagspModifyFlags)
This
IMoaMmXAsset
interfacepModifyFlags
PMoaMmModifyFlags
Pointer to a MoaMmModifyFlags to receive modify flags kMoaErr_NoErr | Successful, media editor invoked |
kMoaMmErr_NotImplemented | Class doesn't have a media editor |
kMoaErr_OutOfMem | Couldn't invoke due to memory error |
kMoaMmErr_InternalError | Couldn't invoke due to internal error |
Value | Description |
---|---|
kMoaMmModifyFlags_None | No media or properties have changed |
kMoaMmModifyFlags_Media | Media data has been modified |
kMoaMmModifyFlags_Props | Properties data has been modified |
- InvokePropsEditor(PIMoaMmXAssetThis)
This
IMoaMmXAsset
interfacekMoaErr_NoErr | Successful, property editor invoked. |
kMoaMmErr_NotImplemented | Class doesn't have a property editor |
kMoaErr_OutOfMem | Couldn't invoke due to memory error |
kMoaMmErr_InternalError | Couldn't invoke due to an internal error |
- NewXActor(PIMoaMmXAssetThis,
- PMoaVoid FAR *ppXActor)
This
IMoaMmXAsset
interfaceppXActor
PMoaVoid FAR *
Pointer to either a PIMoaMmXSpriteActor or PIMoaMmXTransitionActor to receive the interface for the new actor kMoaErr_NoErr | Successful, actor created and initialized |
kMoaErr_OutOfMem | Couldn't create actor due to memory error |
kMoaMmErr_InternalError | Couldn't create actor due to internal error |
- Notify(PIMoaMmXAssetThis,
- MoaLongmsgCode,
PMoaVoidrefCon)
This
IMoaMmXAsset
interfacemsgCode
refCon
kMoaErr_NoErr | Notification successful |
kMoaMmErr_UnknownNotifyMsgCode | Notify message code not supported |
- PrepareNewContent(PIMoaMmXAssetThis,
- MoaMmNewFlagsnewFlags)
This
IMoaMmXAsset
interfacenewFlags
kMoaErr_NoErr | Successful. |
kMoaErr_OutOfMem | Couldn't initialize due to memory error |
kMoaMmErr_AssetCreationFailed | User canceled or internal error |
Value | Description |
---|---|
kMoaMmNewFlags_None | No bits are set. If not specified, this field can be a combination of the following flags: |
kMoaMmNewFlags_UiPermitted | If set, the host application permits the display o f UI (such as a modal dialog) during this method call, which might be used to supply a preview or set initial values for the Xtra. If not set, PrepareNewContent() should not invoke any UI, and instead silently set-up the initial default properties and media for the asset. |
kMoaMmNewFlags_AuthorInvoked | If set, the host application calls this method in response to a request from the user initiated through the host application's user interface (that is, the user selected your menu item). If not set, your asset is being created programatically or as a side-effect of some internal operation in the host application (such as duplicating an asset). |
This method returns the following values:
- ServiceImageAnimThumb(PIMoaMmXAssetThis,
- PIMoaMmGCpGC,
ConstPMoaRectpImageRect)
This
IMoaMmXAsset
interfacepGC
PIMoaMmGC
Pointer to IMoaMmGC interface for graphics context in which to draw pImageRect
ConstPMoaRect
Pointer to MoaRect specifying location and size of thumbnail kMoaErr_NoErr | Successful, animation thumb serviced |
kMoaMmErr_NotImplemented | Class doesn't have an animation thumb |
kMoaMmErr_GCTypeNotSupported | Doesn't support supplied GC type |
kMoaErr_OutOfMem | Couldn't update due to memory error |
kMoaMmErr_InternalError | Couldn't update due to internal error |
- SetCallback(PIMoaMmXAssetThis,
- PIMoaMmAssetCallbackpAssetCallback)
This
IMoaMmXAsset
interfacepAssetCallback
PIMoaMmAssetCallback
Pointer to an IMoaMmAssetCallback interface kMoaErr_NoErr | Callback interface set |
kMoaMmErr_NotImplemented | Callback interface not used |
- SetProp(PIMoaMmXAssetThis,
- MoaMmSymbolsymbol,
ConstPMoaMmValuepPropValue)
This
IMoaMmXAsset
interfacesymbol
MoaMmSymbol
MoaMmSymbolrepresenting
the property to get pPropValue
ConstPMoaMmValue
Pointer to MoaMmValue to receive the value requested kMoaErr_NoErr | Property exists and value was set |
kMoaErr_BadParam | Invalid pPropValue |
kMoaMmErr_PropertyNotFound | Property not supported by this asset |
kMoaMmErr_InternalError | Property exists, value ok, can't set due to other error |
kMoaMmErr_NoMemForString | Can't allocate memory for string value data |
kMoaErr_OutOfMem | Can'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 | Type mismatch: CMRef expected (Director only) |
- StreamInMedia(PIMoaMmXAssetThis,
- PIMoaStreampInStream)
This
IMoaMmXAsset
interfacepInStream
PIMoaStream
Pointer to IMoaStream interface to use for streaming in data kMoaErr_NoErr | Successful, media streamed in (or none to stream) |
kMoaErr_OutOfMem | Failed, media not streamed due to memory error |
kMoaMmErr_StreamInFailed | Failed, media not streamed due to internal error. |
- StreamInProps(PIMoaMmXAssetThis,
- PIMoaStreampInStream)
This
IMoaMmXAsset
interfacepInStream
PIMoaStream
Pointer to IMoaStream interface to use for streaming in property data kMoaErr_NoErr | Successful, properties streamed in (or none to stream) |
kMoaErr_OutOfMem | Failed, properties not streamed due to memory error |
kMoaMmErr_StreamInFailed | Failed, properties not streamed due to internal error |
- StreamOutMedia(PIMoaMmXAssetThis,
- PIMoaStreampOutStream)
This
IMoaMmXAsset
interfacepOutStream
PIMoaStream
Pointer to IMoaStream interface to use for streaming out data kMoaErr_NoErr | Successful, media streamed out or no media to stream |
kMoaMmErr_StreamOutFailed | Failed, media not streamed out due to internal error |
- StreamOutProps(PIMoaMmXAssetThis,
- PIMoaStreampOutStream)
This
IMoaMmXAsset
interfacepOutStream
PIMoaStream
Pointer to the IMoaStream interface to use for streaming out property data kMoaErr_NoErr | Successful, static thumb drawn |
kMoaMmErr_NotImplemented | Asset doesn't have a static thumb |
kMoaMmErr_GCTypeNotSupported | Doesn't support supplied GC type |
kMoaErr_OutOfMem | Couldn't draw due to memory error |
kMoaMmErr_InternalError | Couldn't draw due to an internal error |