DriversRecommendedOutdated drivers can make a good PC feel brokenScan driver issues before chasing fixes manually.Scan NowOctober DealsAmazon USOctober deal check: compare before you payAmazon US: current deals, useful picks and tech finds.Check DealsClean PCRecommendedOne scan can reveal what keeps slowing WindowsLook for cleanup and repair opportunities.Run Scan×
Skip to content
VGSources
custom plugins

How to Build Custom Plugins for Wowza Streaming Engine

Wowza extensions are custom Java modules registered on an application. Follow a version-aware workflow to build, deploy, configure, and test one safely.

By VGSources Team 7 min read
Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Wowza Streaming Engine extensions are usually called custom Java modules: Java classes that you build, make available to Engine, and register in the configuration for the application that should use them. The reliable sequence is to check the target Engine version and Java runtime, build with a matching development workflow, deploy the extension, add its fully qualified class name to the intended application, configure any properties it reads, then test the result before production use or an Engine upgrade.

What a Wowza “plugin” is

Wowza Streaming Engine (WSE) is a Java-based media server with a Java API for extensions. In Wowza’s terminology, these extensions are custom modules. A module is associated with an application through that application’s configuration; it is not enabled globally merely because its JAR is present on the server. See Wowza’s Engine overview for the application, virtual-host, and configuration model.

This guide describes the supported workflow at the level established by Wowza’s published materials. For exact class scaffolding, callback signatures, build commands, dependency packaging, and deployment destination, use the Java module documentation and the current build project instructions that match your Engine release; those details should not be guessed from a generic Java example.

1. Check the target Engine and Java versions

Before writing or compiling code, record the precise WSE version, operating system, Java runtime configured for that installation, and any third-party Java dependencies your module needs. Java compatibility varies by Engine release, so a newer JDK is not automatically a safe compilation target simply because the server can run on a newer JRE.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
#1 Best Overall
Elebase USB to USB C Adapter for iPhone 18 Pro Max,USBC Car Charger Adapter
  • Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
  • Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
  • Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
  • Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
  • 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.

Wowza’s Java support guidance, dated October 2, 2024, describes a transition beginning with WSE 4.8.28 and gives version-specific support rather than one timeless Java requirement. Wowza’s 4.9.0 release announcement says that release was compiled using Java 17, that new installations included a Java 21 JRE, and that Java 17 or 21 was supported. It also cautions that a module using Java 21 language features may not work: the Engine had been tested on a Java 21 JRE but not recompiled with JDK 21. Check the guidance for the exact Engine release you will run, rather than carrying those release notes forward as a universal rule: Wowza’s Java support page and the WSE 4.9.0 release announcement.

2. Choose a development and build workflow

Gradle with Docker Compose

Wowza documents a Gradle-based extension workflow using Docker Compose to run WSE in a local container. The guide describes the project as supporting extension building, packaging, and deployment. Start with Wowza’s Gradle and Docker Compose guide and the linked wse-plugin-builder README. Follow the instructions for the Engine version you intend to support; use them to establish the project layout, commands, Engine image/version, runtime dependencies, and produced artifact location.

Wowza IDE

Wowza’s Developer Portal also indexes an IDE route alongside its Java module documentation. The available guidance here does not establish that the IDE is required, preferred, or maintained for every Engine release. Choose it only after confirming its instructions and compatibility for your target version. Whichever route you use, make the target Engine version and build inputs explicit so that another developer can reproduce the artifact.

Rank #2
Anker USB-C Hub, 5-in-1 USB Hub for Laptops, 4K HDMI Multiport Adapter
  • 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
  • 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
  • Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
  • 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
  • What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.

3. Implement the module using the WSE Java API

Implement a Java class for the behavior you need, following Wowza’s “Use Java modules” documentation and Java API reference for the target release. The class is identified in application configuration by its fully qualified name. Confirm the required superclass or interfaces, lifecycle callbacks, and method signatures from those version-matched references; do not assume a class template from another release applies.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Keep the implementation’s configuration contract clear: identify each property it expects, its type, and the application scope in which it reads that value. A property appearing in an application configuration does not by itself make the module use it; the module must read the property through the appropriate API.

4. Build, package, and make the extension available to Engine

  1. Build for the target. Use the Gradle/Docker Compose project or another version-appropriate Wowza workflow, following its current README and guide for exact commands and Engine image.
  2. Inspect the artifact. Confirm the build succeeded and identify the JAR and any required dependencies using the project’s own output and deployment instructions.
  3. Deploy as documented. Make the artifact and any dependencies visible to the Engine process according to the chosen workflow. Do not treat an older support-forum suggestion to copy a JAR into an installation lib directory as a universal current deployment rule; verify the destination for your Engine version and installation method.

Wowza’s official extension guide establishes the high-level build, package, and deploy path, but the correct JAR destination and dependency-bundling behavior depend on the current workflow. Follow the linked guide and repository instructions rather than assuming that packaging every dependency into one JAR, or copying it to one fixed directory, is always correct.

Rank #3
Sale
Anker USB C Hub, 7in1 Multi-Port USB Adapter, 4K@60Hz USBC to HDMI Splitter
  • Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
  • Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
  • Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
  • Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
  • What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.

5. Register the module on the intended application

