com.wowza.wms.module
Class ModuleCore

Object
  com.wowza.wms.module.ModuleBase
      com.wowza.wms.module.ModuleCore

public class ModuleCore
extends ModuleBase

ModuleCore includes all the basic commands support by the NetStream and NetConnection client side objects. Any of these methods can be overwritten in a custom module. Below is an example of custom module that overrides the play method to modify the name of the file to be played:

package com.wowza.wms.plugin.overrideexample;

import com.wowza.wms.amf.*;
import com.wowza.wms.client.*;
import com.wowza.wms.module.*;
import com.wowza.wms.request.*;

public class ModuleOverrideExample extends ModuleBase
{
        public void play(IClient client, RequestFunction function, AMFDataList params)
        {
                if (params.get(PARAM1).getType() == AMFData.DATA_TYPE_STRING)
                {
                        String playName = params.getString(PARAM1);
                        params.set(PARAM1, new AMFDataItem(playName+"_newname"));
                }
                this.invokePrevious(client, function, params);
        }
}

Field Summary

Fields inherited from class com.wowza.wms.module.ModuleBase

CALLBACK_PARAM1, CALLBACK_PARAM10, CALLBACK_PARAM2, CALLBACK_PARAM3, CALLBACK_PARAM4, CALLBACK_PARAM5, CALLBACK_PARAM6, CALLBACK_PARAM7, CALLBACK_PARAM8, CALLBACK_PARAM9, PARAM1, PARAM10, PARAM2, PARAM3, PARAM4, PARAM5, PARAM6, PARAM7, PARAM8, PARAM9, PARAMMETHODNAME, PLAYTRANSITION_APPEND, PLAYTRANSITION_APPEND_IMMEDIATE, PLAYTRANSITION_RESET, PLAYTRANSITION_RESET_IMMEDIATE, PLAYTRANSITION_STOP, PLAYTRANSITION_SWAP, PLAYTRANSITION_SWITCH, PLAYTRANSITION_UNKNOWN, PLAYTRANSITIONSTR_APPEND, PLAYTRANSITIONSTR_RESET, PLAYTRANSITIONSTR_STOP, PLAYTRANSITIONSTR_SWAP, PLAYTRANSITIONSTR_SWITCH, PLAYTRANSITIONSTR_UNKNOWN

Constructor Summary

ModuleCore()

Method Summary

