ModuleClientLogging, ModuleCore, ModuleMediaCasterpublic abstract class ModuleBase
extends Object
ModuleBase: Base class that all server side modules should extend. Provides basic utility functionality for handling function parameters and return data. Also provides a simplified API for logging.
| Modifier and Type | Field | Description |
|---|---|---|
static int |
CALLBACK_PARAM1 |
Callback param: param1
|
static int |
CALLBACK_PARAM10 |
Callback param: param10
|
static int |
CALLBACK_PARAM2 |
Callback param: param2
|
static int |
CALLBACK_PARAM3 |
Callback param: param3
|
static int |
CALLBACK_PARAM4 |
Callback param: param4
|
static int |
CALLBACK_PARAM5 |
Callback param: param5
|
static int |
CALLBACK_PARAM6 |
Callback param: param6
|
static int |
CALLBACK_PARAM7 |
Callback param: param7
|
static int |
CALLBACK_PARAM8 |
Callback param: param8
|
static int |
CALLBACK_PARAM9 |
Callback param: param9
|
static int |
PARAM1 |
Method param: param1
|
static int |
PARAM10 |
Method param: param10
|
static int |
PARAM2 |
Method param: param2
|
static int |
PARAM3 |
Method param: param3
|
static int |
PARAM4 |
Method param: param4
|
static int |
PARAM5 |
Method param: param5
|
static int |
PARAM6 |
Method param: param6
|
static int |
PARAM7 |
Method param: param7
|
static int |
PARAM8 |
Method param: param8
|
static int |
PARAM9 |
Method param: param9
|
static int |
PARAMMETHODNAME |
Method: method name
|
static int |
PLAYTRANSITION_APPEND |
|
static int |
PLAYTRANSITION_APPEND_IMMEDIATE |
|
static int |
PLAYTRANSITION_RESET |
|
static int |
PLAYTRANSITION_RESET_IMMEDIATE |
|
static int |
PLAYTRANSITION_STOP |
|
static int |
PLAYTRANSITION_SWAP |
|
static int |
PLAYTRANSITION_SWITCH |
|
static int |
PLAYTRANSITION_UNKNOWN |
|
static String |
PLAYTRANSITIONSTR_APPEND |
Play2 transition: APPEND
|
static String |
PLAYTRANSITIONSTR_RESET |
Play2 transition: RESET
|
static String |
PLAYTRANSITIONSTR_STOP |
Play2 transition: STOP
|
static String |
PLAYTRANSITIONSTR_SWAP |
Play2 transition: SWAP
|
static String |
PLAYTRANSITIONSTR_SWITCH |
Play2 transition: SWITCH
|
static String |
PLAYTRANSITIONSTR_UNKNOWN |
Play2 transition: UNKNOWN
|
| Constructor | Description |
|---|---|
ModuleBase() |
| Modifier and Type | Method | Description |
|---|---|---|
protected static IApplicationInstance |
getAppInstance(IClient client) |
Get applicationInstace of a client.
|
protected static IApplication |
getApplication(IClient client) |
Get application of a client.
|
protected static int |
getCallbackParamCount(AMFDataList params) |
Get the total number of parameters passed to callback.
|
protected static WMSLogger |
getLogger() |
Get the logging interface.
|
protected static AMFData |
getParam(AMFDataList params,
int index) |
Get parameter by index.
|
protected static boolean |
getParamBoolean(AMFDataList params,
int index) |
Get parameter by index, Return as boolean.
|
protected static boolean |
getParamBoolean(AMFDataList params,
int index,
boolean defaultVal) |
Get parameter by index, Return as boolean.
|
protected static int |
getParamCount(AMFDataList params) |
Get the total number of parameters passed to method.
|
protected static java.util.Date |
getParamDate(AMFDataList params,
int index) |
Get parameter by index, Return as Date.
|
protected static double |
getParamDouble(AMFDataList params,
int index) |
Get parameter by index, Return as double.
|
protected static double |
getParamDouble(AMFDataList params,
int index,
double defaultVal) |
Get parameter by index, Return as double.
|
protected static int |
getParamInt(AMFDataList params,
int index) |
Get parameter by index, Return as int.
|
protected static int |
getParamInt(AMFDataList params,
int index,
int defaultVal) |
Get parameter by index, Return as int.
|
protected static long |
getParamLong(AMFDataList params,
int index) |
Get parameter by index, Return as long.
|
protected static long |
getParamLong(AMFDataList params,
int index,
long defaultVal) |
Get parameter by index, Return as long.
|
protected static AMFDataMixedArray |
getParamMixedArray(AMFDataList params,
int index) |
Get parameter by index, Return as AMFDataMixedArray.
|
protected static AMFDataObj |
getParamObj(AMFDataList params,
int index) |
Get parameter by index, Return as Object.
|
protected static String |
getParamString(AMFDataList params,
int index) |
Get parameter by index, Return as String.
|
protected static String |
getParamString(AMFDataList params,
int index,
String defaultVal) |
Get parameter by index, Return as String.
|
protected static int |
getParamType(AMFDataList params,
int index) |
Get parameter type.
|
protected static IMediaStream |
getStream(IClient client,
com.wowza.wms.request.RequestFunction function) |
For methods called from the client side object NetStream (publish, play, deleteStream) get
the IMediaStream object associated with the call.
|
protected static IVHost |
getVHost(IClient client) |
Get vHost of a client.
|
protected void |
invokePrevious(IClient client,
com.wowza.wms.request.RequestFunction function,
AMFDataList params) |
Wowza Pro will determine command priority based on the order of the modules in the module list.
|
protected static void |
invokePrevious(Object instance,
IClient client,
com.wowza.wms.request.RequestFunction function,
AMFDataList params) |
Wowza Pro will determine command priority based on the order of the modules in the module list.
|
protected static boolean |
isSendResult(AMFDataList params) |
Is this method call expecting sendResult to be called.
|
protected static void |
sendClientOnStatusError(IClient client,
String code,
String description) |
Send an error message to the client-side client.onStatus handler
|
protected static boolean |
sendResult(IClient client,
AMFDataList params,
boolean value) |
Send a result to client method call as a single boolean value.
|
protected static boolean |
sendResult(IClient client,
AMFDataList params,
double value) |
Send a result to client method call as a single double value.
|
protected static boolean |
sendResult(IClient client,
AMFDataList params,
int value) |
Send a result to client method call as a single int value.
|
protected static boolean |
sendResult(IClient client,
AMFDataList params,
AMFData data) |
Send a result to client method call as a AMFData object.
|
protected static boolean |
sendResult(IClient client,
AMFDataList params,
String value) |
Send a result to client method call as a single String value.
|
protected static void |
sendStreamOnStatusError(IMediaStream stream,
String code,
String description) |
Send an error to the client-side NetStream.onStatus handler
|
public static final int CALLBACK_PARAM1
public static final int CALLBACK_PARAM10
public static final int CALLBACK_PARAM2
public static final int CALLBACK_PARAM3
public static final int CALLBACK_PARAM4
public static final int CALLBACK_PARAM5
public static final int CALLBACK_PARAM6
public static final int CALLBACK_PARAM7
public static final int CALLBACK_PARAM8
public static final int CALLBACK_PARAM9
public static final int PARAM1
public static final int PARAM10
public static final int PARAM2
public static final int PARAM3
public static final int PARAM4
public static final int PARAM5
public static final int PARAM6
public static final int PARAM7
public static final int PARAM8
public static final int PARAM9
public static final int PARAMMETHODNAME
public static final int PLAYTRANSITION_APPEND
public static final int PLAYTRANSITION_APPEND_IMMEDIATE
public static final int PLAYTRANSITION_RESET
public static final int PLAYTRANSITION_RESET_IMMEDIATE
public static final int PLAYTRANSITION_STOP
public static final int PLAYTRANSITION_SWAP
public static final int PLAYTRANSITION_SWITCH
public static final int PLAYTRANSITION_UNKNOWN
public static final String PLAYTRANSITIONSTR_APPEND
public static final String PLAYTRANSITIONSTR_RESET
public static final String PLAYTRANSITIONSTR_STOP
public static final String PLAYTRANSITIONSTR_SWAP
public static final String PLAYTRANSITIONSTR_SWITCH
public static final String PLAYTRANSITIONSTR_UNKNOWN
protected static IApplicationInstance getAppInstance(IClient client)
client - clientprotected static IApplication getApplication(IClient client)
client - clientprotected static int getCallbackParamCount(AMFDataList params)
params - parametersprotected static AMFData getParam(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static boolean getParamBoolean(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static boolean getParamBoolean(AMFDataList params, int index, boolean defaultVal)
params - parametersindex - parameter indexdefaultVal - default valueprotected static int getParamCount(AMFDataList params)
params - parametersprotected static java.util.Date getParamDate(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static double getParamDouble(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static double getParamDouble(AMFDataList params, int index, double defaultVal)
params - parametersindex - parameter indexdefaultVal - default valueprotected static int getParamInt(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static int getParamInt(AMFDataList params, int index, int defaultVal)
params - parametersindex - parameter indexdefaultVal - default valueprotected static long getParamLong(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static long getParamLong(AMFDataList params, int index, long defaultVal)
params - parametersindex - parameter indexdefaultVal - default valueprotected static AMFDataMixedArray getParamMixedArray(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static AMFDataObj getParamObj(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static String getParamString(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static String getParamString(AMFDataList params, int index, String defaultVal)
params - parametersindex - parameter indexdefaultVal - default valueprotected static int getParamType(AMFDataList params, int index)
params - parametersindex - parameter indexprotected static IMediaStream getStream(IClient client, com.wowza.wms.request.RequestFunction function)
client - clientfunction - functionsprotected static IVHost getVHost(IClient client)
client - clientprotected void invokePrevious(IClient client, com.wowza.wms.request.RequestFunction function, AMFDataList params)
client - client object passed into commandfunction - function passed into commandparams - parameters passed into commandprotected static void invokePrevious(Object instance,
IClient client,
com.wowza.wms.request.RequestFunction function,
AMFDataList params)
instance - instance of the current moduleclient - client object passed into commandfunction - function passed into commandparams - parameters passed into commandprotected static boolean isSendResult(AMFDataList params)
NetConnection.call("handlerName", resultObj, param1...); had
a value for resultObj (non-null), then the method is expecting some type of result
or return data. Calling a variant of sendResult will provide this callback.params - parametersprotected static void sendClientOnStatusError(IClient client, String code, String description)
client - destination clientcode - codedescription - descriptionprotected static boolean sendResult(IClient client, AMFDataList params, boolean value)
client - clientparams - parametersvalue - return valueprotected static boolean sendResult(IClient client, AMFDataList params, double value)
client - clientparams - parametersvalue - return valueprotected static boolean sendResult(IClient client, AMFDataList params, int value)
client - clientparams - parametersvalue - return valueprotected static boolean sendResult(IClient client, AMFDataList params, AMFData data)
new AMFDataItem((double)1.234) or
a complex type like AMFDataMixedArray, AMFDataArray or AMFDataObj.client - clientparams - parametersdata - return valueprotected static boolean sendResult(IClient client, AMFDataList params, String value)
client - clientparams - parametersvalue - return valueprotected static void sendStreamOnStatusError(IMediaStream stream, String code, String description)
stream - destination streamcode - codedescription - description