After deployment, add the module to the configuration for the specific server, virtual host, and application that should load it. Wowza’s Create a live app REST guide demonstrates updating an application’s advanced configuration with a modules array. Its example entry includes a class name, description, name, and order; the sample class com.my.custom.path.MyCustomModule is illustrative, not a built-in module.

REST configuration

The documented route is PUT /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/adv. In the request, include the custom module’s fully qualified class name and its descriptive fields in the application’s module list, preserving the other advanced settings the application needs. A successful update saves the application configuration; Wowza’s example says the resulting Application.xml contains a <Module> entry.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

WSE Manager or XML

Wowza also documents managing settings through WSE Manager or XML. Applications have their own Application.xml under the relevant virtual host’s application folders. Confirm the server, virtual host, and application before changing configuration so the module is enabled in the intended scope, not another application with a similar name.

Rank #4
Sale
UGREEN USB to USB C Adapter Combo 4-Pack, 10Gbps USB C Converter Space Gray
  • Dual Converters, Infinite Potential:Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
  • Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
  • Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
  • Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
  • Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft

6. Add application properties when the module needs settings

Properties belong in the configuration scope the module expects. Wowza’s overview describes adding properties through WSE Manager by specifying a path, name, type, and value, or placing a <Property> entry under the appropriate XML <Properties> element. The documented examples include Boolean, Integer, and String types. The REST live-app example updates advancedSettings alongside the module list and includes an application-level property.

Match property names, types, and paths to the module’s implementation. A property with a plausible name will not affect behavior unless the module reads it at that scope and handles its value.

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

7. Load and test the change

After deployment and configuration, perform the application or server lifecycle action required by your chosen workflow. Wowza’s REST documentation includes an application restart action, but it does not establish that every module change universally requires a full server restart. Follow the deployment instructions for the target release and use the narrowest documented reload or restart appropriate to the change.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Best Value
Anker USB C Hub, 5-in-1 USBC to HDMI Splitter with 4K Display
  • 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
  • Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
  • Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
  • HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
  • What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.

Validate the module in a non-production environment before relying on it. Wowza specifically advises testing custom modules before upgrading Engine. A practical validation pass is:

  • Confirm the intended application configuration contains the module entry and the class name is correct.
  • Verify the Engine process can see the module artifact and its required dependencies.
  • Inspect Engine logs for class-loading, configuration, or startup errors.
  • Exercise the feature and the streaming workflow the module is meant to affect.
  • Repeat the checks against the exact Engine and Java versions planned for an upgrade.

Choosing between configuration routes

Route Useful when Watch for
WSE Manager You need to manage a setting through the product interface. Verify the selected server, virtual host, and application before saving.
REST API You need repeatable or automated application updates; Wowza documents module registration through the advanced application endpoint. Target the correct route and preserve the rest of the application’s advanced configuration.
XML You manage the application configuration directly in its files. Edit the correct application’s Application.xml and place properties at the scope the module reads.

For development, Wowza documents both an IDE route and a Gradle/Docker Compose route, but the available materials do not establish a universal winner. Prefer the route whose current, version-matched instructions make the Engine version, build, artifact, and deployment steps reproducible for your team.

Common problems and what to check

The application cannot load the module class

  • Check that the configured class name is fully qualified and matches the compiled class.
  • Confirm the deployed artifact is visible to the Engine process in the location specified by your chosen workflow.
  • Check logs for missing classes or dependencies, and verify that the module was registered on the intended application.

The module loads but its setting has no effect

  • Compare the configured property’s name, type, and path with what the module reads.
  • Confirm that the property is set at application scope if that is the scope the implementation expects.
  • Verify the code actually reads and handles the property; configuration alone does not create behavior.

The module fails on a different Engine or Java release

  • Recheck the target release’s Java support rather than assuming a newer runtime guarantees compatibility.
  • Review whether the module uses language or runtime features unavailable to the Engine version that executes it.
  • Rebuild and test against the exact target environment before production use or upgrade.

You are unsure whether to restart the app or server

Use the lifecycle instructions for the deployment path and release in question. Wowza documents application restart operations, but the correct reload scope is not universal in the published materials cited here; do not assume a full server restart is always required.

Keep a YouTube stream running without maintaining a custom server extension

If your goal is simply to keep uploaded videos looping as a YouTube live stream, that is a different problem from extending Wowza. StreamNeo is a cloud service for YouTube playback of uploaded videos: upload a recording or create a playlist, add your YouTube stream key, and go live. Nothing has to remain on at home; it streams the uploaded quality up to 4K 60fps at one flat price per slot, can recover automatically if YouTube drops the stream, and starts with a free first day without a card. Monthly pricing is $9.99 per month. See StreamNeo or start the free day.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.

Leave a Reply

Your email address will not be published. Required fields are marked *

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

More from Patch Notes

Recommended PC Tool
Recommended PC Tool
Crashes, No Sound, or Screen Glitches?Free driver scan
PC Slower Than It Used to Be?Free scan - under a minute

Two free Windows tools

One Free Minute Could Fix That PC

Before you go - each of these free tools takes about a minute and tackles what quietly slows a Windows PC down.

Special offer. View Outbyte info, uninstall instructions, EULA, and Privacy Policy.