iSpring SDK COM API

Table of content

What is iSpring SDK COM API?

iSpring SDK COM API is Application Programming Interface based on Microsoft COM technology performing PowerPoint presentations conversion to Web friendly Flash movies. It is accessible from all popular programming languages and environments supporting COM technology such as: C#, Visual Basic, Visual Basic .NET, C++, Delphi, PHP, ASP.NET, VB Script, ASP, Java (via iSpring SDK Java wrapper), Python, JavaScript, JScript, and many others.

iSpring SDK COM API usage

Main functionality of the iSpring SDK COM API is implemented in iSpringSDK_2003.dll and iSpringSDK_2007.dll COM modules. Some programming languages such as C# and Visual Basic require adding iSpring SDK COM library reference to the project, while other programming languages do not.

Adding iSpring SDK reference to a C# project

Right click the References item of the Microsoft Visual Studio Solution Explorer and choose the Add Reference... item.

Microsoft Visual Studio References menu

The Add Reference window will be opened. In the COM tab select iSpring 5.0 Type Library item.

Add Reference Window

After that, iSpring SDK classes and interfaces become accessible from the C# source code.

iSpring SDK COM API classes and interfaces

iSpring SDK COM API exposes a number of classes, interfaces and enumeration types which can be accessed from programming languages. They are shown in the following diagram.

Figure 1. iSpring SDK COM API diagram

A main class exposed by the COM API is the PresentationConverter. It allows to open PowerPoint presentations and convert them to Flash format. It also provides access to the conversion settings and available skin modules.

The following classes are exposed by iSpring SDK COM API.

Name Description
PresentationConverter Class Provides PowerPoint to Flash conversion facilities, it is a main class of the iSpring SDK

The following interfaces are exposed by iSpring SDK COM API.

Name Description
_iSpringEvents Interface Provides information about presentation conversion progress
AppearanceSettings Interface Represents Flash presentation appearance settings
BackgroundAudioSettings Interface Represents presentation background audio settings
Company Interface Provides information about presenter company
CorePlugin Interface Provides player core plugin information
CorePlugins Interface Represents a collection of the player core plugins
ExternalResource Interface Provides information about external resource of the presentation
ExternalResources Interface Represents a collection of the external presentation resources
Image Interface Provides information about picture used as presenter photo or company logo
MediaSettings Interface Represents multimedia objects compression and conversion settings
NavigationSettings Interface Represents Flash presentation navigation settings
PasswordSettings Interface Provides facilities for presentation protection from unauthorized viewing
PlaybackSettings Interface Represents Flash presentation playback settings
PlayerSettings Interface Represents Flash presentation player settings
Plugins Interface Provides an access to the Presentation converter plugins
Preloader Interface Provides an information about Flash player preloader
Preloaders Interface Represents a collection of Flash player preloaders
Presentation Interface Provides information about the opened PowerPoint presentation
PresentationInfo Interface Provides information about external resources of the presentation
Presenter Interface Provides information about presentation presenter
Presenters Interface Represents a collection of presentation presenters
ProtectionSettings Interface Provides copyright protection facilities
PublishSettings Interface Represents Flash presentation publish settings
Settings Interface Provides access to presentation converter settings
Skin Interface Provides an information about Flash player skin
Skins Interface Represents a collection of Flash player skins
SkinSettings Interface Provides Flash player skin settings
Slide Interface Provides an information about PowerPoint presentation slide
Slides Interface Represents a collection of PowerPoint presentation slides
VideoConverter Interface Provides facilities for video files conversion
VideoObjectInfo Interface Stores information about video object
VideoParameters Interface Stores video file conversion parameters
VideoPlugins Interface Allows replacing standard video processing functionality with the custom one
VideoObjectProcessor Interface Detects whether the video object should be converted with specific VideoConverter or not
Watermark Interface Provides facilities for adding custom watermarks to the generated Flash content

The following enumerations are exposed by iSpring SDK COM API.

Name Description
AudioBitrateEnum Enumeration Represents possible audio bitrates values
BuiltInPluginType Enumeration Defines player built-in plugin types
ConversionMode Enumeration Defines the possible modes of the presentation conversion
ExternalResourceStatus Enumeration Defines status of external resource of the presentation
ExternalResourceType Enumeration Defines type of external resource of the presentation
FlashVideoFormat Enumeration Defines various video formats supported by Adobe Flash player
FlashVideoFormat Enumeration Defines various video formats supported by Adobe Flash player
ImageFileType Enumeration Defines the possible image file types
MouseClickAdvanceType Enumeration Represents all possible mouse click advance types
PresentationScanFlag Enumeration Defines where external resources should be searched by the Scan method
VideoConversionResult Enumeration Defines the possible results of the video file conversion process
VideoObjectPlaybackMode Enumeration Defines the possible modes of slide video objects playback
VideoObjectProcessingResult Enumeration Defines the possible results of the slide video objects processing
VideoObjectType Enumeration Defines the possible video object types which can be contained in the presentation
VideoPlayerTypeEnum Enumeration Defines the possible player types for slide video objects
WatermarkAlignment Enumeration Defines the possible modes of the watermark position alignment