Wowza Streaming Engine™ server listener and application module for creating a schedule of streams and playlists.
Switch branches/tags
Nothing to show
Clone or download

README.md

StreamPublisher

The StreamPublisher module for Wowza Streaming Engine™ media server software lets you use a server listener and application module to create a schedule of streams and playlists. Using television as an analogy, a stream is a channel and a playlist is a program with one or more video segments. A schedule can have as many streams (channels) as you want, with as many playlists (programs) as you want, and each playlist can be scheduled to play on a stream at a certain time. If a playlist is scheduled to start on a stream while another playlist is running, the existing playlist is replaced with the new one. If you set a schedule to begin in the past, the playlist plays immediately.

Prerequisites

Wowza Streaming Engine 4.0.0 or later is required.

Usage

You can create a schedule with server listener and application module methods, either together or separately, depending on your needs.

You can use the ServerListenerStreamPublisher server listener to load a set of scheduled streams on a single application when the media server starts. This procedure keeps the streams running until the server is shut down. If you use this process, the schedule can't be reloaded by using just the server listener.

You can use the ModuleStreamPublisher application module on any application to load a set of scheduled streams on that application when the application starts and unload the streams when the application is shut down. The schedule can be reloaded by modifying the SMIL file for the application and then reloading it. The module can provide the reload functionality to the schedule that's configured in the server listener. It can also be used on its own, in separate applications, to provide separate schedules for each application. Each application that runs a schedule must have a live stream type.

You can use the HttpProviderStreamPublisherControl HttpProvider to load and unload the schedules. To enable the HttpProvider, add the following to your Admin HostPort HttpProvider list.

<HTTPProvider>
	<BaseClass>com.wowza.wms.plugin.streampublisher.HttpProviderStreamPublisherControl</BaseClass>
	<RequestFilters>schedules*</RequestFilters>
	<AuthenticationMethod>admin-digest</AuthenticationMethod>
</HTTPProvider>

A request to the HttpProvider with no parameters will reload the schedule on the default application defined by the streamPublisherApplication server property. The following query parameters can be used. appName - The name of the application to load schedule on. appInstName - The name of the appInstance to load the schedule on. action - loadSchedule, reloadSchedule or unloadSchedule.

If the action is reloadSchedule or loadSchedule, and the appInstance is already running with a schedule then this will be reloaded otherwise the appInstance will be started with a new schedule, only if the action is loadSchedule. If the action is unloadSchedule, then the schedule will be unloaded and loadSchedule will be required to load it again later.

Load a schedule

curl http://localhost:8086/schedules?appName=live&action=loadSchedule

Reload a running schedule

curl http://localhost:8086/schedules?appName=live&action=reloadSchedule

Unload a running schedule

curl http://localhost:8086/schedules?appName=live&action=unloadSchedule

To use the included ModuleLoopUntilLive application module to loop pre-roll video around a live stream, at least one server-side stream must be configured on the Streaming Engine live application.

More resources

Wowza Streaming Engine Server-Side API Reference

How to extend Wowza Streaming Engine using the Wowza IDE

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.

To use the compiled version of this module, see How to schedule streaming with Wowza Streaming Engine (StreamPublisher).

For instructions on using the ModuleLoopUntilLive application module, see How to loop a pre-roll until a live stream starts (LoopUntilLive).

Contact

Wowza Media Systems, LLC

License

This code is distributed under the Wowza Public License.

alt tag