com.wowza.wms.module

Class ModuleBase

java.lang.Object

com.wowza.wms.module.ModuleBase

public class ModuleBase
extends java.lang.Object

This is the golden class that you need to extend when you start implementing your custom module for Wowza Streaming Engine. The fully qualified name of this class is what goes into your Application.xml in the Class node of the Module node.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARAM1 In case of play(IClient, RequestFunction, AMFDataList) and publish(IClient, RequestFunction, AMFDataList) this parameter carries the stream name.
static int	PARAM2
static int	PARAM3
static int	PARAMMETHODNAME

Constructor Summary

Constructors

Constructor and Description
ModuleBase()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getParamString(AMFDataList paramAMFDataList, int paramInt) This is method can be used to extract data from the AMFDataList objects that you get in play/connect/publish methods.
protected static void	invokePrevious(java.lang.Object paramObject, IClient paramIClient, RequestFunction paramRequestFunction, AMFDataList paramAMFDataList) This method passes the control to the next module in the chain of configured modules, allowing each one to act on the lifecycle event.
void	onAppStart(IApplicationInstance appInstance) This method is invoked by Wowza when your application starts up.
void	onAppStop(IApplicationInstance appInstance) This method is invoked by Wowza when your application stops.
void	onDisconnect(IClient client) This method is invoked immediately when an RTMP based player (Flash client) closes, e.g. you close the browser tab with the player on it.
void	onHTTPMPEGDashStreamingSessionCreate(HTTPStreamerSessionMPEGDash client) This method is invoked every time a new MPEG-DASH sessinon is created.
void	onHTTPMPEGDashStreamingSessionDestroy(HTTPStreamerSessionMPEGDash client) This method is called when an MPEG-DASH session is destroyed after the client has disconnected
void	onHTTPSanJoseStreamingSessionCreate(HTTPStreamerSessionSanJose client) This method is invoked every time a new San Jose session is created.
void	onHTTPSanJoseStreamingSessionDestroy(HTTPStreamerSessionSanJose client) This method is invoked every time a San Jose session is destroyed.
void	onHTTPSessionDestroy(IHTTPStreamerSession httpSession) This method is invoked whenever a HTTP session is destroyed.
void	onHTTPStreamerRequest(IHTTPStreamerSession httpSession, IHTTPStreamerRequestContext reqContext) This method is invoked upon every HTTP request that comes in.
void	onRTPSessionCreate(RTPSession client) This method is invoked when a new RTP session is created.
void	onRTPSessionDestroy(RTPSession client) This method is invoked every time an RTP session is destroyed, e.g. your typical IP webcam stops the stream.
void	onStreamCreate(IMediaStream stream) This is called upon stream creation.
void	onStreamDestroy(IMediaStream stream) This is called upon stream destruction.
void	play(IClient client, RequestFunction function, AMFDataList params) This method is invoked when an RTMP client starts playing a stream.
void	publish(IClient client, RequestFunction function, AMFDataList params) This method is called whenever a new stream is published by an RTMP publiser, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAMMETHODNAME

public static final int PARAMMETHODNAME

See Also:

Constant Field Values

PARAM1

public static final int PARAM1

In case of play(IClient, RequestFunction, AMFDataList) and publish(IClient, RequestFunction, AMFDataList) this parameter carries the stream name.

See Also:

Constant Field Values

PARAM2

public static final int PARAM2

See Also:

Constant Field Values

PARAM3

public static final int PARAM3

See Also:

Constant Field Values

Constructor Detail

ModuleBase

public ModuleBase()

Method Detail

onAppStart

public void onAppStart(IApplicationInstance appInstance)

This method is invoked by Wowza when your application starts up. In practice, this happens when an encoder or a player first connects to your server referring to the name of your application. You can initialize your module here, loading necessary resources and your module's configuration.

Parameters:

appInstance - a class containing information about the particular application instance that is being started along with any configuration

onAppStop

public void onAppStop(IApplicationInstance appInstance)

This method is invoked by Wowza when your application stops. This happens when (1) the whole server is shutting down (2) your application is stopped from management interface

Parameters:

appInstance - the application instance that is being stopped

onRTPSessionCreate

public void onRTPSessionCreate(RTPSession client)

This method is invoked when a new RTP session is created. This happens when for example a new stream is published from an IP webcamera to Wowza that uses RTP protocol.

Parameters:

client - an object representing the known details about the client that is connecting

onHTTPStreamerRequest

public void onHTTPStreamerRequest(IHTTPStreamerSession httpSession,
                                  IHTTPStreamerRequestContext reqContext)

This method is invoked upon every HTTP request that comes in. This means separate invocation for the m3u8 file, and an other one one for the chunklist file. The passed reqContext has a IHTTPStreamerRequestContext.getRequestType() method that you can call and check what happened exactly.

Parameters:

httpSession - an object representing the known details about the session

