Articulate Presenter 5.0 Player SDK

Transcription

1 Note - this is the preview version of the documentation and excludes certain details required for implementation. The full documentation and the associated sample files are available to Articulate Platinum Membership Plan members at no charge. The gives Flash developers the ability to create custom Flash movies that extend and interact with the Articulate Presenter 5.0 Player. With the SDK, developers are able to: Add functionality by developing custom player tabs. Add player features by creating custom player toolbar items. Customize certain player assets. Communicate with the player via runtime API methods. This documentation, along with the included sample files will provide you with tools to get you started. creating custom tabs Articulate Presenter 5.0 ships with four tabs - Outline, Thumbnails, Notes and Search. In addition, you can create your own custom tabs to provide additional features and functionality for the Player. You create custom tabs by modifying the supplied.fla file in Flash MX and also editing an XML file. Locate the sample tab in the folder named Test_Tab. This folder contains the source FLA file TestTab.fla, the compiled SWF file TestTab.swf, and the art_plugins.xml file that references the TestTab.swf file. To add this test tab to any presentation simply copy the SWF and XML file to the player folder of any published presentation. Create your own custom tab by first modifying the FLA file in Flash MX. Publish your SWF for Flash Player 6. Tabs are then added to the Player by modifying the file art_plugins.xml. Within the modules section, define an item for each custom tab in your presentation. A typical item will look the following: <item> <id>5050</id> <type>navmod</type> <file>newtab.swf</file> <labeltext>new Tab</labeltext> <scrollenabled>true</scrollenabled> </item> Below is a quick description of the tags: id An internally used ID. It must be a number and unique among all item IDs. type Determines whether the custom item is a toolbar or a tab item. Use navmod for tab items; use toolmod for toolbar items. file Defines the SWF the Player will display when the item is activated. labeltext The text that is displayed on the tab or toolbar button. scrollenabled If the item is a tab, this value enables or disables the scrollbar. - 1 of 8 -

2 All tags are required except for scrollenabled. You may add more tags to provide the item with more information. Once built, your custom tabs and toolbar items can be added to any presentation by simply copying your SWF and XML files to the published output s player folder. You can also automatically include your custom tabs and toolbar items in every publish by copying them to the player folder within the program. This way, they will be included in the published output with each future publish. Assuming you installed Articulate Presenter 5 to the default location, the folder will live here: C:\Program Files\Articulate\Presenter\players 5.0\core\player creating custom toolbar items Articulate Presenter 5.0 Player includes several toolbar items accessed from the upper-right of the Player. The standard toolbar items include Attachments, Bookmark, Send Link, and Exit. Like tabs, you can create your own custom toolbar items to provide additional features and functionality to the Player. Adding a custom toolbar item is similar to adding a custom tab. Locate the sample toolbar item in the folder named Test_Tool. This folder contains the source FLA file TestTool.fla, the compiled SWF file TestTool.swf, and the art_plugins.xml file that references the TestTool.swf file. To add this toolbar item to any presentation simply copy the SWF and XML file to the player folder of any published presentation. Create your own custom toolbar item by first modifying the FLA file in Flash MX. When creating your Custom toolbar item, you must implement a function named artmoduleapi. This function is a command handler that should handle events from the Player. It should handle the following commands: activate_onclick activate deactivate A typical implementation of this command handler follows: function artmoduleapi( command ) { switch(command) { case activate_onclick : case activate : gotoandplay( activate ); break; case deactivate : gotoandplay( deactivate ); break; } } - 2 of 8 -

3 Additionally, it is the responsibility of the toolbar item to define a Boolean variable named artmoduleisactive at the item s base level and set the value of this variable based on whether or not the toolbar item is active or not. When finished authoring your custom toolbar item, publish your SWF for Flash Player 6. As with tabs, create a new item tag within art_plugins.xml for each custom toolbar item you wish to add to your presentation. A typical toolbar item will look similar to the following: <item> <id>5050</id> <type>navtool</type> <file>newtoolbaritem.swf</file> <labeltext>new Tool</labeltext> </item> modifying assets An asset is a Player component that resides outside of the core player files. Assets are usually required for the Player to function normally. Asset file names contain the prefix ast_. Not all assets can be modified; you will find all modifiable assets in the included Assets folder. Below is a list of the supplied FLA files followed by a brief description. ast_loader.fla A preloader for inserted Flash Movies that buffers the movie and allows the player controls to control the inserted movie. ast_navicons.fla Defines the icons that are displayed in the Outline view of the navigation used to expand and collapse the list. ast_remote.fla Defines a floating control to replace the normal controls that are in view mode three. To enable the floating controls add the following XML to your published playerproperties.xml file: <floatcontrols> <left>10000</left> <top>10000</top> <inneralpha>100</inneralpha> <outeralpha>100</outeralpha> </floatcontrols> You will find an example of ast_remote.fla in use in the included sample presentation; toggle to the slide-only display mode to view it. Contained within each FLA file on the layer named Implementation Notes, you will find any special instructions needed to modify or create your own asset. - 3 of 8 -

