com.wowza.gocoder.sdk.api.broadcast

Class WOWZBroadcast

java.lang.Object

com.wowza.gocoder.sdk.api.broadcast.WOWZBroadcast

public class WOWZBroadcast
extends java.lang.Object

Use the WOWZBroadcast class to configure and control live streaming broadcasts.

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 collected 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. Use setLogLevel(int) instead.

Constructor Summary

Constructors

Constructor and Description
WOWZBroadcast()

Method Summary

Modifier and Type	Method and Description
WOWZStatus	endBroadcast() Stops the active live streaming broadcast.
WOWZStatus	endBroadcast(WOWZStatusCallback statusCallback) Stops the active live streaming broadcast.
WOWZBroadcastConfig	getBroadcastConfig() Gets the active broadcast configuration.
WOWZStreamingStat	getBroadcastStatistics()
WOWZStatus	getBroadcastStatus() Deprecated. Use getStatus() instead.
int	getLogLevel()
WOWZStatus	getStatus() Gets the active broadcast status.
WOWZStatusCallback	getStatusCallback() Gets the broadcast status callback.
boolean	isABRActivated()
void	registerAdaptiveBitRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener) Registers a WOWZBroadcastAPI.AdaptiveChangeListener to get callbacks on the adaptive bitrate mechanism.
void	registerAdaptiveFrameRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener) Registers a WOWZBroadcastAPI.AdaptiveChangeListener to get callbacks on the adaptive bitrate mechanism.
void	registerDataEventListener(java.lang.String eventName, WOWZDataEvent.EventListener eventListener) Registers a data event listener to be invoked upon receiving a specified data event.
void	sendDataEvent(WOWZDataScope eventScope, java.lang.String eventName) Sends a data event with the specified scope, name, and parameters.
void	sendDataEvent(WOWZDataScope eventScope, java.lang.String eventName, WOWZDataEvent.ResultCallback resultCallback) Sends a data event with the specified scope, name, and result callback.
void	sendDataEvent(WOWZDataScope eventScope, java.lang.String eventName, WOWZDataMap eventParams) Sends a data event with the specified scope, name, and parameters.
void	sendDataEvent(WOWZDataScope eventScope, java.lang.String eventName, WOWZDataMap eventParams, WOWZDataEvent.ResultCallback resultCallback) Sends a data event with the specified scope, name, parameters, and result callback.
void	sendPingRequest(WOWZDataEvent.ResultCallback resultCallback) Pings the server and returns the result to the specified callback.
void	setABRActivated(boolean abrActive)
void	setLogLevel(int logLevel)
void	setStatusCallback(WOWZStatusCallback statusCallback) Sets the broadcast status callback.
WOWZStatus	startBroadcast(WOWZBroadcastConfig broadcastConfig) Starts a live streaming broadcast using the specified configuration.
WOWZStatus	startBroadcast(WOWZBroadcastConfig broadcastConfig, WOWZStatusCallback statusCallback) Starts a live streaming broadcast using the specified configuration.
void	unregisterAdaptiveBitRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener) Removes an adaptive bitrate listener.
void	unregisterAdaptiveFrameRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener) Removes an adaptive framerate listener.
void	unregisterDataEventListener(java.lang.String eventName, WOWZDataEvent.EventListener eventListener) Unregisters a 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 collected 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. Use setLogLevel(int) instead.

Constructor Detail

WOWZBroadcast

public WOWZBroadcast()

Method Detail

startBroadcast

public WOWZStatus startBroadcast(WOWZBroadcastConfig broadcastConfig,
                                 WOWZStatusCallback statusCallback)

Starts a live streaming broadcast using the specified configuration.

Parameters:

broadcastConfig - The configuration settings to use.

statusCallback - An instance of the WOWZStatusCallback interface that will receive broadcast status information.

startBroadcast

public WOWZStatus startBroadcast(WOWZBroadcastConfig broadcastConfig)

Starts a live streaming broadcast using the specified configuration.

Parameters:

broadcastConfig - The configuration settings to use.

endBroadcast

public WOWZStatus endBroadcast()

Stops the active live streaming broadcast.

endBroadcast

public WOWZStatus endBroadcast(WOWZStatusCallback statusCallback)

Stops the active live streaming broadcast.

Parameters:

statusCallback - An instance of the WOWZStatusCallback interface that will receive broadcast status information.

getBroadcastStatistics

