com.wowza.gocoder.sdk.api.broadcast

Class WZBroadcast

java.lang.Object

com.wowza.gocoder.sdk.api.broadcast.WZBroadcast

public class WZBroadcast
extends Object

The WZBroadcast class is used to configure and control a live streaming broadcast.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	LOG_STAT_SAMPLES Set to true to log detailed information about the network performance samples gathered during a broadcast
static boolean	LOG_STAT_SUMMARY Set to true to log summary information at the end of a broadcast
static boolean	LOG_WOWZ_MESSAGES Deprecated. User setLogLevel(int) instead

Constructor Summary

Constructors

Constructor and Description
WZBroadcast()

Method Summary

Modifier and Type	Method and Description
WZStatus	endBroadcast() Stop the active live streaming broadcast
WZStatus	endBroadcast(WZStatusCallback statusCallback) Stop the active live streaming broadcast
WZBroadcastConfig	getBroadcastConfig() Return the active broadcast configuration
WZStreamingStat	getBroadcastStatistics()
WZStatus	getBroadcastStatus() Deprecated. use getStatus() instead
int	getLogLevel()
WZStatus	getStatus() Return the active broadcast status
WZStatusCallback	getStatusCallback() Returns the broadcast status callback
boolean	isABRActivated()
void	registerDataEventListener(String eventName, WZDataEvent.EventListener eventListener) Register a data event listener to be invoked upon receiving a specified named data event
void	sendDataEvent(WZDataScope eventScope, String eventName) Send a data event with the specified scope, name, and parameters
void	sendDataEvent(WZDataScope eventScope, String eventName, WZDataEvent.ResultCallback resultCallback) Send a data event with the specified scope, name, and result callback.
void	sendDataEvent(WZDataScope eventScope, String eventName, WZDataMap eventParams) Send a data event with the specified scope, name, and parameters
void	sendDataEvent(WZDataScope eventScope, String eventName, WZDataMap eventParams, WZDataEvent.ResultCallback resultCallback) Send a data event with the specified scope, name, parameters, and result callback.
void	sendPingRequest(WZDataEvent.ResultCallback resultCallback) Sends a ping request to the server and returns the result to the specified callback.
void	setABRActivated(boolean abrActive)
void	setLogLevel(int logLevel)
void	setStatusCallback(WZStatusCallback statusCallback) Sets the broadcast status callback
WZStatus	startBroadcast(WZBroadcastConfig broadcastConfig) Start a live streaming broadcast using the specified configuration
WZStatus	startBroadcast(WZBroadcastConfig broadcastConfig, WZStatusCallback statusCallback) Start a live streaming broadcast using the specified configuration
void	unregisterDataEventListener(String eventName, WZDataEvent.EventListener eventListener) Unregister a previouslly registered data event listener

Methods inherited from class java.lang.Object

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

Field Detail

LOG_STAT_SAMPLES

public static boolean LOG_STAT_SAMPLES

Set to true to log detailed information about the network performance samples gathered during a broadcast

LOG_STAT_SUMMARY

public static boolean LOG_STAT_SUMMARY

Set to true to log summary information at the end of a broadcast

LOG_WOWZ_MESSAGES

public static boolean LOG_WOWZ_MESSAGES

Deprecated. User setLogLevel(int) instead

Constructor Detail

WZBroadcast

public WZBroadcast()

Method Detail

startBroadcast

public WZStatus startBroadcast(WZBroadcastConfig broadcastConfig,
                               WZStatusCallback statusCallback)

Start a live streaming broadcast using the specified configuration

Parameters:

broadcastConfig - The configuration settings specified are applied to the SDK's active configuration settings before the broadcast begins.

statusCallback - An instance of the WZStatusCallback interface which will receive broadcast status information

startBroadcast

public WZStatus startBroadcast(WZBroadcastConfig broadcastConfig)

Start a live streaming broadcast using the specified configuration

Parameters:

broadcastConfig - The configuration settings specified are applied to the SDK's active configuration settings before the broadcast begins.

endBroadcast

public WZStatus endBroadcast()

Stop the active live streaming broadcast

