Extend Wowza Streaming Engine using the Wowza IDE

The Wowza™ IDE is an add-on to the Eclipse integrated development environment that allows you to build Java projects and classes to extend and enhance the functionality of Wowza Streaming Engine™ media server software. The Wowza IDE is available for Windows, Linux, and macOS. It's packaged as a software repository that can be added on to Eclipse 4.3 (Kepler) or later.

Note: For best results, build modules against the Java version that your Wowza Streaming Engine instance uses.

Install Eclipse for Java Developers


First, download and install the Eclipse IDE.

  1. Download the latest Eclipse installer.
     
    Note: Install the latest version of Eclipse for your operating system. Eclipse 4.3 (Kepler) or later is required, however, the Wowza IDE doesn't work with Eclipse IDE 4.4 (Luna) on Ubuntu 16.x.
  2. Start the installer.
  3. Choose Eclipse IDE for Java Developers as the package to install, accept the default Installation Folder, and click Install.
  4. When prompted, accept the licenses and trust the certificates.
  5. Launch Eclipse when the install completes.

Install the Wowza IDE


Now, get the Wowza IDE for use in Eclipse.

  1. In Eclipse, click the Help menu and choose Install New Software.
  2. In the Install window, in the Work with field, enter https://www.wowza.com/wowzaide4/
Note: If you enter the Wowza IDE 4 URL in a web browser, you'll get a 403 error.
  1. Click Add.
  2. In the Add Repository window, for Name enter Wowza. Then, click Add.
  3. Select the box next to Wowza IDE 4 and click Next.
     
  4. Review the details, accept the licenses, and click Finish.

Confirm that the Wowza IDE installed correctly.

  1. Restart Eclipse.
  2. Choose File > New > Other.

You should see the following Wowza Streaming Engine wizards:

  • Wowza Streaming Engine HTTPProvider Class
  • Wowza Streaming Engine Module Class
  • Wowza Streaming Engine Project
  • Wowza Streaming Engine ServerListener Class

Create a Wowza Streaming Engine project


Now you can create a Wowza Streaming Engine project in Eclipse. A project is a complete Wowza Streaming Engine extension that produces a .jar file with the same name as the project. Here's how to create a Wowza Streaming Engine project in Eclipse.

  1. In Eclipse, choose File > New > Other.
  2. Select Wowza Streaming Engine Project and then click Next.
  3. In the New Wowza Streaming Engine Java Project window, enter the following information:
  • Project name – A name for the project and the .jar file output. The name can't contain spaces.
     
  • Location – The path to your Wowza Streaming Engine installation.
  1. Click Next.
  2. On the New Wowza Streaming Engine Module Class page, enter the following information:
  • Package – The Java package path for your project. The Java convention is a reverse domain, for example, com.mycompany.wowza. The path can't begin or end in a period.
  • Name – A name for the module class. The Java convention uses camel case, for example, MyWowzaModule.
  1. 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. On startup, Wowza Streaming Engine loads each of the .jar files in the [install-dir]/lib folder and makes them available for use.

Add a project module to a Wowza Streaming Engine application


Add the module to a Wowza Streaming Engine application 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.
  4. Enter a name, description, and class name based on the Wowza Streaming Engine project in Eclipse:
  • Name – The name of the project's module class, for example, MyWowzaModule.
     
  • Description – Also the name of the project's module class, for example, MyWowzaModule.
     
  • Fully Qualified Class Name – The project's package path followed by a period and the name of the project's module class, for example, com.mycompany.wowza.MyWowzaModule.
  1. Click Add.

Add a class to the project


You can use the other Wowza IDE wizards to add additional classes to your Eclipse project.

  1. In the Package Explorer panel that appears by default on the left side of the Java perspective of Eclipse, right-click the package path to which you want to add the class, hover over New, and then click Other.
     
  2. In the wizard that opens, select the Wowza Streaming Engine class you want to add to the project. For example, select the module class or server listener class, and then click Next.
     
  3. Using camel case, enter a Name for the class and then click Finish.