com.pubmatic.sdk.video.player

Class POBMediaPlayer

java.lang.Object

com.pubmatic.sdk.video.player.POBMediaPlayer

All Implemented Interfaces:

android.media.MediaPlayer.OnBufferingUpdateListener, android.media.MediaPlayer.OnCompletionListener, android.media.MediaPlayer.OnErrorListener, android.media.MediaPlayer.OnInfoListener, android.media.MediaPlayer.OnPreparedListener, android.media.MediaPlayer.OnVideoSizeChangedListener, POBPlayer

public class POBMediaPlayer
extends java.lang.Object
implements POBPlayer, android.media.MediaPlayer.OnPreparedListener, android.media.MediaPlayer.OnBufferingUpdateListener, android.media.MediaPlayer.OnErrorListener, android.media.MediaPlayer.OnCompletionListener, android.media.MediaPlayer.OnInfoListener, android.media.MediaPlayer.OnVideoSizeChangedListener

Class responsible for native media player handling and provides basic video player functionality to play video content

Nested Class Summary

Nested classes/interfaces inherited from interface com.pubmatic.sdk.video.player.POBPlayer

POBPlayer.POBPlayerListener

Field Summary

Fields inherited from interface com.pubmatic.sdk.video.player.POBPlayer

PROGRESS_UPDATE_DELAY

Constructor Summary

Constructors

Constructor and Description
POBMediaPlayer(java.lang.String uri, android.os.Handler callbackHandler) Create a new media player instance and load video in background

Method Summary

Modifier and Type	Method and Description
void	destroy() Method to do resource cleanup
int	getDuration() Gets the duration of the media.
int	getVideoHeight() Get video player height
int	getVideoWidth() Get video player width
void	onBufferingUpdate(android.media.MediaPlayer mp, int percent) Called to update status in buffering a media stream received through progressive HTTP download.
void	onCompletion(android.media.MediaPlayer mp) Called when the end of a media source is reached during playback.
boolean	onError(android.media.MediaPlayer mp, int what, int extra)
boolean	onInfo(android.media.MediaPlayer mp, int what, int extra)
void	onPrepared(android.media.MediaPlayer mp) Called when the media file is ready for playback.
void	onSurfaceCreated(android.view.Surface surface) Method to notify surface created
void	onSurfaceDestroyed(android.view.Surface surface) Method to notify surface destroyed
void	onVideoSizeChanged(android.media.MediaPlayer mp, int width, int height)
void	pause() Pauses current playback.
void	setPlayerListener(POBPlayer.POBPlayerListener playerListener) Register listener to get Video Player callbacks
void	setPrepareTimeout(int prepareTimeout) Set prepare timeout to handle Player url loading.
void	setStallTimeout(int stallTimeout) Set stall timeout to handle Player buffering.
void	setVolume(int leftVolume, int rightVolume) Set audio volume of Player
void	start() Start current playback.
void	stop() Stops playback after playback has been onStart or onPause.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBMediaPlayer

public POBMediaPlayer(@NonNull
                      java.lang.String uri,
                      @NonNull
                      android.os.Handler callbackHandler)

Create a new media player instance and load video in background

Parameters:

uri - video url

callbackHandler - handler to provide POBPlayerListener callbacks

Method Detail

setPlayerListener

public void setPlayerListener(@NonNull
                              POBPlayer.POBPlayerListener playerListener)

Description copied from interface: POBPlayer

Register listener to get Video Player callbacks

Specified by:

setPlayerListener in interface POBPlayer

Parameters:

playerListener - callback listener instance

setPrepareTimeout

public void setPrepareTimeout(int prepareTimeout)

Description copied from interface: POBPlayer

Set prepare timeout to handle Player url loading.

Specified by:

setPrepareTimeout in interface POBPlayer

Parameters:

prepareTimeout - the timeout value in milliseconds.

setStallTimeout

public void setStallTimeout(int stallTimeout)

Description copied from interface: POBPlayer

Set stall timeout to handle Player buffering.

Specified by:

setStallTimeout in interface POBPlayer

Parameters:

stallTimeout - the timeout value in milliseconds.

start

public void start()

Description copied from interface: POBPlayer

Start current playback.

Specified by:

start in interface POBPlayer

pause

public void pause()

Description copied from interface: POBPlayer

Pauses current playback.

Specified by:

pause in interface POBPlayer

stop

public void stop()

Description copied from interface: POBPlayer

Stops playback after playback has been onStart or onPause.

Specified by:

stop in interface POBPlayer

setVolume

public void setVolume(int leftVolume,
                      int rightVolume)

Description copied from interface: POBPlayer

Set audio volume of Player

Specified by:

setVolume in interface POBPlayer

Parameters:

leftVolume - left volume

rightVolume - right volume

getDuration

public int getDuration()

Description copied from interface: POBPlayer

Gets the duration of the media.

Specified by:

getDuration in interface POBPlayer

Returns:

the duration in milliseconds, if no duration is available (for example, if streaming live content), -1 is returned.

getVideoWidth

public int getVideoWidth()

Description copied from interface: POBPlayer

Get video player width

Specified by:

getVideoWidth in interface POBPlayer

Returns:

video player width

getVideoHeight

public int getVideoHeight()

Description copied from interface: POBPlayer

Get video player height

Specified by:

getVideoHeight in interface POBPlayer

Returns:

video player height

destroy

public void destroy()

Description copied from interface: POBPlayer

Method to do resource cleanup

Specified by:

destroy in interface POBPlayer

onSurfaceCreated

public void onSurfaceCreated(@NonNull
                             android.view.Surface surface)

Description copied from interface: POBPlayer

Method to notify surface created

Specified by:

onSurfaceCreated in interface POBPlayer

Parameters:

surface - surface to render video

onSurfaceDestroyed

public void onSurfaceDestroyed(@NonNull
                               android.view.Surface surface)

Description copied from interface: POBPlayer

Method to notify surface destroyed

Specified by:

onSurfaceDestroyed in interface POBPlayer

Parameters:

surface - surface to render video

onVideoSizeChanged

public void onVideoSizeChanged(android.media.MediaPlayer mp,
                               int width,
                               int height)

Specified by:

onVideoSizeChanged in interface android.media.MediaPlayer.OnVideoSizeChangedListener

onBufferingUpdate

public void onBufferingUpdate(android.media.MediaPlayer mp,
                              int percent)

Called to update status in buffering a media stream received through progressive HTTP download. The received buffering percentage indicates how much of the content has been buffered or played. For example a buffering update of 80 percent when half the content has already been played indicates that the next 30 percent of the content to play has been buffered.

Specified by:

onBufferingUpdate in interface android.media.MediaPlayer.OnBufferingUpdateListener

Parameters:

mp - the MediaPlayer the update pertains to

percent - the percentage (0-100) of the content

onCompletion

public void onCompletion(android.media.MediaPlayer mp)

Called when the end of a media source is reached during playback.

Specified by:

onCompletion in interface android.media.MediaPlayer.OnCompletionListener

Parameters:

mp - the MediaPlayer that reached the end of the file

onError

public boolean onError(android.media.MediaPlayer mp,
                       int what,
                       int extra)

Specified by:

onError in interface android.media.MediaPlayer.OnErrorListener

onInfo

public boolean onInfo(android.media.MediaPlayer mp,
                      int what,
                      int extra)

Specified by:

onInfo in interface android.media.MediaPlayer.OnInfoListener

onPrepared

public void onPrepared(android.media.MediaPlayer mp)

Called when the media file is ready for playback.

Specified by:

onPrepared in interface android.media.MediaPlayer.OnPreparedListener

Parameters:

mp - the MediaPlayer that is ready for playback