• How to extend Wowza Streaming Engine using the Wowza IDE

    The Wowza™ IDE is an AddOn to the Eclipse integrated development environment (http://www.eclipse.org) that simplifies the process of building Java projects and classes to extend and enhance the functionality of the Wowza Streaming Engine™ media server software. The Wowza IDE is available for Windows, Linux, and OS X, and it's packaged as a software update site that can be added to Eclipse 4.3 (Kepler) or later. This article explains how to extend the Wowza Streaming Engine software using the Wowza IDE.

    For more information about developing for Wowza Streaming Engine, see the Wowza Developers webpage. Additionally, see How to extend Wowza Streaming Engine using Java to learn more about writing a Java extension for Wowza Streaming engine. The Wowza Streaming Engine Server-side API Guide and Wowza Streaming Engine Java API online articles describe how to write Java code to extend and enhance the Wowza Streaming Engine software.

    Contents


    Install Eclipse IDE for Java Developers
    Create a Wowza Streaming Engine project
    Add a project module to an application
    Add a class to your project

    Install Eclipse IDE for Java Developers


    Before building Java projects and classes to extend Wowza Streaming Engine using the Wowza IDE, you must install and configure Eclipse IDE for Java Developers 4.3 (Kepler) or later.

    1. Download and run Eclipse IDE for Java Developers (Eclipse IDE version 4.3 or later).

    2. On the Help tab, click Install New Software.

    3. In the Available Software dialog, click Add.

    4. In the Add Repository dialog, enter the following information and then click OK.

      • Name - Enter Wowza.

      • Location - Enter http://www.wowza.com/wowzaide4/.

        Note: To download the Wowza IDE package, you must enter the URL in the Eclipse interface as the repository's location. If you enter the location URL in a web browser, an HTTP 403 error is returned.
    5. In the Available Software dialog, check the box next to Wowza IDE 4 and then click Next.

    6. In the Review Licenses dialog, select I accept and then click Finish.

    7. Follow the remaining prompts to install the software and restart Eclipse.

    To access a list of the wizards, go to the File tab, click New, and then select Other. You should see the following Wowza Streaming Engine wizards:

    • Wowza Streaming Engine Project

    • Wowza Streaming Engine Module Class

    • Wowza Streaming Engine HTTPProvider Class

    • Wowza Streaming Engine ServerListener Class

    Create a Wowza Streaming Engine project


    After installing and configuring Eclipse IDE for Java Developers, you can create new projects to extend the Wowza Streaming Engine software. A project is a complete Wowza Streaming Engine extension that produces a .jar file with the same name as the project. To create a new project:

    1. On the File tab, click New and select Other.

    2. On the Select a Wizard page of the new project dialog, click Wowza Streaming Engine Project and then click Next.

    3. On the New Wowza Streaming Engine Java Project page, enter the following information and then click Next:

      • Project Name - A name for the project and the .jar file output. The name can't contain spaces.

      • Location - The path to the Wowza Streaming Engine installation that the module will be added to. This should be automatically populated for you.

    4. On the New Wowza Streaming Engine Module Class page, enter the following information:

      • Package - The Java package path for your project. The path can't begin or end in a period (.), and a reverse domain is the Java convention. For example, com.mycompany.wowza.

      • Name - A name for the module class. Camel case is the Java convention. For example, MyWowzaModule.

    5. Click Finish

    Each time you change the code in a project, the Wowza IDE automatically compiles and binds the code into the .jar file using the build.xml Ant script and saves it in the [install-dir]/lib folder. The Wowza Streaming Engine server loads each of the .jar files in the [install-dir]/lib folder on startup and makes them available for use.

    Add a project module to an application


    Add the module to an application configuration in a Wowza Streaming Engine server using the project's information.

    1. Sign in to Wowza Streaming Engine Manager, click the Applications tab at the top of the page, and then click on the application you want to add the module to.

    2. Click the Modules tab, and then click Edit.

    3. Click Add Module and enter the following information based on the values entered when creating a Wowza Streaming Engine project:

      • Name - Enter the name of the project's module class. For example, MyWowzaModule.

      • Description - Enter the name of the project's module class again. For example, MyWowzaModule.

      • Fully Qualified Class Name - Enter the project's package path (com.mycompany.wowza), followed by a period (.) and the name of the project's module class (MyWowzaModule). For example: com.mycompany.wowza.MyWowzaModule.

    4. Click Add.

    Add a class to the project


    The other Wowza Streaming Engine wizards in Eclipse IDE for Java Developers can be used to add additional classes to your project. To add a new class to a project:

    1. In the Package Explorer, right-click on the package path to which you want to add the class, hover over New, and then click Other.

    2. In the dialog that opens, click on the Wowza Streaming Engine wizard you want to add, and then click Next.

    3. Enter a Name for the class and then click Finish. Camel case is the Java convention.


    Originally Published: For Wowza Streaming Engine on 10-23-2015.

    If you're having problems or want to discuss this article, post in our forum.