Documentation for ModuleBase

Hi,

As I can see from numerous examples around your forum and in your articles, when writing a module you should subclass ModuleBase and when doing so, you get all sorts of application and client events available, like onAppStart, onAppStop, onConnect etc. That’s all good, but I don’t see this documented anywhere (https://www.wowza.com/resources/serverapi/com/wowza/wms/module/ModuleBase.html). I’m interested in knowing all of the events available to me. I can see the Interfaces are documented eg. IModuleOnApp (https://www.wowza.com/resources/serverapi/com/wowza/wms/module/IModuleOnApp.html), but in this doc it states that the onAppStart and onAppStop must be implemented as static methods, but non of your examples does this. So what’s up and what’s down here? It there something I’m missing? Please fill me in, if so.

–– K

Hello there and welcome to the Wowza support forum.

The documentation for the IModuleOnApp interface is saying that a module can not directly implement the IModuleOnApp interface. Instead the interface only serves as an example of the method names and call signature needed to implement these application methods.

I hope this answers your question.

Kind regards,

Salvadore

Hi,

So most the functions which are extendable are

onAppCreate

onAppDestroy

onAppStart

onAppStop

onConnect

onDisconnect

onConnectAccept

onConnectReject

onStreamCreate

onStreamDestroy

onHTTPSessionCreate

onHTTPSessionDestroy

onHTTPStreamerRequest

onHTTPCupertinoStreamingSessionCreate

onHTTPCupertinoStreamingSessionDestroy

onHTTPCupertinoStreamerRequest

onHTTPSanJoseStreamingSessionCreate

onHTTPSanJoseStreamingSessionDestroy

onHTTPSanJoseStreamerRequest

onHTTPSmoothStreamingSessionCreate

onHTTPSmoothStreamingSessionDestroy

onHTTPSmoothStreamingStreamerRequest

onHTTPMPEGDashStreamingSessionCreate

onHTTPMPEGDashStreamingSessionDestroy

onHTTPMPEGDashStreamerRequest

onRTPSessionCreate

onRTPSessionDestroy

These then have other notifiers which can be extended

So for example onStreamCreate and Destroy

IMediaStreamActionNotify2-example

and onRTPSessionCreate and onRTPSessionDestroy

How-to-use-the-IRTSPActionNotify-interface-to-listen-for-RTSP-stream-events

There are also DRM functions which I have not included and can be found in additional tutorials.

Andrew.

Hi,

If you look at page 962 onwards of the WowzaStreamingEngine_ServerSideAPI.pdf then it does outline all the functions available within the Module Base.

Andrew.

Perhaps page 978 on that version. I was looking in the 4.1.0 version

You can also search for

com.wowza.wms.module

As it may be different on each PDF as we add more information per revision.

Andrew.

Hi Salvadore,

Thank you very much for the welcome.

Nope, it dosen’t answer my question at all. My main issue is still that I can get an overview over which events are called on a ModuleBase subclass. Can you please refer me to a page documenting this?

–– K

Hi Andrew,

Dont you have this documented somewhere, with maybe an outline of what and when the different methods are called, even though they are somewhat self-explanatory? I need to know about parameter input etc.

It’s always good with examples, but it never gives you the full picture of what is possible. What I’m basically asking is; don’t you have some extensive documentation on your Java SDK? Cause what I linked to in my initial post seems old or outdated. Maybe not done?

–– K

Hi Andrew,

Is it this one you are referring to: https://www.wowza.com/resources/WowzaStreamingEngine_ServerSideAPI.pdf? I don’t see anything about ModuleBase from page 962 an onwards.

–– K