How to monitor bandwidth of published streams (LimitPublishedStreamBandwidth)

The ModuleLimitPublishedStreamBandwidth module for Wowza Streaming Engine™ media server software enables you to automatically disconnect RTMP sources that exceed a set bandwidth limit.

Contents


Prerequisites
Installation
Configuration
Properties
Usage
For developers

Prerequisites


Wowza Streaming Engine 4.0.0 or later is required.

Installation


  1. Download wse-plugin-limitpublishedstreambandwidth.zip.
     
  2. Extract the contents from the downloaded (zipped) package, and then copy the lib/wse-plugin-limitpublishedstreambandwidth.jar file from the package to the lib folder in your Wowza Streaming Engine installation ([install-dir]/lib).
     
  3. Restart Wowza Streaming Engine.

Configuration


To enable this module, add the following module definition to your application configuration. See Configure modules for details.

Name
Description
Fully Qualified Class Name
ModuleLimitPublishedStreamBandwidth Monitors limit of published stream bandwidth. com.wowza.wms.plugin.ModuleLimitPublishedStreamBandwidth

Properties


After enabling the module, you can adjust the default settings by adding the following properties to your application. See Configure properties for details.

Path
Name
Type
Value
Notes
/Root/Application limitPublishedStreamBandwidthMaxBitrate Integer 800 Maximum bitrate, in kilobits per second (Kbps), that's allowed for any publisher. Setting to 0 disables bandwidth checking. (default: 800)
/Root/Application limitPublishedStreamBandwidthDebugLog Boolean true Enables or disables extra logging. (default: false)

Usage


The ModuleLimitPublishedStreamBandwidth module enables you to configure a maximum bitrate for an application. When an RTMP stream is published to the configured application, it's monitored continuously to ensure its bitrate stays within the set limit. If the stream bitrate exceeds the limit, the RTMP source is disconnected.

For developers


Source code is available on GitHub.

Wowza Media Systems™ provides developers with a platform to create streaming applications and solutions. See Wowza Developer Tools to learn more about our APIs and SDK.
Wowza media server software and all components, including modules, source code, and other related items offered on this page, are copyrighted (c) 2006-2016 by Wowza Media Systems, LLC, all rights reserved, and are licensed pursuant to the Wowza Media Software End User License Agreement.
Originally Published: For Wowza Streaming Engine 4.2.0 on 06-29-2015.
Updated: 05-19-2016.
 

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