com.pubmatic.sdk.video.player

Interface POBVideoPlayer

All Known Implementing Classes:

POBVideoPlayerView

public interface POBVideoPlayer

Protocol, provides methods for basic functionality and events of video player like play,pause,etc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	POBVideoPlayer.SupportedMediaType Enum for mime types supported by POBVideoPlayerView
static class	POBVideoPlayer.VideoPlayerState States of Video player

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_STALLING_TIMEOUT Timeout in milliseconds for maximum stall duration for buffering.
static int	MEDIA_FILE_TIMEOUT_ERROR This error code is for timeout while loading the media playing
static int	RUNTIME_ERROR This error code is referred as any runtime error after playback started
static POBVideoPlayer.SupportedMediaType[]	SUPPORTED_MEDIA_TYPE List of supported media types by MediaPlayer

Method Summary

Modifier and Type	Method and Description
void	destroy() Method to do resource cleanup
POBPlayerController	getControllerView() Returns the player controller view instance
int	getMediaDuration() Gets the duration of the media.
POBVideoPlayer.VideoPlayerState	getPlayerState()
boolean	isMute() Gets audio mute status
void	load(java.lang.String uri) Loads the video content for given Uri
void	mute() Mute audio of VideoPlayer
void	pause() Pauses current playback.
void	play() Signals Video player to begin playback.
void	playOnMute(boolean mute) Set playOnMute to handle video playback with mute/unmute.
void	setAutoPlayOnForeground(boolean autoPlayOnForeground) Property to auto-play the video when comes in background
void	setControllerView(POBPlayerController videoPlayerControl, android.widget.FrameLayout.LayoutParams layoutParams) Register to controller view to add controller view on Video Player with layoutParams properties
void	setListener(POBVideoPlayerView.POBVideoPlayerListener listener) Register listener to get Video Player callbacks
void	setPrepareTimeout(int timeout) Set prepare timeout to handle MediaPlayer url loading.
void	stop() Stops playback after playback has been onStart or onPause.
void	unMute() Un-mute audio of VideoPlayer if already muted

Field Detail

MAX_STALLING_TIMEOUT

static final int MAX_STALLING_TIMEOUT

Timeout in milliseconds for maximum stall duration for buffering.

See Also:

Constant Field Values

MEDIA_FILE_TIMEOUT_ERROR

static final int MEDIA_FILE_TIMEOUT_ERROR

This error code is for timeout while loading the media playing

See Also:

Constant Field Values

RUNTIME_ERROR

static final int RUNTIME_ERROR

This error code is referred as any runtime error after playback started

See Also:

Constant Field Values

SUPPORTED_MEDIA_TYPE

static final POBVideoPlayer.SupportedMediaType[] SUPPORTED_MEDIA_TYPE

List of supported media types by MediaPlayer

Method Detail

load

void load(@NonNull
          java.lang.String uri)

Loads the video content for given Uri

Parameters:

uri - the Uri from which to get the video content or data source

play

void play()

Signals Video player to begin playback. Before calling this method, call load See load(String).

pause

void pause()

Pauses current playback.

setListener

void setListener(@NonNull
                 POBVideoPlayerView.POBVideoPlayerListener listener)

Register listener to get Video Player callbacks

Parameters:

listener - reference of POBVideoPlayerView.POBVideoPlayerListener, see POBVideoPlayerView.POBVideoPlayerListener

getControllerView

@Nullable
POBPlayerController getControllerView()

Returns the player controller view instance

Returns:

POBPlayerController instance

setControllerView

void setControllerView(@NonNull
                       POBPlayerController videoPlayerControl,
                       @NonNull
                       android.widget.FrameLayout.LayoutParams layoutParams)

Register to controller view to add controller view on Video Player with layoutParams properties

Parameters:

videoPlayerControl - reference of POBVideoPlayerListener

layoutParams - layout params properties

stop

void stop()

Stops playback after playback has been onStart or onPause.

mute

void mute()

Mute audio of VideoPlayer

unMute

void unMute()

Un-mute audio of VideoPlayer if already muted

isMute

boolean isMute()

Gets audio mute status

Returns:

true if audio is Mute else return false

getMediaDuration

int getMediaDuration()

Gets the duration of the media.

Returns:

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

setAutoPlayOnForeground

void setAutoPlayOnForeground(boolean autoPlayOnForeground)

Property to auto-play the video when comes in background

Parameters:

autoPlayOnForeground - boolean value

destroy

void destroy()

Method to do resource cleanup

setPrepareTimeout

void setPrepareTimeout(int timeout)

Set prepare timeout to handle MediaPlayer url loading. Only reflect if set before load method. See load(String)

Parameters:

timeout - the timeout value in milliseconds.

playOnMute

void playOnMute(boolean mute)

Set playOnMute to handle video playback with mute/unmute. If set to true playback starts with mute, else playback starts with unmute or sound-on. Only reflect if set before play method. See play()

Parameters:

mute - the mute value on boolean

getPlayerState

@NonNull
POBVideoPlayer.VideoPlayerState getPlayerState()