public WOWZStreamingStat getBroadcastStatistics()

isABRActivated

public boolean isABRActivated()

setABRActivated

public void setABRActivated(boolean abrActive)

registerAdaptiveFrameRateListener

public void registerAdaptiveFrameRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener)

Registers a WOWZBroadcastAPI.AdaptiveChangeListener to get callbacks on the adaptive bitrate mechanism. Gives you the ability to influence the decisions derived from our adaptive bitrate algorithm.

Parameters:

listener - The WOWZBroadcastAPI.AdaptiveChangeListener listener that will handle frame-rate modifications.

registerAdaptiveBitRateListener

public void registerAdaptiveBitRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener)

Registers a WOWZBroadcastAPI.AdaptiveChangeListener to get callbacks on the adaptive bitrate mechanism. Gives you the ability to influence the decisions derived from our adaptive bitrate algorithm.

Parameters:

listener - The WOWZBroadcastAPI.AdaptiveChangeListener listener that will handle bitrate modifications.

unregisterAdaptiveBitRateListener

public void unregisterAdaptiveBitRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener)

Removes an adaptive bitrate listener.

Parameters:

listener - The listener to remove.

unregisterAdaptiveFrameRateListener

public void unregisterAdaptiveFrameRateListener(WOWZBroadcastAPI.AdaptiveChangeListener listener)

Removes an adaptive framerate listener.

Parameters:

listener - The listener to remove.

getStatusCallback

public WOWZStatusCallback getStatusCallback()

Gets the broadcast status callback.

Returns:

The status callback.

setStatusCallback

public void setStatusCallback(WOWZStatusCallback statusCallback)

Sets the broadcast status callback.

Parameters:

statusCallback - The status callback.

setLogLevel

public void setLogLevel(int logLevel)

getLogLevel

public int getLogLevel()

getStatus

public WOWZStatus getStatus()

Gets the active broadcast status.

Returns:

The broadcast status.

getBroadcastStatus

public WOWZStatus getBroadcastStatus()

Deprecated. Use getStatus() instead.

getBroadcastConfig

public WOWZBroadcastConfig getBroadcastConfig()

Gets the active broadcast configuration.

Returns:

The broadcast configuration.

sendDataEvent

public void sendDataEvent(WOWZDataScope eventScope,
                          java.lang.String eventName,
                          WOWZDataMap eventParams,
                          WOWZDataEvent.ResultCallback resultCallback)

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

Parameters:

eventScope - One of WOWZDataScope.STREAM or WOWZDataScope.MODULE, the scope to which the event applies. If eventScope is WOWZDataScope#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 WOWZDataEvent.ResultCallback interface whose WOWZDataEvent.ResultCallback#onWZDataEventResult method will be invoked upon receiving a resulting response from the server.

sendDataEvent

public void sendDataEvent(WOWZDataScope eventScope,
                          java.lang.String eventName,
                          WOWZDataEvent.ResultCallback resultCallback)

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

Parameters:

eventScope - One of WOWZDataScope.STREAM or WOWZDataScope.MODULE, the scope to which the event applies. If eventScope is WOWZDataScope#STREAM, the resultCallback parameter must be null.

eventName - The name of the event to send.

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

sendDataEvent

public void sendDataEvent(WOWZDataScope eventScope,
                          java.lang.String eventName,
                          WOWZDataMap eventParams)

Sends a data event with the specified scope, name, and parameters.

Parameters:

eventScope - One of WOWZDataScope.STREAM or WOWZDataScope.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(WOWZDataScope eventScope,
                          java.lang.String eventName)

Sends a data event with the specified scope, name, and parameters.

Parameters:

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

eventName - The name of the event.

registerDataEventListener

public void registerDataEventListener(java.lang.String eventName,
                                      WOWZDataEvent.EventListener eventListener)

Registers a data event listener to be invoked upon receiving a specified data event.

Parameters:

eventName - The name of the event.

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

unregisterDataEventListener

public void unregisterDataEventListener(java.lang.String eventName,
                                        WOWZDataEvent.EventListener eventListener)

Unregisters a data event listener.

Parameters:

eventName - The name of the event.

eventListener - A previously registered data event listener.

sendPingRequest

public void sendPingRequest(WOWZDataEvent.ResultCallback resultCallback)

Pings the server and returns the result to the specified callback. The result, in milliseconds, will be available in a responseTime property 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.