Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Publisher::IPublisher Class Referenceabstract

Defines an interface that represents publisher. This interface must be implemented by a publisher plugin. More...

#include <IPublisher.h>

Inheritance diagram for Publisher::IPublisher:

Public Member Functions

virtual FCM::Result _FCMCALL Publish (DOM::PIFLADocument pFlaDocument, const PIFCMDictionary pDictPublishSettings, const PIFCMDictionary pDictConfig)=0
 This function is "typically" called by 'Adobe Animate CC' in the Publish/Test-Movie workflow. The implementor of this function must publish the entire FLA Document on invocation of this function. More...
 
virtual FCM::Result _FCMCALL Publish (DOM::PIFLADocument pFlaDocument, DOM::PITimeline pTimeline, const Exporter::Service::RANGE &frameRange, const PIFCMDictionary pDictPublishSettings, const PIFCMDictionary pDictConfig)=0
 This function is "typically" called by 'Adobe Animate CC' in the Test-Scene/Test-Movie workflow. The implementor of this function must publish the timeline on invocation of this function. More...
 
virtual FCM::Result _FCMCALL ClearCache ()=0
 On invocation of this function, the publisher must clear its cache (if it maintains one). More...
 

Detailed Description

Defines an interface that represents publisher. This interface must be implemented by a publisher plugin.

Member Function Documentation

virtual FCM::Result _FCMCALL Publisher::IPublisher::ClearCache ( )
pure virtual

On invocation of this function, the publisher must clear its cache (if it maintains one).

Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
virtual FCM::Result _FCMCALL Publisher::IPublisher::Publish ( DOM::PIFLADocument  pFlaDocument,
const PIFCMDictionary  pDictPublishSettings,
const PIFCMDictionary  pDictConfig 
)
pure virtual

This function is "typically" called by 'Adobe Animate CC' in the Publish/Test-Movie workflow. The implementor of this function must publish the entire FLA Document on invocation of this function.

Parameters
pFlaDocument(IN) Document to be published.
pDictPublishSettings(IN) Dictionary containing values set in the publish settings dialog.
pDictConfig(IN) Publish configuration parameters. These are controlled by 'Adobe Animate CC' and the plug-ins have no control over them. For e.g., pDictConfig[kPublishSettingsKey_PreviewNeeded] = "true" or "false";
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
virtual FCM::Result _FCMCALL Publisher::IPublisher::Publish ( DOM::PIFLADocument  pFlaDocument,
DOM::PITimeline  pTimeline,
const Exporter::Service::RANGE &  frameRange,
const PIFCMDictionary  pDictPublishSettings,
const PIFCMDictionary  pDictConfig 
)
pure virtual

This function is "typically" called by 'Adobe Animate CC' in the Test-Scene/Test-Movie workflow. The implementor of this function must publish the timeline on invocation of this function.

Parameters
pFlaDocument(IN) Document containing the timeline.
pTimeline(IN) Timeline to be published. It may correspond to a movie-clip or a scene itself. This will be never be NULL.
frameRange(IN) Range of frames to be published.
pDictPublishSettings(IN) Dictionary containing values set in the publish settings dialog.
pDictConfig(IN) Publish configuration parameters. These are controlled by 'Adobe Animate CC' and the plug-ins have no control over them. For e.g., pDictConfig[kPublishSettingsKey_PreviewNeeded] = "true" or "false";
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
The documentation for this class was generated from the following file: