Package org.prebid.mobile.rendering.video

Class VideoCreative

java.lang.Object

org.prebid.mobile.rendering.models.AbstractCreative

org.prebid.mobile.rendering.video.VideoCreativeProtocol

org.prebid.mobile.rendering.video.VideoCreative

All Implemented Interfaces:

InterstitialManagerVideoDelegate, VideoCreativeViewListener, VASTInterface

Direct Known Subclasses:

RewardedVideoCreative

public class VideoCreative
extends VideoCreativeProtocol
implements VideoCreativeViewListener, InterstitialManagerVideoDelegate

Field Summary

Fields inherited from class org.prebid.mobile.rendering.models.AbstractCreative

contextReference, creativeVisibilityTracker, interstitialManager, weakOmAdSessionManager

Constructor Summary

Constructors

Constructor	Description
VideoCreative(android.content.Context context, VideoCreativeModel model, OmAdSessionManager omAdSessionManager, InterstitialManager interstitialManager)

Method Summary

Modifier and Type	Method	Description
protected void	complete()
void	createOmAdSession()	Create OM session for specific creative.
void	destroy()	Specific creative cleanup.
void	display()	Specific creative display.
VideoCreativeModel	getCreativeModel()
long	getMediaDuration()
long	getVideoSkipOffset()
void	handleAdWindowFocus()	Executed when window gains focus (e.g. when app is resumed from background) Used by AdViewManager to handle refresh on view visibility change
void	handleAdWindowNoFocus()	Executed when window loses focus (e.g. when app is going in background).
boolean	isDisplay()
boolean	isEndCard()
boolean	isInterstitialClosed()
boolean	isPlaying()
boolean	isResolved()
boolean	isVideo()
void	load()	Specific creative load.
void	mute()	Mute creative
void	onDisplayCompleted()
void	onEvent(VideoAdEvent.Event trackingEvent)
void	onFailure(AdException error)
void	onPlayerStateChanged(InternalPlayerState state)
void	onReadyForDisplay()
void	onVideoInterstitialClosed()
void	onVolumeChanged(float volume)
void	pause()	Pause creative execution
void	resume()	Resume creative execution
protected void	showCallToAction()
void	skip()	the user activated a skip control to skip the creative, which is a different control than the one used to close the creative.
void	startViewabilityTracker()
void	trackAdLoaded()	Executed after processing transaction and creating OmAdSession in AdViewManager
void	trackVideoEvent(VideoAdEvent.Event event)	VideoAdEvent.Event to track
void	unmute()	UnMute creative

Methods inherited from class org.prebid.mobile.rendering.video.VideoCreativeProtocol

close, closeLinear, collapse, exitFullScreen, expand, fullScreen, onWindowFocusChanged, orientationChanged, rewind, touch

Methods inherited from class org.prebid.mobile.rendering.models.AbstractCreative

addOmFriendlyObstruction, changeVisibilityTrackerState, getCreativeView, getCreativeViewListener, getResolutionListener, isBuiltInVideo, setCreativeView, setCreativeViewListener, setResolutionListener, startOmSession, trackVideoStateChange, updateAdView

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoCreative

public VideoCreative(android.content.Context context,
                     VideoCreativeModel model,
                     OmAdSessionManager omAdSessionManager,
                     InterstitialManager interstitialManager)
              throws AdException

Throws:

AdException

Method Detail

load

public void load()

Description copied from class: AbstractCreative

Specific creative load.

Specified by:

load in class AbstractCreative

display

public void display()

Description copied from class: AbstractCreative

Specific creative display.

Overrides:

display in class VideoCreativeProtocol

skip

public void skip()

Description copied from interface: VASTInterface

the user activated a skip control to skip the creative, which is a different control than the one used to close the creative.

Specified by:

skip in interface VASTInterface

Overrides:

skip in class VideoCreativeProtocol

onReadyForDisplay

public void onReadyForDisplay()

Specified by:

onReadyForDisplay in interface VideoCreativeViewListener

onDisplayCompleted

public void onDisplayCompleted()

Specified by:

onDisplayCompleted in interface VideoCreativeViewListener

onFailure

public void onFailure(AdException error)

Specified by:

onFailure in interface VideoCreativeViewListener

onEvent

