iSpring SDK COM API
What is iSpring SDK COM API?
iSpring SDK COM API (the COM API) is an Application Programming Interface based on Microsoft COM technology that converts PowerPoint presentations into web-friendly HTML5 format. It is accessible from all popular programming languages and environments that support COM technology, such as C#, Visual Basic, Visual Basic .NET, C++, Delphi, PHP, ASP.NET, VB Script, ASP, Java (via the Java wrapper), Python, JavaScript, and JScript.
iSpring SDK COM API Usage
The main functionality of the COM API is implemented in the iSpringSDK.dll COM module. Some programming languages such as C# and Visual Basic require adding the COM library reference to the project, while other programming languages do not.
Adding the iSpring SDK COM library reference to a C# project
Right-click the References item of the Microsoft Visual Studio Solution Explorer and choose Add Reference.
The Reference Manager window will be opened. Under the COM tab, select Type Libraries. Next, tick iSpring SDK.
After that, the COM API classes and interfaces become accessible from the C# source code.
iSpring SDK COM API Classes and Interfaces
The COM API exposes the classes, interfaces, and enumeration types that can be accessed from programming languages.
The main class exposed by the COM API is PresentationConverter. It is used to open and convert a PowerPoint presentation to HTML5 format. It also provides access to the conversion settings, presentation, and available skin modules.
The following classes are exposed by the COM API:
| Name | Description |
|---|---|
| PresentationConverter Class | The main class of the COM API. Provides PowerPoint to HTML5 conversion facilities. |
| PresentationConverterFast Class | The main class of the COM API. Provides PowerPoint to HTML5 conversion facilities. |
The following interfaces are exposed by the COM API:
| Name | Description |
|---|---|
| ILicenseManager Interface | Provides current activation state and facilities for activation and deactivation. |
| II18nSettings Interface | Provides the facility of adding translations for skin texts. |
| IHtml5SkinSettings Interface | Provides HTML5 player skin settings. |
| IHtml5PublishingSettings Interface | Presents HTML5 presentation publishing settings. |
| IHtml5SkinModule Interface | Contains skin module settings designated to convert PPT to HTML5. |
| ISkin Interface | Provides information about the HTML5 player skin. |
| IPresentationConverter Interface | he main interface of the SDK that provides all of the facilities |
| IZipCompressionSettings Interface | Allows zipping of the generated presentation. |
| IWatermarkSettings Interface | Allows the adding and positioning of a custom watermark. |
| ITimeRestrictions Interface | Presents settings that restrict presentation viewing to the specified period of time. |
| IProtectionSettings Interface | Provides copyright protection functions. |
| IGesturesSettings Interface | Allows configuration gestures that are supported by the presentation. |
| IMouseSettings Interface | Allows configuration of mouse navigation settings. |
| IKeyboardSettings Interface | Allows configuration of keyboard navigation settings (hotkeys) |
| INavigationSettings Interface | Presents HTML5 presentation navigation settings. |
| IHtml5SecuritySettings Interface | Presents presentation security settings. |
| IMediaSettings Interface | Presents multimedia object compression and conversion settings. |
| IAppearanceSettings Interface | Presents HTML5 presentation appearance settings. |
| ICompressionSettings Interface | Presents presentation video, audio, and image compression settings. |
| IHtml5PlayerCorePlugins Interface | Presents a collection of the player core plug-ins. |
| IHtml5PresentationPlayerSettings Interface | Presents HTML5 presentation player settings. |
| IHtml5Settings Interface | Provides HTML5-specific publishing settings. |
| IPresentationContentSettings Interface | Enables and disables publishing of additional presentation content. |
| IPlaybackSettings Interface | Presents HTML5 presentation playback settings. |
| ISettings Interface | Provides access to presentation converter settings. |
| IExternalResource Interface | Provides information about external presentation resources. |
| IExternalResources Interface | Presents a collection of external presentation resources. |
| IPresentationInfo Interface | Provides information about external presentation resources. |
| Provides information about a picture used as a presenter's photo or a company logo. | |
| Provides information about a presenter's company. | |
| IPresenter Interface | Provides information about a presenter. |
| IPresenters Interface | Presents a collection of presenters. |
| ISlide Interface | Provides information about a PowerPoint presentation slide. |
| ISlides Interface | Presents a collection of PowerPoint presentation slides. |
| IPresentation Interface | Provides information about the opened PowerPoint presentation. |
The following enumerations are exposed by the COM API.
| Name | Description |
|---|---|
| VideoPlayerTypeEnum Enumeration | Defines the possible player types for slide video objects. |
| AudioBitrate Enumeration | Presents possible audio bitrate values |
| PlaybackAction Enumeration | Defines the action occurring on mouse click. |
| WatermarkAlignment Enumeration | Defines options for watermark position alignment. |
| PresentationScanMode Enumeration | Specifies which external resources should be scanned. |
| ExternalResourceStatus Enumeration | Defines the status of the presentation's external resources. |
| ExternalResourceType Enumeration | Defines the types of the presentation's external resources. |
| ImageFileType Enumeration | Defines the possible image file types. |
| PresentationType Enumeration | Defines types of converted presentation - either solid or compound. |
| LicenseType Enumeration | Defines the possible license types. |
| ConversionMode Enumeration | Defines the presentation's possible modes of conversion. |
| ImageQuality Enumeration | Presents the named constants for lossy image quality settings. |
| ResumeMode Enumeration | Specifies whether or not to resume playback from the last viewed slide. |
| SubDomainCommunicationMode Enumeration | Access options to presentation's JS API from subdomains. |