Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ApplicationFCMPublicIDs.h File Reference

This file contains the dictionary keys and GUIDs for all the required interfaces that help you access the services that the interface provides. The definitions in this file are valid for CPSDK version 1.3 onwards (or for 'Adobe Animate CC'). More...

#include "FCMPreConfig.h"
#include "FCMTypes.h"
#include "FCMPostConfig.h"

Go to the source code of this file.

Namespaces

 DOM
 Provides interfaces and other definitions to access the FLA authored contents in the form of a DOM (Document Object Model).
 
 DOM::Utils
 Provides utility interfaces and definitions.
 
 Application
 Provides interfaces for 'Adobe Animate CC' Application.
 
 Application::Service
 Provides service interfaces for 'Adobe Animate CC' Application.
 
 Exporter
 Provides interfaces for exporter that can be used by custom publisher.
 
 Exporter::Service
 Provides service interfaces for exporter.
 
 DOM::Service
 Provides service interfaces for DOM access.
 
 DOM::Service::Tween
 Provides service interfaces for Tween.
 

Macros

#define kApplicationCategoryKey_DocType   "Application.Component.Category.DocType"
 Doc type category key. The value for this key should be a dictionary that defines a document type.
 
#define kApplicationCategoryKey_Publisher   "Application.Component.Category.Publisher"
 Publisher category Key. The value for this key should be a dictionary that defines a publisher.
 
#define kApplicationCategoryKey_Name   "Application.Component.Category.Name"
 The name key of the category. The value for this key should have the name of the category of the component. A component may belong to many categories. Publisher and DocType are examples of categories.
 
#define kApplicationCategoryKey_UniversalName   "Application.Component.Category.UniversalName"
 The universal name key of the category. The value for this key should have the universal name of the category of the component. A component may belong to many categories.
 
#define kApplicationDocTypeKey_Desc   "Application.Component.DocType.Desc"
 DocType description key. The value for this key should have the description about the DocType.
 
#define kApplicationPublisherKey_UI   "Application.Component.Publisher.UI"
 The ui key of the Publisher. The value is the ID of the publish settings UI.
 
#define kApplicationPublisherKey_TargetDocs   "Application.Component.Publisher.TargetDocs"
 The target docs key of the Publisher. The value is a dictionary with keys as the target doc IDs supported by the Publisher. The values in the dictionary are ignored.
 
#define kPublishSettingsKey_IncludeInvisibleLayer   "PublishSettings.IncludeInvisibleLayer"
 This is a publish setting key used to configure if the invisible (hidden) layers need to be included as part of the export. This key can be used for any generic 3rd party publisher. "Adobe Animate CC" interprets this key and updates the stage and library item preview based on the settings of this key. Valid range is: "true" and "false". If this key is not set or an invalid value is set, the default value of "true" is used.
 
#define kPublishSettingsKey_PreviewNeeded   "PublishSettings.PreviewNeeded"
 This is a publish setting key used to set if preview is needed during publish. The value for this key can be set by "Adobe Animate CC" only. It is set to "true" in publish workflows where preview needs to be shown such as "TestMovie" and set to "false" in workflow such as "Publish". Note that plug-in cannot set this value.
 
#define kSWFPublishSettingsKey_PlayerVersion   "SWF.PublishSettings.PlayerVersion"
 This is a publish setting key used to set the SWF player target version. Valid values are : "FlashPlayer10.3", "FlashPlayer11.1", "FlashPlayer11.2", "FlashPlayer11.3", "FlashPlayer11.4", "FlashPlayer11.5", "FlashPlayer11.6", "FlashPlayer11.7", "FlashPlayer11.8", "FlashPlayer11.9", "FlashPlayer12.0", "FlashPlayer13.0". If this key is not set or an invalid value is set, it uses the highest player version installed in the machine. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_ASVersion   "SWF.PublishSettings.ASVersion"
 This is a publish setting key used to set the ActionScript version. Only valid value is "3". If this key is not set or an invalid value is set, default value "3" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_BitmapQuality   "SWF.PublishSettings.BitmapQuality"
 This is a publish setting key used to set the bitmap quality. Valid range is "1" to "100". If this key is not set or an invalid value is set, the default value "50" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_EnableDeblockingFilter   "SWF.PublishSettings.EnableDeblockingFilter"
 This is a publish setting key used to enable/disable de-blocking filter. Valid values are "true" and "false". If this key is not set or an invalid value is set, the default value "false" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_EnableMovieCompression   "SWF.PublishSettings.EnableMovieCompression"
 This is a publish setting key used to enable movie compression. Valid values are "true" and "false". If this key is not set or an invalid value is set, the default value "true" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_MovieCompressionType   "SWF.PublishSettings.MovieCompressionType"
 This is a publish setting key used to set the type of movie compression. kSWFPublishSettingsKey_EnableMovieCompression must be set to "true" for this key to be effective. Valid range is : "Deflate" and "LZMA". If this key is not set or an invalid value is set, default value of "Deflate" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_EnableSizeReport   "SWF.PublishSettings.EnableSizeReport"
 This is a publish setting key used to enable/disable size report. Valid range is "true" and "false". If this key is not set or an invalid value is set, the default value of "false" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_EnableOmitTrace   "SWF.PublishSettings.EnableOmitTrace"
 This is a publish setting key used to enable/disable omit trace. Valid range is "true" and "false". If this key is not set or an invalid value is set, the default value "false" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_ScriptTimeLimit   "SWF.PublishSettings.ScriptTimeLimit"
 This is a publish setting key used to set script time limit. If this key is not set or an invalid value is set, the default value "15" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_PlaybackSecurity   "SWF.PublishSettings.PlaybackSecurity"
 This is a publish setting key used to set playback security. Valid values are "LocalAccess" and "NetworkAccess". If this key is not set or an invalid value is set, the default value "LocalAccess" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 
#define kSWFPublishSettingsKey_HardwareAcceleration   "SWF.PublishSettings.HardwareAcceleration"
 This is a publish setting key used to configure Hardware acceleration mode. Valid values are "None," "Direct," and "GPU". If this key is not set or an invalid value is set, the default value "None" is used. This should be used only if the SWF export service (ISWFExportService) is used.
 

Detailed Description

This file contains the dictionary keys and GUIDs for all the required interfaces that help you access the services that the interface provides. The definitions in this file are valid for CPSDK version 1.3 onwards (or for 'Adobe Animate CC').