How to disconnect connected clients after a specified time period (TimedDisconnect)

The ModuleTimedDisconnect module for Wowza Streaming Engine™ media server software can be used to disconnect players from an application after a specified time has expired.

Contents


Prerequisites
Installation
Configuration
Properties
Usage
For developers

Prerequisites


Wowza Streaming Engine™ 4.0.0 (or later) or Wowza Media Server™ 3.6.3 (or later) is required.

Installation


  1. Download wse-plugin-timeddisconnect.zip.
     
  2. Extract the contents from the downloaded (zipped) package, and then copy the lib/wse-plugin-timeddisconnect.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
ModuleTimedDisconnect Disconnects players at a specified time interval. com.wowza.wms.plugin.ModuleTimedDisconnect

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 timedDisconnectTime Integer 60 The time, in seconds, that players are allowed to be connected. Players that connect for this duration are then disconnected and must reconnect. (default: 60)
/Root/Application timedDisconnectAllowedAgents String FM,Wirecast A comma-separated list of User Agent prefixes that's checked when the connection is made. If a player's User Agent (Flash Version) starts with one of the values in this list, it won't be controlled by the disconnect timer. This condition allows your encoders to remain connected. (default: not set)
/Root/Application timedDisconnectDebugLog Boolean true Enables or disables extra logging. (default: false)

Usage


Use the timedDisconnectTime property value to specify how much time elapses before connected clients are disconnected from Wowza Streaming Engine applications.

For developers


Source code is available on GitHub.
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: 02-26-2014.
Updated: For Wowza Streaming Engine on 06-13-2016.
 

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