static void	closeStream(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.close();
static void	createStream(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Create new server side NetStream object (internal to Flash workings).
static void	deleteStream(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Delete server side stream object (internal to Flash workings).
static void	FCPublish(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) FCPublish method called by FME 2.5
static void	FCSubscribe(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) FCSubscribe subscribes to a live stream (if origin edge will start the stream from the origin to the edge)
static void	FCUnpublish(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params)
static void	FCUnPublish(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) FCUnpublish method called by FME 2.5
static void	FCUnsubscribe(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) FCUnSubscribe to a live stream
static void	FCUnSubscribe(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params)
static void	getClientID(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get the clientId for a client connection NetConnection.call("getClientID", resultObj);
static void	getLastStreamId(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get the id for the last created stream NetConnection.call("getLastStreamId", resultObj);
static void	getLiveStreamPacketizer(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get the live stream packetizer list for a client connection NetConnection.call("getLiveStreamPacketizer", resultObj);
static void	getPageUrl(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) getPageUrl returns the pageUrl from the onConnect metadata
static void	getReferrer(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) getReferrer returns the referrer from the onConnect metadata
static void	getRepeaterOriginUrl(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get the Repeater Origin URL for this client
void	getStreamBitrate(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get stream bitrate in bits-per-second for a video on demand stream (will not work for live).
static void	getStreamLength(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get stream length in seconds NetConnection.call("getStreamLength", resultObj, streamName); If you pass in an array of streamNames it will return an array of durations.
static void	getStreamType(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get the default stream type for a client connection NetConnection.call("getStreamType", resultObj);
static void	getVersion(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Get the Wowza Pro server version and build number NetConnection.call("getVersion", resultObj);
static void	initLiveStreamRepeating(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Initialize a stream for live stream repeating
static void	initStream(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Create new server side NetStream object (internal to Flash workings).
static void	pause(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.pause([ flag : Boolean]);
static void	pauseRaw(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) pauseRaw method introduced in Flash player 10
static void	play(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.play(name : Object [,start : Number[, len : Number[, reset : Object]]]);
static void	play2(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.play(playOptions : NetStreamPlayOptions);
static void	publish(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.publish(name : String [, howToPublish : String]);
static void	receiveAudio(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.receiveAudio(receive : Boolean);
static void	receiveVideo(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.receiveVideo(receive : Boolean | FPS : Number); FPS does not work the same as FMS.
static void	releaseStream(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params)
static void	seek(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.seek(offset : Number);
static void	setBandwidthLimit(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params)
static void	setBufferTime(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Server side implementation of NetStream.setBufferTime(bufferTime : Number);
static void	setLiveStreamPacketizer(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Set the live stream packetizer for a stream
static void	setRepeaterOriginUrl(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Set the Repeater Origin URL for this client
static void	setStreamType(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params) Set the default stream type for a client connection NetConnection.call("setStreamType", null, streamType);

Methods inherited from class com.wowza.wms.module.ModuleBase

getAppInstance, getApplication, getCallbackParamCount, getLogger, getParam, getParamBoolean, getParamBoolean, getParamCount, getParamDate, getParamDouble, getParamDouble, getParamInt, getParamInt, getParamLong, getParamLong, getParamMixedArray, getParamObj, getParamString, getParamString, getParamType, getStream, getVHost, invokePrevious, invokePrevious, isSendResult, sendClientOnStatusError, sendResult, sendResult, sendResult, sendResult, sendResult, sendStreamOnStatusError

Methods inherited from class Object

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

Constructor Detail

ModuleCore

public ModuleCore()

Method Detail

closeStream

public static void closeStream(IClient client,
                               com.wowza.wms.request.RequestFunction function,
                               AMFDataList params)

Server side implementation of NetStream.close();

Parameters:

client - client

function - function

params - params (no params)

createStream

public static void createStream(IClient client,
                                com.wowza.wms.request.RequestFunction function,
                                AMFDataList params)

Create new server side NetStream object (internal to Flash workings).

Parameters:

client - client

function - function

params - parameters (no params)

deleteStream

public static void deleteStream(IClient client,
                                com.wowza.wms.request.RequestFunction function,
                                AMFDataList params)

Delete server side stream object (internal to Flash workings).

Parameters:

client - client

function - function

params - params

FCPublish

public static void FCPublish(IClient client,
                             com.wowza.wms.request.RequestFunction function,
                             AMFDataList params)

FCPublish method called by FME 2.5

Parameters:

client - client

function - function

params - params

FCSubscribe

public static void FCSubscribe(IClient client,
                               com.wowza.wms.request.RequestFunction function,
                               AMFDataList params)

FCSubscribe subscribes to a live stream (if origin edge will start the stream from the origin to the edge)

Parameters:

client - client

function - function

params - params (streamName:String, [mediaCasterType:String])

FCUnpublish

public static void FCUnpublish(IClient client,
                               com.wowza.wms.request.RequestFunction function,
                               AMFDataList params)

FCUnPublish

public static void FCUnPublish(IClient client,
                               com.wowza.wms.request.RequestFunction function,
                               AMFDataList params)

FCUnpublish method called by FME 2.5

Parameters:

client - client

function - function

params - params

FCUnsubscribe

public static void FCUnsubscribe(IClient client,
                                 com.wowza.wms.request.RequestFunction function,
                                 AMFDataList params)

FCUnSubscribe to a live stream

Parameters:

client - client

function - function

params - params (streamName:String)

FCUnSubscribe

public static void FCUnSubscribe(IClient client,
                                 com.wowza.wms.request.RequestFunction function,
                                 AMFDataList params)

getClientID

public static void getClientID(IClient client,
                               com.wowza.wms.request.RequestFunction function,
                               AMFDataList params)

Get the clientId for a client connection NetConnection.call("getClientID", resultObj);

Parameters:

client - client

function - function

params - params (no params)

getLastStreamId

public static void getLastStreamId(IClient client,
                                   com.wowza.wms.request.RequestFunction function,
                                   AMFDataList params)

Get the id for the last created stream NetConnection.call("getLastStreamId", resultObj);

Parameters:

client - client

function - client

params - params (no params)

getLiveStreamPacketizer

public static void getLiveStreamPacketizer(IClient client,
                                           com.wowza.wms.request.RequestFunction function,
                                           AMFDataList params)

Get the live stream packetizer list for a client connection NetConnection.call("getLiveStreamPacketizer", resultObj);

Parameters:

client - client

function - function

params - params (no params)

getPageUrl

public static void getPageUrl(IClient client,
                              com.wowza.wms.request.RequestFunction function,
                              AMFDataList params)

getPageUrl returns the pageUrl from the onConnect metadata

Parameters:

client - client

function - function

params - params

getReferrer

public static void getReferrer(IClient client,
                               com.wowza.wms.request.RequestFunction function,
                               AMFDataList params)

getReferrer returns the referrer from the onConnect metadata

Parameters:

client - client

function - function

params - params

getRepeaterOriginUrl

public static void getRepeaterOriginUrl(IClient client,
                                        com.wowza.wms.request.RequestFunction function,
                                        AMFDataList params)

Get the Repeater Origin URL for this client

Parameters:

client - client

function - function

params - params

getStreamBitrate

public void getStreamBitrate(IClient client,
                             com.wowza.wms.request.RequestFunction function,
                             AMFDataList params)

Get stream bitrate in bits-per-second for a video on demand stream (will not work for live). To call, NetConnection.call("getStreamBitrate", resultObj, streamName);

Parameters:

client - client

function - function

params - params (streamName:String)

getStreamLength

public static void getStreamLength(IClient client,
                                   com.wowza.wms.request.RequestFunction function,
                                   AMFDataList params)

Get stream length in seconds NetConnection.call("getStreamLength", resultObj, streamName); If you pass in an array of streamNames it will return an array of durations.

Parameters:

client - client

function - function

params - params (streamName:String or streamNames:Array)

getStreamType

public static void getStreamType(IClient client,
                                 com.wowza.wms.request.RequestFunction function,
                                 AMFDataList params)

Get the default stream type for a client connection NetConnection.call("getStreamType", resultObj);

Parameters:

client - client

function - function

params - params (no params)

getVersion

public static void getVersion(IClient client,
                              com.wowza.wms.request.RequestFunction function,
                              AMFDataList params)

Get the Wowza Pro server version and build number NetConnection.call("getVersion", resultObj);

Parameters:

client - client

function - function

params - params (no params)

initLiveStreamRepeating

public static void initLiveStreamRepeating(IClient client,
                                           com.wowza.wms.request.RequestFunction function,
                                           AMFDataList params)

Initialize a stream for live stream repeating

Parameters:

client - client

function - function

params - params (liveStreamPacketizer, liveStreamRepeater)

initStream

public static void initStream(IClient client,
                              com.wowza.wms.request.RequestFunction function,
                              AMFDataList params)

Create new server side NetStream object (internal to Flash workings).

Parameters:

client - client

function - function

params - parameters (streamIndex, boolean)

pause

public static void pause(IClient client,
                         com.wowza.wms.request.RequestFunction function,
                         AMFDataList params)

Server side implementation of NetStream.pause([ flag : Boolean]);

Parameters:

client - client

function - function

params - params (flag)

pauseRaw

public static void pauseRaw(IClient client,
                            com.wowza.wms.request.RequestFunction function,
                            AMFDataList params)

pauseRaw method introduced in Flash player 10

Parameters:

client - client

function - function

params - params

play

public static void play(IClient client,
                        com.wowza.wms.request.RequestFunction function,
                        AMFDataList params)

Server side implementation of NetStream.play(name : Object [,start : Number[, len : Number[, reset : Object]]]);

Parameters:

client - client

function - function

params - params (name, start, len, reset)

play2

public static void play2(IClient client,
                         com.wowza.wms.request.RequestFunction function,
                         AMFDataList params)

Server side implementation of NetStream.play(playOptions : NetStreamPlayOptions);

Parameters:

client -

function -

params -

publish

public static void publish(IClient client,
                           com.wowza.wms.request.RequestFunction function,
                           AMFDataList params)

Server side implementation of NetStream.publish(name : String [, howToPublish : String]);

Parameters:

client - client

function - function

params - params (name [if name = "false" or "null" stop publishing], howToPublish ["record", "live", "append"])

receiveAudio

public static void receiveAudio(IClient client,
                                com.wowza.wms.request.RequestFunction function,
                                AMFDataList params)

Server side implementation of NetStream.receiveAudio(receive : Boolean);

Parameters:

client - client

function - function

params - params (receive)

receiveVideo

public static void receiveVideo(IClient client,
                                com.wowza.wms.request.RequestFunction function,
                                AMFDataList params)

Server side implementation of NetStream.receiveVideo(receive : Boolean | FPS : Number); FPS does not work the same as FMS. Wowza Pro accepts the following values:

• true: Send all video frames
• false: Send no video
• -1: Send all video frames
• -2: Send half the frames (remove B frames) (Note: only works with Sorenson Spark video with B-frames)
• -3: Send only key frames

Parameters:

client - client

function - function

params - params (receive | FPS)

releaseStream

public static void releaseStream(IClient client,
                                 com.wowza.wms.request.RequestFunction function,
                                 AMFDataList params)

seek

public static void seek(IClient client,
                        com.wowza.wms.request.RequestFunction function,
                        AMFDataList params)

Server side implementation of NetStream.seek(offset : Number);

Parameters:

client - client

function - function

params - params (offset)

setBandwidthLimit

public static void setBandwidthLimit(IClient client,
                                     com.wowza.wms.request.RequestFunction function,
                                     AMFDataList params)

setBufferTime

public static void setBufferTime(IClient client,
                                 com.wowza.wms.request.RequestFunction function,
                                 AMFDataList params)

Server side implementation of NetStream.setBufferTime(bufferTime : Number);

Parameters:

client - client

function - function

params - params (bufferTime)

setLiveStreamPacketizer

public static void setLiveStreamPacketizer(IClient client,
                                           com.wowza.wms.request.RequestFunction function,
                                           AMFDataList params)

Set the live stream packetizer for a stream

Parameters:

client - client

function - function

params - params (liveStreamPacketizer)

setRepeaterOriginUrl

public static void setRepeaterOriginUrl(IClient client,
                                        com.wowza.wms.request.RequestFunction function,
                                        AMFDataList params)

Set the Repeater Origin URL for this client

Parameters:

client - client

function - function

params - params (repeaterOriginUrl)

setStreamType

public static void setStreamType(IClient client,
                                 com.wowza.wms.request.RequestFunction function,
                                 AMFDataList params)

Set the default stream type for a client connection NetConnection.call("setStreamType", null, streamType);

Parameters:

client - client

function - function

params - params (streamType)