WZPlayerView (GoCoder SDK Android API)

java.lang.Object
- FrameLayout
- - com.wowza.gocoder.sdk.api.player.WZPlayerView

All Implemented Interfaces:: WZPlayerAPI.WZAudioStreamReceiver, WZPlayerAPI.WZVideoStreamReceiver

public class WZPlayerView
extends FrameLayout
implements WZPlayerAPI.WZVideoStreamReceiver, WZPlayerAPI.WZAudioStreamReceiver

Field Summary

Fields
Modifier and Type	Field and Description
`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

WZPlayerView(Context context)

WZPlayerView(Context context, AttributeSet attrs)

Constructors
Constructor and Description
`WZPlayerView(Context context)`
`WZPlayerView(Context context, AttributeSet attrs)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`int`	`getCurrentState()` Get the current player state
`WZStatus`	`getCurrentStatus()` Get the current player status
`long`	`getCurrentTime()` Get the timecode of the most recent frame displayed by the player
`long`	`getDuration()` Returns the duration of a VOD stream
`int`	`getLogLevel()` Set the logging level of the network messages during playing
`WZDataMap`	`getMetadata()` Returns the stream metadata for an actively playing stream
`int`	`getScaleMode()` Get the view's video scaling mode
`WZStreamConfig`	`getStreamConfig()` Returns detailed configuration information for the stream being played (e.g.
`WZDataMap`	`getStreamStats()`
`int`	`getVolume()` Get the volume level
`boolean`	`isBuffering()` Indicates if the player is actively buffering media
`boolean`	`isMuted()` Indicates if the player's audio track is muted or not
`boolean`	`isPlaying()` Indicates if the player is actively playing media
`boolean`	`isReadyToPlay()` Indicates if the player is in state where play can be initiated
`void`	`mute(boolean isMuted)` Set the muted state of the player's audio track
`void`	`onAudioSampleReceived(int sampleType, long timecodeMs, byte[] sampleBuffer)`
`void`	`onEnhancedSeekEnd()`
`void`	`onEnhancedSeekStart()`
`void`	`onStateChanged(WZStatusCallback statusCallback)` Set the player state change callback
`void`	`onVideoFrameReceived(int frameType, long timecodeMs, byte[] frameBuffer)`
`void`	`play(WZPlayerConfig playerConfig, WZStatusCallback statusCallback)` Start playback using the specified stream configuration.
`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`	`setLogLevel(int logLevel)` Returns the logging level of the network messages during playing
`void`	`setScaleMode(int scaleMode)` Set the view's video scaling mode
`void`	`setVolume(int volume)` Set the volume level
`void`	`stop()` Stop playback.
`void`	`stop(WZStatusCallback statusCallback)` Stop playback.
`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
  - 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
- Constructor Detail
  - WZPlayerView
```
public WZPlayerView(Context context)
```
  - WZPlayerView
```
public WZPlayerView(Context context,
                    AttributeSet attrs)
```
- Method Detail
  - onStateChanged
```
public void onStateChanged(WZStatusCallback statusCallback)
```
    Set the player state change callback
    
    Parameters:
    
    statusCallback - the player status callback
  - getCurrentState
```
public int getCurrentState()
```
    Get the current player state
    
    Returns:
    
    the current player state
  - getCurrentStatus
```
public WZStatus getCurrentStatus()
```
    Get the current player status
    
    Returns:
    
    the current player status
  - getVolume
```
public int getVolume()
```
    Get the volume level
    
    Returns:
    
    A value between 0.0 and 1.0 indicating the volume level
  - setVolume
```
public void setVolume(int volume)
```
    Set the volume level
    
    Parameters:
    
    volume - A value between 0 and 100 specifying the volume level
  - mute
```
public void mute(boolean isMuted)
```
    Set the muted state of the player's audio track
    
    Parameters:
    
    isMuted - true to mute, false otherwise
  - isMuted
```
public boolean isMuted()
```
    Indicates if the player's audio track is muted or not
    
    Returns:
    
    true if muted, false otherwise
  - getScaleMode
```
public int getScaleMode()
```
    Get the view's video scaling mode
    
    Returns:
    
    One of WZMediaConfig.FILL_VIEW or WZMediaConfig.RESIZE_TO_ASPECT (default)
  - setScaleMode
```
public void setScaleMode(int scaleMode)
```
    Set the view's video scaling mode
    
    Parameters:
    
    scaleMode - One of WZMediaConfig.FILL_VIEW or WZMediaConfig.RESIZE_TO_ASPECT (default)
  - clear
```
public void clear()
```
  - getLogLevel
```
public int getLogLevel()
```
    Set the logging level of the network messages during playing
    
    Returns:
    
    One of the log levels defined in WZLog
  - setLogLevel
```
public void setLogLevel(int logLevel)
```
    Returns the logging level of the network messages during playing
    
    Parameters:
    
    logLevel - One of the log levels defined in WZLog
  - isReadyToPlay
```
public boolean isReadyToPlay()
```
    Indicates if the player is in state where play can be initiated
    
    Returns:
    
    true if the player is ini a stopped or paused state, false otherwise
  - play
```
public void play(WZPlayerConfig playerConfig,
                 WZStatusCallback statusCallback)
```
    Start playback using the specified stream configuration. The onStatus() method of the status callback will be invoked with the state set to WZState.RUNNING when complete.
    
    Parameters:
    
    playerConfig - the stream configuration to activate
  - stop
```
public void stop()
```
    Stop playback. The onStatus() method of the status callback will be invoked with the state set to WZState.IDLE when complete.
  - stop
```
public void stop(WZStatusCallback statusCallback)
```
    Stop playback. The onStatus() method of the status callback will be invoked with the state set to WZState.IDLE when complete.
  - onEnhancedSeekStart
```
public void onEnhancedSeekStart()
```
    Specified by:
    
    onEnhancedSeekStart in interface WZPlayerAPI.WZVideoStreamReceiver
  - onEnhancedSeekEnd
```
public void onEnhancedSeekEnd()
```
    Specified by:
    
    onEnhancedSeekEnd in interface WZPlayerAPI.WZVideoStreamReceiver
  - onVideoFrameReceived
```
public void onVideoFrameReceived(int frameType,
                                 long timecodeMs,
                                 byte[] frameBuffer)
```
    Specified by:
    
    onVideoFrameReceived in interface WZPlayerAPI.WZVideoStreamReceiver
  - onAudioSampleReceived
```
public void onAudioSampleReceived(int sampleType,
                                  long timecodeMs,
                                  byte[] sampleBuffer)
```
    Specified by:
    
    onAudioSampleReceived in interface WZPlayerAPI.WZAudioStreamReceiver
  - isPlaying
```
public boolean isPlaying()
```
    Indicates if the player is actively playing media
    
    Returns:
    
    true if the player is actively playing media, false otherwise
  - isBuffering
```
public boolean isBuffering()
```
    Indicates if the player is actively buffering media
    
    Returns:
    
    true if the player is actively buffering media, false otherwise
  - getCurrentTime
```
public long getCurrentTime()
```
    Get the timecode of the most recent frame displayed by the player
    
    Returns:
    
    the timecode of the most recent frame, in milliseconds
  - getStreamConfig
```
public WZStreamConfig getStreamConfig()
```
    Returns detailed configuration information for the stream being played (e.g. width, height, frame rate, etc) or the last stream played
    
    Returns:
    
    detailed configuration information for the stream being played or the last stream played, @{code null} if a stream has not been played
  - getDuration
```
public long getDuration()
```
    Returns the duration of a VOD stream
    
    Returns:
    
    the duration, in milliseconds
  - getMetadata
```
public WZDataMap getMetadata()
```
    Returns the stream metadata for an actively playing stream
    
    Returns:
    
    the stream metadata or null if there is not an actively playing stream
  - 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
  - getStreamStats
```
public WZDataMap getStreamStats()
```
  - 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.

Class WZPlayerView

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_READY_TO_PLAY

STATE_PREPARING

STATE_PLAYING

STATE_STOPPING

STATE_PLAYBACK_COMPLETE

STATE_ERROR

STATE_PREBUFFERING_STARTED

STATE_PREBUFFERING_ENDED

Constructor Detail

WZPlayerView

WZPlayerView

Method Detail

onStateChanged

getCurrentState

getCurrentStatus

getVolume

setVolume

mute

isMuted

getScaleMode

setScaleMode

clear

getLogLevel

setLogLevel

isReadyToPlay

play

stop

stop

onEnhancedSeekStart

onEnhancedSeekEnd

onVideoFrameReceived

onAudioSampleReceived

isPlaying

isBuffering

getCurrentTime

getStreamConfig

getDuration

getMetadata

sendDataEvent

sendDataEvent

sendDataEvent

sendDataEvent

registerDataEventListener

unregisterDataEventListener

getStreamStats

sendPingRequest