endBroadcast

public WZStatus endBroadcast(WZStatusCallback statusCallback)

Stop the active live streaming broadcast

Parameters:

statusCallback - An instance of the WZStatusCallback interface which will receive broadcast status information

getBroadcastStatistics

public WZStreamingStat getBroadcastStatistics()

isABRActivated

public boolean isABRActivated()

setABRActivated

public void setABRActivated(boolean abrActive)

getStatusCallback

public WZStatusCallback getStatusCallback()

Returns the broadcast status callback

Returns:

The status callback

setStatusCallback

public void setStatusCallback(WZStatusCallback statusCallback)

Sets the broadcast status callback

Parameters:

statusCallback - The status callback

setLogLevel

public void setLogLevel(int logLevel)

getLogLevel

public int getLogLevel()

getStatus

public WZStatus getStatus()

Return the active broadcast status

Returns:

The broadcast status

getBroadcastStatus

public WZStatus getBroadcastStatus()

Deprecated. use getStatus() instead

getBroadcastConfig

public WZBroadcastConfig getBroadcastConfig()

Return the active broadcast configuration

Returns:

The broadcast configuration

sendDataEvent

public void sendDataEvent(WZDataScope eventScope,
                          String eventName,
                          WZDataMap eventParams,
                          WZDataEvent.ResultCallback resultCallback)

Send a data event with the specified scope, name, parameters, and result callback.

Parameters:

eventScope - One of WZDataScope.STREAM or WZDataScope.MODULE, the scope to which the event applies. Note that if eventScope is WZDataScope.STREAM the resultCallback parameter must be null

eventName - The name of the event to send

eventParams - A name/value pair hash map of the event's parameters

resultCallback - An implementation of the WZDataEvent.ResultCallback interface whose WZDataEvent.ResultCallback#onWZDataEventResult method will be invoked upon receiving a resulting response from the server.

sendDataEvent

public void sendDataEvent(WZDataScope eventScope,
                          String eventName,
                          WZDataEvent.ResultCallback resultCallback)

Send a data event with the specified scope, name, and result callback. s

Parameters:

eventScope - One of WZDataScope.STREAM or WZDataScope.MODULE, the scope to which the event applies. Note that if eventScope is WZDataScope.STREAM the resultCallback parameter must be null

eventName - The name of the event to send

resultCallback - An implementation of the WZDataEvent.ResultCallback interface whose WZDataEvent.ResultCallback#onWZDataEventResult method will be invoked upon receiving a resulting response from the server.

sendDataEvent

public void sendDataEvent(WZDataScope eventScope,
                          String eventName,
                          WZDataMap eventParams)

Send a data event with the specified scope, name, and parameters

Parameters:

eventScope - One of WZDataScope.STREAM or WZDataScope.MODULE, the scope to which the event applies.

eventName - The name of the event to send

eventParams - A name/value pair hash map of the event's parameters

sendDataEvent

public void sendDataEvent(WZDataScope eventScope,
                          String eventName)

Send a data event with the specified scope, name, and parameters

Parameters:

eventScope - One of WZDataScope.STREAM or WZDataScope.MODULE, the scope to which the event applies.

eventName - The name of the event

registerDataEventListener

public void registerDataEventListener(String eventName,
                                      WZDataEvent.EventListener eventListener)

Register a data event listener to be invoked upon receiving a specified named data event

Parameters:

eventName - The name of the event

eventListener - A callback instance to be invoked when the specified event is received

unregisterDataEventListener

public void unregisterDataEventListener(String eventName,
                                        WZDataEvent.EventListener eventListener)

Unregister a previouslly registered data event listener

Parameters:

eventName - The name of the event

eventListener - A previouslly registered data event listener

sendPingRequest

public void sendPingRequest(WZDataEvent.ResultCallback resultCallback)

Sends a ping request to the server and returns the result to the specified callback. The result, in milliseconds, will be available in a property named responseTime present in the parameters sent to the resultCallback

Parameters:

resultCallback - A callback to be invoked with the results of the request. The responseTime property of the result parameters passed to the callback will contain the response time, in milliseconds.