Developing OSMF Plug-Ins

From KickApps Documentation

Contents 1 About OSMF 2 OSMF & KickApps 3 About App Studio Plug-Ins 4 Upload an OSMF Plug-In 5 Debug an OSMF Plug-In 6 Update an OSMF Plug-In

About OSMF

From osmf.org:

"Open Source Media Framework (OSMF) simplifies the development of media players by allowing developers to assemble components to create high-quality, full-featured video playback experiences. This open framework enables development focused on web-based video monetization, with lower costs and faster turnaround."

OSMF & KickApps

KickApps has partnered with Adobe to create the OSMF App Studio, a version of the KickApps App Studio designed specifically to make it easy to create media players built on OSMF, as well as develop, test, and distribute OSMF plug-ins. In the coming months we'll be moving all media players in both OSMF App Studio and the main App Studio over to work on top of OSMF instead of our proprietary media players, which means that OSMF plug-in developers will be able to offer their plug-ins to over 100,000 KickApps publishers in both the OSMF App Studio and the main App Studio.

About App Studio Plug-Ins

The KickApps App Studio is a WYSIWYG interface for creating full-featured video players and other Flash widgets with drag and drop ease. The App Studio is fully instrumented to incoporate plug-ins, including OSMF plug-ins. Learn more about App Studio Plug-Ins.

Upload an OSMF Plug-In

1. Log in to the OSMF App Studio, or log in to the Affiliate Center, then click the App Studio tab.
2. Create a new App Studio project from scratch by selecting the App Studio tab and then clicking File > New.
3. From the Templates panel on the left, drag the OSMF Video Player template to the stage.
4. Click the video player to select it, then, on the right, click the Manage Plug-Ins button in the OSMF Plug-ins panel.
5. Click the Add button to upload your OSMF Plug-In. In addition to your plug-in .swf you can also upload a YAML config file that will be used to generate a config panel in the App Studio, if your plug-in requires user configuration (like entering an Account ID).
6. Your plug-in will appear in the My Plug-Ins screen within the OSMF Plug-Ins pop-up window. Click the Install button next to it to load it into your App Studio project.

Debug an OSMF Plug-In

1. Follow the directions above to upload your OSMF Plug-In.
2. Open Firebug.
3. From the View menu, select Developer > Debug Preview to launch a preview window with your project. Logs from the App Studio, OSMF, and your plug-in will appear in the Firebug console.

Update an OSMF Plug-In

Updating your OSMF plug-in is easy. Simply make the changes you need in your plug-in .swf or plug-in YAML files, save them to the same path and file names on your hard drive, then, back in the App Studio, make sure to exit the Debug Preview, then click the Reload button in the My Plug-Ins screen of the OSMF Plug-Ins window. |