reqContext - a context object representing some other details about the call

onHTTPSanJoseStreamingSessionCreate

public void onHTTPSanJoseStreamingSessionCreate(HTTPStreamerSessionSanJose client)

This method is invoked every time a new San Jose session is created.

Parameters:

client - an object represeting the session with details

onHTTPMPEGDashStreamingSessionCreate

public void onHTTPMPEGDashStreamingSessionCreate(HTTPStreamerSessionMPEGDash client)

This method is invoked every time a new MPEG-DASH sessinon is created.

Parameters:

client - an object represeting the session with details

onHTTPSessionDestroy

public void onHTTPSessionDestroy(IHTTPStreamerSession httpSession)

This method is invoked whenever a HTTP session is destroyed. This happens shortly after a HTTP based player stops playing.

Parameters:

httpSession - an object represeting the HTTP session that is being destroyed

onDisconnect

public void onDisconnect(IClient client)

This method is invoked immediately when an RTMP based player (Flash client) closes, e.g. you close the browser tab with the player on it. Caution: despite the name, it is not invoked if non-RTMP players disconnect!

Parameters:

client - the object represeting the previously connected player with all known details

onRTPSessionDestroy

public void onRTPSessionDestroy(RTPSession client)

This method is invoked every time an RTP session is destroyed, e.g. your typical IP webcam stops the stream.

Parameters:

client - the object represeting the session details that is being destroyed

onHTTPSanJoseStreamingSessionDestroy

public void onHTTPSanJoseStreamingSessionDestroy(HTTPStreamerSessionSanJose client)

This method is invoked every time a San Jose session is destroyed.

Parameters:

client - the object represeting the session details that is being destroyed

publish

public void publish(IClient client,
                    RequestFunction function,
                    AMFDataList params)

This method is called whenever a new stream is published by an RTMP publiser, e.g. Flash Media Live Encoder or GoCoder. Usually you want to know the name of the stream. This is the trick: String streamName = params.getString(PARAM1); where PARAM1 is a magic number in ModuleBase.

Parameters:

client - the object representing the connecting encoder

function - not sure..

params - a data object passed by the encoder, this can be used to find out the stream name

onStreamCreate

public void onStreamCreate(IMediaStream stream)

This is called upon stream creation. Be careful stream.getName() will return null! It is the point where you can add your @link com.wowza.wms.stream.IMediaStreamActionNotify instance on the stream by calling IMediaStream.addClientListener(com.wowza.wms.stream.IMediaStreamActionNotify)

Parameters:

stream - the stream object

onStreamDestroy

public void onStreamDestroy(IMediaStream stream)

This is called upon stream destruction. It is the point where you should detach your IMediaStreamActionNotify instance, however it is not clear why it is necessary. If the stream object is not reused, the listener should be garbage collected anyways..

Parameters:

stream - the stream object

onHTTPMPEGDashStreamingSessionDestroy

public void onHTTPMPEGDashStreamingSessionDestroy(HTTPStreamerSessionMPEGDash client)

This method is called when an MPEG-DASH session is destroyed after the client has disconnected

Parameters:

client - the session object

play

public void play(IClient client,
                 RequestFunction function,
                 AMFDataList params)

This method is invoked when an RTMP client starts playing a stream. If you need to know the stream name, this is the trick: String streamName = getParamString(params, PARAM1); Caution: despite the name, it is not invoked if non-RTMP players start playing! If you implement this method, make sure that if you want to allow playback, finally you need to call invokePrevious(Object, IClient, RequestFunction, AMFDataList).

Parameters:

client - the object representing the player

function - not sure..

params - a data object passed by the encoder, this can be used to find out the stream name

getParamString

protected static java.lang.String getParamString(AMFDataList paramAMFDataList,
                                                 int paramInt)

This is method can be used to extract data from the AMFDataList objects that you get in play/connect/publish methods. There are some constants defined in ModuleBase that are useful: PARAM1, PARAM2, PARAM3, which map to some other integers. In play(IClient, RequestFunction, AMFDataList) and publish(IClient, RequestFunction, AMFDataList), you can extract the stream name as string with PARAM1

Parameters:

paramAMFDataList - the object from which you want to extract the data

paramInt - the identifier of the parameter that you need.

Returns:

the String value of the extracted parameter

invokePrevious

protected static void invokePrevious(java.lang.Object paramObject,
                                     IClient paramIClient,
                                     RequestFunction paramRequestFunction,
                                     AMFDataList paramAMFDataList)

This method passes the control to the next module in the chain of configured modules, allowing each one to act on the lifecycle event.

Parameters:

paramObject - from the examples, it looks like you just need to pass your own module instance, so pass literally this

paramIClient - pass on the IClient instance that you have received in your lifecycle method

paramRequestFunction - pass on the RequestFunction instance that you have received in your lifecycle method

paramAMFDataList - pass on the AMFDataList instance that you have received in your lifecycle method