4 the articulate api object The Articulate API object is a global variable and is accessible to a Flash movie loaded within the playershell.swf simply by referencing API. However, if the loaded SWF was published for a different version of Flash then version 6, the global object may not be accessible. For this reason we strongly encourage you to reference the API Object at _level0. You can find a sample movie that implements the API in the folder Flash_Object. This folder contains the source FLA and the generated SWF. methods Below is a list of the methods exposed by the API: Play() Causes the player to continue playing. If the player is already playing then it does nothing. Pause() Pauses the player if it is currently playing. If the player is already paused then it has no effect. LockPlay(bLocked) Locks the play /pause button so that the user can t start or stop the presentation until it is unlocked. PlayNext() Plays the next slide. PlayPrevious() Plays the previous slide. PlaySlideNum(nSlideNum) Plays the slide specified by nslidenum. nslidenum must be an integer greater then 0 and less then or equal to the number of slides in the presentation. GotoFrame(nFrameNum) Goes to the frame specified by nframenum in the current slide. - 4 of 8 -

5 SetDisplayMode(strDisplayMode) Changes the display mode to the mode specified by strdisplaymode. strdisplaymode can have the following values: 1 The standard view 2 The no sidebar view 3 The slide only view next toggles the display mode to the next enabled view previous toggles the display mode previous enabled view GetDisplayMode() Returns a number representing the current display mode. For more details see Set- DisplayMode. GetCurrentSlide() Returns the index of the currently displayed slide IsPlaying() Returns true if the slide is playing and false if it has been paused. GetCurrentSlideTime() Returns the current position in seconds within the slide. GetCurrentPresentationTime() Returns the current position in seconds within the presentation. GetSlideCount() Returns the number of slide contained within the presentation. GetVolume() Returns the Volume setting. SetVolume(nVolume) Sets the volume to the value specified by nvolume. nvolume should be a number between 0 and of 8 -

6 GetSlideInfo(nSlideNum) Returns a slide info object. Supported properties: oslideinfo.strfilename The slide file SWF name oslideinfo.strbgswf The slide background SWF name oslideinfo.nplaylistid The slide s playlist id oslideinfo.strtitle The slide title oslideinfo.strslidetext The slide text oslideinfo.strnotes The slide notes oslideinfo.nslidetime The slide duration oslideinfo.bwaitforuser Determines if the slide waits when it reaches the end or plays the next slide oslideinfo.nframerate The slide framerate oslideinfo.nlevel The nesting level of the slide GetModuleData(nModuleId) Returns a reference to the array representation of the xml for the specified module ID. The structure of this array may vary depending on the data included in the modules xml. GetPlayerData() Returns a reference to the array representation of the xml data contained within playerproperties.xml. GetPresentationData() Returns a reference to the an array representation of the xml data contained within presentation.xml. EnableKeyboardShortcuts(bEnable) Enables or disables keyboard shortcuts based on the value of benable. IsColorized() Returns true if a color scheme has been enabled for the player. - 6 of 8 -

7 GetColorInfo() Returns a color info object. Properties supported: ColorInfo.Core.strText ColorInfo.Core.strSlideBg ColorInfo.Core.strAccentLines ColorInfo.Core.strSideBarBg ColorInfo.Core.strPlayerBg ColorInfo.Sidebar.strTouch ColorInfo.Sidebar.strIcon ColorInfo.Sidebar.strSeperator ColorInfo.Sidebar.strSlideSelected ColorInfo.Sidebar.strSlideRollover ColorInfo.Button.strText ColorInfo.Button.strFace ColorInfo.Button.strRollover ColorInfo.Tab.strText ColorInfo.Tab.strBorder ColorInfo.Tab.strRollover ColorInfo.Tab.strTopGrad ColorInfo.Tab.strBottomGrad ColorInfo.Scrollbar.strFace ColorInfo.Scrollbar.strTrack ColorInfo.Scrollbar.strArrows ColorInfo.TopBar.strGradTop ColorInfo.TopBar.strGradBottom ColorInfo.BottomBar.strGradTop ColorInfo.BottomBar.strGradBottom ColorInfo.Tooltip.strText ColorInfo.Tooltip.strBackground ColorInfo.Tooltip.strBorder ColorInfo.Playback.strGradTop ColorInfo.Playback.strGradBottom - 7 of 8 -

8 adding your custom api swf to your presentation When inserting a Flash movie that contains the API into a slide, follow the steps: 1. From the PowerPoint menubar, Click Articulate Insert Flash Movie. 2. Click Next. 3. Select Display in slide. 4. Browse and select the Flash movie that contains the API 5. Click Next. 6. Select the radio button Show Flash Movie seconds into the slide. 7. Change the other options to your preference. 8. Click Next. 9. Click Finish. Visit us at ABOUT ARTICULATE Articulate is the global leader in rapid e-learning. Thousands of corporate, government and academic customers in more than 50 countries use our powerful, intuitive technologies to train and communicate rapidly, widely and effectively. We know how people learn. We understand how organizations work. We believe that superior learning and communications technology, widely available across your enterprise, provides competitive advantage. That s what Articulate is all about putting the power of rapid e-learning in the hands of anyone who needs to share knowledge. Our goal is to ensure that you can train, motivate, inform and persuade the people who will move your organization forward. Copyright 2005, Articulate Global, Inc. All rights reserved. Read End-User License Agreement for terms and conditions. Articulate and all other trademarks mentioned in this document are the property of their respective owners.