Package org.prebid.mobile.rendering.video

Class VideoCreativeProtocol

java.lang.Object

org.prebid.mobile.rendering.models.AbstractCreative

org.prebid.mobile.rendering.video.VideoCreativeProtocol

All Implemented Interfaces:

VASTInterface

Direct Known Subclasses:

VideoCreative

public abstract class VideoCreativeProtocol
extends AbstractCreative
implements VASTInterface

Field Summary

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

contextReference, creativeVisibilityTracker, interstitialManager, weakOmAdSessionManager

Constructor Summary

Constructors

Constructor	Description
VideoCreativeProtocol(android.content.Context context, CreativeModel model, OmAdSessionManager omAdSessionManager, InterstitialManager interstitialManager)

Method Summary

Modifier and Type	Method	Description
void	close()	the user clicked the close button on the creative.
void	closeLinear()	the user clicked the close button on the creative.
void	collapse()	the user activated a control to reduce the creative to its original dimensions.
void	display()	Specific creative display.
void	exitFullScreen()	the user activated the control to reduce video player size to original dimensions.
void	expand()	Per IAB: the user activated a control to expand the creative.
void	fullScreen()	Per IAB: the user activated a control to extend the video player to the edges of the viewer’s screen.
void	mute()	Mute creative
void	onWindowFocusChanged(boolean hasFocus)	the user made a window focus change, such as leaving the activity, pressing back, invoking Recents, or returning from one of these states back to the video player.
void	orientationChanged(int orientation)	the user made an orientation change by rotating the device.
void	pause()	Pause creative execution
void	resume()	Resume creative execution
void	rewind()	the user activated the rewind control to access a previous point in the creative timeline.
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	touch()	the user simply touched the video player in a non-specific region of the player (touched an empty area of the video, not a widget or button).
void	unmute()	UnMute creative

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

addOmFriendlyObstruction, changeVisibilityTrackerState, createOmAdSession, destroy, getCreativeModel, getCreativeView, getCreativeViewListener, getMediaDuration, getResolutionListener, getVideoSkipOffset, handleAdWindowFocus, handleAdWindowNoFocus, isBuiltInVideo, isDisplay, isEndCard, isInterstitialClosed, isPlaying, isResolved, isVideo, load, setCreativeView, setCreativeViewListener, setResolutionListener, startOmSession, startViewabilityTracker, trackAdLoaded, trackVideoEvent, trackVideoStateChange, updateAdView

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoCreativeProtocol

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

Throws:

AdException

Method Detail

display

public void display()

Description copied from class: AbstractCreative

Specific creative display.

Specified by:

display 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 AbstractCreative

pause

public void pause()

Description copied from class: AbstractCreative

Pause creative execution

Specified by:

pause in interface VASTInterface

Overrides:

pause in class AbstractCreative

expand

public void expand()

Description copied from interface: VASTInterface

Per IAB: the user activated a control to expand the creative.

Specified by:

expand in interface VASTInterface

fullScreen

public void fullScreen()

Description copied from interface: VASTInterface

Per IAB: the user activated a control to extend the video player to the edges of the viewer’s screen.

Specified by:

fullScreen in interface VASTInterface

collapse

public void collapse()

Description copied from interface: VASTInterface

the user activated a control to reduce the creative to its original dimensions.

Specified by:

collapse in interface VASTInterface

exitFullScreen

public void exitFullScreen()

Description copied from interface: VASTInterface

the user activated the control to reduce video player size to original dimensions.

Specified by:

exitFullScreen in interface VASTInterface

mute

public void mute()

Description copied from class: AbstractCreative

Mute creative

Specified by:

mute in interface VASTInterface

Overrides:

mute in class AbstractCreative

unmute

public void unmute()

Description copied from class: AbstractCreative

UnMute creative

Specified by:

unmute in interface VASTInterface

Overrides:

unmute in class AbstractCreative

close

public void close()

Description copied from interface: VASTInterface

the user clicked the close button on the creative.

Specified by:

close in interface VASTInterface

closeLinear

public void closeLinear()

Description copied from interface: VASTInterface

the user clicked the close button on the creative. The name of this event distinguishes it from the existing “close” event described in the 2008 IAB Digital Video In-Stream Ad Metrics Definitions, which defines the “close” metric as applying to non-linear ads only. The “closeLinear” event extends the “close” event for use in Linear creative.

Specified by:

closeLinear in interface VASTInterface

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

rewind

public void rewind()

Description copied from interface: VASTInterface

the user activated the rewind control to access a previous point in the creative timeline.

Specified by:

rewind in interface VASTInterface

touch

public void touch()

Description copied from interface: VASTInterface

the user simply touched the video player in a non-specific region of the player (touched an empty area of the video, not a widget or button).

Specified by:

touch in interface VASTInterface

orientationChanged

public void orientationChanged(int orientation)

Description copied from interface: VASTInterface

the user made an orientation change by rotating the device. The orientation of Configuration.ORIENTATION_LANDSCAPE or Configuration.ORIENTATION_PORTRAIT is passed in.

Specified by:

orientationChanged in interface VASTInterface

onWindowFocusChanged

public void onWindowFocusChanged(boolean hasFocus)

Description copied from interface: VASTInterface

the user made a window focus change, such as leaving the activity, pressing back, invoking Recents, or returning from one of these states back to the video player. This will allow for internal threads to pause and resume correctly.

Specified by:

onWindowFocusChanged in interface VASTInterface