com.wowza.gocoder.sdk.api.player

Class WOWZPlayerView

java.lang.Object

FrameLayout

com.wowza.gocoder.sdk.api.player.WOWZPlayerView

All Implemented Interfaces:

WOWZPlayerAPI.WZAudioStreamReceiver, WOWZPlayerAPI.WZVideoStreamReceiver

public class WOWZPlayerView
extends FrameLayout
implements WOWZPlayerAPI.WZVideoStreamReceiver, WOWZPlayerAPI.WZAudioStreamReceiver

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	isCanceling
static int	STATE_ERROR
static int	STATE_PLAYBACK_COMPLETE
static int	STATE_PLAYING
static int	STATE_PREBUFFERING_ENDED
static int	STATE_PREBUFFERING_STARTED
static int	STATE_PREPARING
static int	STATE_READY_TO_PLAY
static int	STATE_STOPPING

Constructor Summary

Constructors

Constructor and Description
WOWZPlayerView(Context context)
WOWZPlayerView(Context context, AttributeSet attrs)

Method Summary

Modifier and Type	Method and Description
void	clear()
int	getCurrentState() Gets the current player state.
WOWZStatus	getCurrentStatus() Gets the current player status.
long	getCurrentTime() Gets the timecode of the most recent frame displayed by the player.
long	getDuration() Gets the duration of a video-on-demand stream.
int	getLogLevel() Gets the logging level of the network messages during playback.
WOWZDataMap	getMetadata() Gets metadata for the actively playing stream.
int	getScaleMode() Gets the view's video scaling mode.
WOWZStreamConfig	getStreamConfig() Gets detailed configuration information for the most recently played stream.
WOWZDataMap	getStreamStats()
int	getVolume() Gets the volume level.
boolean	isBuffering() Checks whether the player is actively buffering media.
boolean	isMuted() Checks whether the player's audio track is muted.
boolean	isPlaying() Checks whether the player is actively playing media.
boolean	isReadyToPlay() Checks whether the player is in a state that allows playback to start.
void	mute(boolean isMuted) Sets the player's audio track to mute.
void	onAudioSampleReceived(int sampleType, long timecodeMs, byte[] sampleBuffer)
void	onEnhancedSeekEnd()
void	onEnhancedSeekStart()
void	onStateChanged(WOWZStatusCallback statusCallback) Sets the player state change callback.
void	onVideoFrameReceived(int frameType, long timecodeMs, byte[] frameBuffer, long timecodeOffset)
void	pauseNetworkStack()
void	play(WOWZPlayerConfig playerConfig, WOWZStatusCallback statusCallback) Starts playback using the specified stream configuration.
void	registerDataEventListener(java.lang.String eventName, WOWZDataEvent.EventListener eventListener) Registers a data event listener to be invoked upon receiving a specified 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	setLogLevel(int logLevel) Sets the logging level of the network messages during playback.
void	setScaleMode(int scaleMode) Sets the view's video scaling mode.
void	setVolume(int volume) Sets the volume level.
void	stop() Stops playback.
void	stop(boolean isCanceling)
void	stop(WOWZStatusCallback statusCallback) Stops playback.
void	stopWithoutStatusUpdates()
void	unpauseNetworkStack()
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

STATE_READY_TO_PLAY

public static final int STATE_READY_TO_PLAY

See Also:

Constant Field Values

STATE_PREPARING

public static final int STATE_PREPARING

See Also:

Constant Field Values

STATE_PLAYING

public static final int STATE_PLAYING

See Also:

Constant Field Values

STATE_STOPPING

public static final int STATE_STOPPING

See Also:

Constant Field Values

STATE_PLAYBACK_COMPLETE

public static final int STATE_PLAYBACK_COMPLETE

See Also:

Constant Field Values

STATE_ERROR

public static final int STATE_ERROR

See Also:

Constant Field Values

STATE_PREBUFFERING_STARTED

public static final int STATE_PREBUFFERING_STARTED

See Also:

Constant Field Values

STATE_PREBUFFERING_ENDED

public static final int STATE_PREBUFFERING_ENDED

See Also:

Constant Field Values

isCanceling

public static boolean isCanceling

Constructor Detail

WOWZPlayerView

public WOWZPlayerView(Context context)

WOWZPlayerView

public WOWZPlayerView(Context context,
                      AttributeSet attrs)

Method Detail

pauseNetworkStack

public void pauseNetworkStack()

unpauseNetworkStack

public void unpauseNetworkStack()

onStateChanged

public void onStateChanged(WOWZStatusCallback statusCallback)

Sets the player state change callback.

Parameters:

statusCallback - The player status callback.

getCurrentState

public int getCurrentState()

Gets the current player state.

Returns:

The player state.

getCurrentStatus

public WOWZStatus getCurrentStatus()

Gets the current player status.

Returns:

The player status.

getVolume

public int getVolume()

Gets the volume level.

Returns:

The volume level, on a scale of 0.0 to 1.0.

setVolume

public void setVolume(int volume)

Sets the volume level.

Parameters:

volume - A value between 0 and 100 that specifies the volume level.

mute

public void mute(boolean isMuted)

Sets the player's audio track to mute.

Parameters:

isMuted - True to mute; false otherwise.

isMuted

public boolean isMuted()

Checks whether the player's audio track is muted.

Returns:

True if muted; false otherwise.

getScaleMode

public int getScaleMode()

Gets the view's video scaling mode.

Returns:

One of WOWZMediaConfig.FILL_VIEW or WOWZMediaConfig.RESIZE_TO_ASPECT (default).

setScaleMode

public void setScaleMode(int scaleMode)

Sets the view's video scaling mode.

Parameters:

scaleMode - One of WOWZMediaConfig.FILL_VIEW or WOWZMediaConfig.RESIZE_TO_ASPECT (default).

clear

public void clear()

getLogLevel

public int getLogLevel()

Gets the logging level of the network messages during playback.

Returns:

One of the log levels defined in WOWZLog.

setLogLevel

public void setLogLevel(int logLevel)

Sets the logging level of the network messages during playback.

Parameters:

logLevel - One of the log levels defined in WOWZLog.

isReadyToPlay

public boolean isReadyToPlay()

Checks whether the player is in a state that allows playback to start.

Returns:

True if the player stopped or paused; false otherwise.

play

public void play(WOWZPlayerConfig playerConfig,
                 WOWZStatusCallback statusCallback)

Starts playback using the specified stream configuration. The onStatus() method of the status callback will be invoked with the state set to WOWZState.RUNNING when complete.

Parameters:

playerConfig - The stream configuration to use.

stop

public void stop(boolean isCanceling)

stop

public void stop()

Stops playback. The onStatus() method of the status callback will be invoked with the state set to WOWZState.IDLE when complete.

stopWithoutStatusUpdates

public void stopWithoutStatusUpdates()

stop

public void stop(WOWZStatusCallback statusCallback)

Stops playback. The onStatus() method of the status callback will be invoked with the state set to WOWZState.IDLE when complete.

onEnhancedSeekStart

public void onEnhancedSeekStart()

Specified by:

onEnhancedSeekStart in interface WOWZPlayerAPI.WZVideoStreamReceiver

onEnhancedSeekEnd

public void onEnhancedSeekEnd()

Specified by:

onEnhancedSeekEnd in interface WOWZPlayerAPI.WZVideoStreamReceiver

onVideoFrameReceived

public void onVideoFrameReceived(int frameType,
                                 long timecodeMs,
                                 byte[] frameBuffer,
                                 long timecodeOffset)

Specified by:

onVideoFrameReceived in interface WOWZPlayerAPI.WZVideoStreamReceiver

onAudioSampleReceived

public void onAudioSampleReceived(int sampleType,
                                  long timecodeMs,
                                  byte[] sampleBuffer)

Specified by:

onAudioSampleReceived in interface WOWZPlayerAPI.WZAudioStreamReceiver

isPlaying

public boolean isPlaying()

Checks whether the player is actively playing media.

Returns:

True if the player is playing media; false otherwise.

isBuffering

public boolean isBuffering()

Checks whether the player is actively buffering media.

Returns:

True if the player is buffering media; false otherwise.

getCurrentTime

public long getCurrentTime()

Gets the timecode of the most recent frame displayed by the player.

Returns:

The timecode of the most recent frame, in milliseconds.

getStreamConfig

public WOWZStreamConfig getStreamConfig()

Gets detailed configuration information for the most recently played stream.

Returns:

Configuration information for the most recently stream played, including width, height, and frame rate, or null if a stream hasn't been played.

getDuration

public long getDuration()

Gets the duration of a video-on-demand stream.

Returns:

The duration of the stream, in milliseconds.

getMetadata

public WOWZDataMap getMetadata()

Gets metadata for the actively playing stream.

Returns:

The stream's metadata, or null if there's no active stream.

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 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.

getStreamStats

public WOWZDataMap getStreamStats()

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 contain the response time, in milliseconds.