public void onEvent(VideoAdEvent.Event trackingEvent)

Specified by:

onEvent in interface VideoCreativeViewListener

trackAdLoaded

public void trackAdLoaded()

Description copied from class: AbstractCreative

Executed after processing transaction and creating OmAdSession in AdViewManager

Specified by:

trackAdLoaded in class AbstractCreative

onVolumeChanged

public void onVolumeChanged(float volume)

Specified by:

onVolumeChanged in interface VideoCreativeViewListener

onPlayerStateChanged

public void onPlayerStateChanged(InternalPlayerState state)

Specified by:

onPlayerStateChanged in interface VideoCreativeViewListener

isInterstitialClosed

public boolean isInterstitialClosed()

Overrides:

isInterstitialClosed in class AbstractCreative

Returns:

if current creative is serving as interstitial that was closed

getMediaDuration

public long getMediaDuration()

Overrides:

getMediaDuration in class AbstractCreative

Returns:

media duration in ms

handleAdWindowFocus

public void handleAdWindowFocus()

Description copied from class: AbstractCreative

Executed when window gains focus (e.g. when app is resumed from background) Used by AdViewManager to handle refresh on view visibility change

Specified by:

handleAdWindowFocus in class AbstractCreative

resume

public void resume()

Description copied from class: AbstractCreative

Resume creative execution

Specified by:

resume in interface VASTInterface

Overrides:

resume in class VideoCreativeProtocol

isPlaying

public boolean isPlaying()

Overrides:

isPlaying in class AbstractCreative

Returns:

Whether the creative is playing

handleAdWindowNoFocus

public void handleAdWindowNoFocus()

Description copied from class: AbstractCreative

Executed when window loses focus (e.g. when app is going in background). Used by AdViewManager to handle refresh on view visibility change

Specified by:

handleAdWindowNoFocus in class AbstractCreative

pause

public void pause()

Description copied from class: AbstractCreative

Pause creative execution

Specified by:

pause in interface VASTInterface

Overrides:

pause in class VideoCreativeProtocol

mute

public void mute()

Description copied from class: AbstractCreative

Mute creative

Specified by:

mute in interface VASTInterface

Overrides:

mute in class VideoCreativeProtocol

unmute

public void unmute()

Description copied from class: AbstractCreative

UnMute creative

Specified by:

unmute in interface VASTInterface

Overrides:

unmute in class VideoCreativeProtocol

createOmAdSession

public void createOmAdSession()

Description copied from class: AbstractCreative

Create OM session for specific creative. Each creative must create appropriate OM AdSession (e.g. for HTML and Native)

Specified by:

createOmAdSession in class AbstractCreative

startViewabilityTracker

public void startViewabilityTracker()

Specified by:

startViewabilityTracker in class AbstractCreative

destroy

public void destroy()

Description copied from class: AbstractCreative

Specific creative cleanup. Creative must cleanup it's internal state.

Overrides:

destroy in class AbstractCreative

isDisplay

public boolean isDisplay()

Specified by:

isDisplay in class AbstractCreative

isVideo

public boolean isVideo()

Specified by:

isVideo in class AbstractCreative

isResolved

public boolean isResolved()

Specified by:

isResolved in class AbstractCreative

Returns:

true if preloadedVideoFilePath is not empty and file exists in filesDir, false otherwise.

isEndCard

public boolean isEndCard()

Specified by:

isEndCard in class AbstractCreative

onVideoInterstitialClosed

public void onVideoInterstitialClosed()

Specified by:

onVideoInterstitialClosed in interface InterstitialManagerVideoDelegate

getVideoSkipOffset

public long getVideoSkipOffset()

Overrides:

getVideoSkipOffset in class AbstractCreative

Returns:

video skip offset in ms

trackVideoEvent

public void trackVideoEvent(VideoAdEvent.Event event)

Description copied from class: AbstractCreative

VideoAdEvent.Event to track

Overrides:

trackVideoEvent in class AbstractCreative

getCreativeModel

public VideoCreativeModel getCreativeModel()

Overrides:

getCreativeModel in class AbstractCreative

Returns:

CreativeModel which can be used to track events or to access specific creative ad configuration.

complete

protected void complete()

showCallToAction

protected void showCallToAction()