Index

A B C D E F G H I J L M N O P R S T U V
All Classes and Interfaces|All Packages

A

activate(Context) - Static method in class com.iab.omid.library.Omid: Activate OM SDK prior to calling any other API methods.
addFriendlyObstruction(View, FriendlyObstructionPurpose, String) - Method in class com.iab.omid.library.adsession.AdSession: Add friendly obstruction which should then be excluded from all ad session viewability calculations.
addFriendlyObstruction(View, FriendlyObstructionPurpose, String) - Method in class com.iab.omid.library.adsession.JavaScriptSessionService: Add a friendly obstruction which should then be excluded from all ad session viewability calculations.
AdEvents - Class in com.iab.omid.library.adsession: Ad event API enabling the integration partner to signal to all verification providers when key events have occurred.
AdSession - Class in com.iab.omid.library.adsession: Ad session API enabling the integration partner to notify OM SDK of key state relating to viewability calculations.
AdSession() - Constructor for class com.iab.omid.library.adsession.AdSession
AdSessionConfiguration - Class in com.iab.omid.library.adsession: Created by pharris on 11/09/2017.
AdSessionContext - Class in com.iab.omid.library.adsession: This class will provide the ad session both details of the partner and whether this is considered HTML or native.
adUserInteraction(InteractionType) - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that the user has performed an ad interaction.
AUDIBLE - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: The integration is using audible criteria (2 continuous second of media playback with non-zero volume) for the OMID impression.
AUDIO - Enum constant in enum class com.iab.omid.library.adsession.CreativeType: Similar to video but only contains audio media.

B

BEGIN_TO_RENDER - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: The integration is using begin-to-render criteria for the OMID impression.
bufferFinish() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that buffering has finished and media playback has resumed.
bufferStart() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback has stopped and started buffering.

C

CLICK - Enum constant in enum class com.iab.omid.library.adsession.media.InteractionType: The user clicked to load the ad's landing page.
CLOSE_AD - Enum constant in enum class com.iab.omid.library.adsession.FriendlyObstructionPurpose: The friendly obstruction relates to closing an ad (such as a close button).
COLLAPSED - Enum constant in enum class com.iab.omid.library.adsession.media.PlayerState: The player has been reduced from its original size.
com.iab.omid.library - package com.iab.omid.library
com.iab.omid.library.adsession - package com.iab.omid.library.adsession
com.iab.omid.library.adsession.media - package com.iab.omid.library.adsession.media
complete() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback is complete.
create(Partner, WebView, boolean) - Static method in class com.iab.omid.library.adsession.JavaScriptSessionService: Create and initialize an instance of the JavaScriptSessionService.
createAdEvents(AdSession) - Static method in class com.iab.omid.library.adsession.AdEvents: Create ad events instance associated with the supplied ad session.
createAdSession(AdSessionConfiguration, AdSessionContext) - Static method in class com.iab.omid.library.adsession.AdSession: Create new ad session supplying the adSessionConfiguration and adSessionContext.
createAdSessionConfiguration(CreativeType, ImpressionType, Owner, Owner, boolean) - Static method in class com.iab.omid.library.adsession.AdSessionConfiguration: Create new ad session configuration supplying the owner for both the impression and media events along with the type of creative being rendered/measured The OM SDK JS service will use this information to help identify where the source of these events is expected to be received.
createHtmlAdSessionContext(Partner, WebView, String, String) - Static method in class com.iab.omid.library.adsession.AdSessionContext: Create a new "html" ad session context.
createJavascriptAdSessionContext(Partner, WebView, String, String) - Static method in class com.iab.omid.library.adsession.AdSessionContext: Create a new "javascript" ad session context.
createMediaEvents(AdSession) - Static method in class com.iab.omid.library.adsession.media.MediaEvents: Create media events instance for the associated ad session.
createNativeAdSessionContext(Partner, String, List<VerificationScriptResource>, String, String) - Static method in class com.iab.omid.library.adsession.AdSessionContext: Create a new "native" ad session context.
createPartner(String, String) - Static method in class com.iab.omid.library.adsession.Partner: Create new partner instance providing both name and version.
createVastPropertiesForNonSkippableMedia(boolean, Position) - Static method in class com.iab.omid.library.adsession.media.VastProperties: This method enables the media player to create a new VAST properties instance for non-skippable media ad placement.
createVastPropertiesForSkippableMedia(float, boolean, Position) - Static method in class com.iab.omid.library.adsession.media.VastProperties: This method enables the media player to create a new VAST properties instance for skippable media ad placement.
createVerificationScriptResourceWithoutParameters(URL) - Static method in class com.iab.omid.library.adsession.VerificationScriptResource: Create new verification script resource instance which does not require any vendor specific verification parameters.
createVerificationScriptResourceWithParameters(String, URL, String) - Static method in class com.iab.omid.library.adsession.VerificationScriptResource: Create new verification script resource instance which requires vendor specific verification parameters.
CreativeType - Enum Class in com.iab.omid.library.adsession: List of supported creative types.

D

DEFINED_BY_JAVASCRIPT - Enum constant in enum class com.iab.omid.library.adsession.CreativeType: Creative type will be set by JavaScript session script.
DEFINED_BY_JAVASCRIPT - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: Impression type will be set by JavaScript session script.

E

error(ErrorType, String) - Method in class com.iab.omid.library.adsession.AdSession: Notify all verification providers that an error has occurred on the ad session.
ErrorType - Enum Class in com.iab.omid.library.adsession: List of supported error types.
EXPANDED - Enum constant in enum class com.iab.omid.library.adsession.media.PlayerState: The player has expanded from its original size.

F

finish() - Method in class com.iab.omid.library.adsession.AdSession: Notify all verification providers that the ad session has finished and all ad view tracking will stop.
firstQuartile() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback has reached the first quartile.
FriendlyObstructionPurpose - Enum Class in com.iab.omid.library.adsession: List of allowed friendly obstruction purposes.
FULLSCREEN - Enum constant in enum class com.iab.omid.library.adsession.media.PlayerState: The player has entered fullscreen mode.

G

GENERIC - Enum constant in enum class com.iab.omid.library.adsession.ErrorType: The integration is publishing a "generic" error to verification scripts.
getAdSessionContextType() - Method in class com.iab.omid.library.adsession.AdSessionContext: For OM SDK internal use only.
getContentUrl() - Method in class com.iab.omid.library.adsession.AdSessionContext
getCustomReferenceData() - Method in class com.iab.omid.library.adsession.AdSessionContext
getInjectedResourcesMap() - Method in class com.iab.omid.library.adsession.AdSessionContext: For OM SDK internal use only.
getName() - Method in class com.iab.omid.library.adsession.Partner
getOmidJsScriptContent() - Method in class com.iab.omid.library.adsession.AdSessionContext
getPartner() - Method in class com.iab.omid.library.adsession.AdSessionContext
getPosition() - Method in class com.iab.omid.library.adsession.media.VastProperties: Gets the player position indicated by these properties.
getResourceUrl() - Method in class com.iab.omid.library.adsession.VerificationScriptResource
getSkipOffset() - Method in class com.iab.omid.library.adsession.media.VastProperties: Gets the skip offset (number of seconds after which media is skippable).
getVendorKey() - Method in class com.iab.omid.library.adsession.VerificationScriptResource
getVerificationParameters() - Method in class com.iab.omid.library.adsession.VerificationScriptResource
getVerificationScriptResources() - Method in class com.iab.omid.library.adsession.AdSessionContext
getVersion() - Method in class com.iab.omid.library.adsession.Partner
getVersion() - Static method in class com.iab.omid.library.Omid: Access the running OM SDK semantic version.
getWebView() - Method in class com.iab.omid.library.adsession.AdSessionContext

H

HTML_DISPLAY - Enum constant in enum class com.iab.omid.library.adsession.CreativeType: Rendered in webview, verification code can be inside creative or in metadata.

I

impressionOccurred() - Method in class com.iab.omid.library.adsession.AdEvents: Notify the ad session that an impression event has occurred.
ImpressionType - Enum Class in com.iab.omid.library.adsession: The criterion for an ad session's OMID impression event.
injectScriptContentIntoHtml(String, String) - Static method in class com.iab.omid.library.ScriptInjector: Injects the supplied OM SDK JS content into the served HTML.
InteractionType - Enum Class in com.iab.omid.library.adsession.media: List of supported media event user interaction types.
INVITATION_ACCEPTED - Enum constant in enum class com.iab.omid.library.adsession.media.InteractionType: The user engaged with ad content to load a separate experience.
isActive() - Static method in class com.iab.omid.library.Omid: Determine if the running OM SDK is active before attempting to create any ad sessions.
isAutoPlay() - Method in class com.iab.omid.library.adsession.media.VastProperties: Indicates if these properties are for an auto-play media or not.
isNativeImpressionOwner() - Method in class com.iab.omid.library.adsession.AdSessionConfiguration: For OM SDK internal use only.
isNativeMediaEventsOwner() - Method in class com.iab.omid.library.adsession.AdSessionConfiguration: For OM SDK internal use only.
isSkippable() - Method in class com.iab.omid.library.adsession.media.VastProperties: Indicates if these properties are for skippable or non-skippable media.

J

JAVASCRIPT - Enum constant in enum class com.iab.omid.library.adsession.Owner: The integration will send the event from a JavaScript session script.
JavaScriptSessionService - Class in com.iab.omid.library.adsession: Service supporting ad sessions managed (started/finished) via JavaScript Session Client APIs by providing native-layer measurement signals.
JavaScriptSessionService.TearDownHandler - Interface in com.iab.omid.library.adsession

L

loaded() - Method in class com.iab.omid.library.adsession.AdEvents: Notify the ad session that a display loaded event has occurred.
loaded(VastProperties) - Method in class com.iab.omid.library.adsession.AdEvents: Notify the ad session that a video/audio loaded event has occurred.
LOADED - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: The integration is using count-on-download criteria for the OMID impression.

M

MediaEvents - Class in com.iab.omid.library.adsession.media: This provides a complete list of native media events supported by OM SDK.
midpoint() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback has reached the midpoint.
MIDROLL - Enum constant in enum class com.iab.omid.library.adsession.media.Position: The ad plays in the middle of video content, or between two separate content videos.
MINIMIZED - Enum constant in enum class com.iab.omid.library.adsession.media.PlayerState: The player is collapsed in such a way that the video is hidden.

N

NATIVE - Enum constant in enum class com.iab.omid.library.adsession.Owner: The integration will send the event from the native layer.
NATIVE_DISPLAY - Enum constant in enum class com.iab.omid.library.adsession.CreativeType: Rendered by native, verification code provided in metadata only.
NONE - Enum constant in enum class com.iab.omid.library.adsession.Owner: The integration will not send the event.
NORMAL - Enum constant in enum class com.iab.omid.library.adsession.media.PlayerState: The player's default playback size.
NOT_VISIBLE - Enum constant in enum class com.iab.omid.library.adsession.FriendlyObstructionPurpose: The friendly obstruction is not visibly obstructing the ad but may seem so due to technical limitations.

O

Omid - Class in com.iab.omid.library: This application level class will be called by all integration partners to ensure OM SDK has
been activated before calling any other API methods.
ONE_PIXEL - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on screen) for the OMID impression.
onTearDown(boolean) - Method in interface com.iab.omid.library.adsession.JavaScriptSessionService.TearDownHandler
OTHER - Enum constant in enum class com.iab.omid.library.adsession.FriendlyObstructionPurpose: The friendly obstruction is obstructing for any purpose not already described.
OTHER - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: The integration's criteria uses none of the above criteria for the OMID impression.
Owner - Enum Class in com.iab.omid.library.adsession: Identifies which integration layer is responsible for sending certain events.

P

Partner - Class in com.iab.omid.library.adsession: Details about the integration partner which will be supplied to the ad session.
pause() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback has paused after a user interaction.
PlayerState - Enum Class in com.iab.omid.library.adsession.media: List of supported media event player states.
playerStateChange(PlayerState) - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media player state has changed.
Position - Enum Class in com.iab.omid.library.adsession.media: List of supported media player positions.
POSTROLL - Enum constant in enum class com.iab.omid.library.adsession.media.Position: The ad plays following video content.
PREROLL - Enum constant in enum class com.iab.omid.library.adsession.media.Position: The ad plays preceding video content.

R

registerAdView(View) - Method in class com.iab.omid.library.adsession.AdSession: Register ad view to be used for tracking viewability.
removeAllFriendlyObstructions() - Method in class com.iab.omid.library.adsession.AdSession: Utility method to remove all registered friendly obstructions.
removeAllFriendlyObstructions() - Method in class com.iab.omid.library.adsession.JavaScriptSessionService: Remove all registered friendly obstructions from any currently running and future ad sessions measured by this instance of JavaScriptSessionService.
removeFriendlyObstruction(View) - Method in class com.iab.omid.library.adsession.AdSession: Remove registered friendly obstruction.
removeFriendlyObstruction(View) - Method in class com.iab.omid.library.adsession.JavaScriptSessionService: Remove a registered friendly obstruction from any currently running and future ad sessions measured by this instance of JavaScriptSessionService.
resume() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback has resumed (after being paused) after a user interaction.

S

ScriptInjector - Class in com.iab.omid.library: Utility class which enables integration partners to use a standard approach for injecting OM SDK JS into the served tag HTML content.
setAdView(View) - Method in class com.iab.omid.library.adsession.JavaScriptSessionService: Sets the native view that contains the ad and is used for viewability tracking.
setPossibleObstructionListener(PossibleObstructionListener) - Method in class com.iab.omid.library.adsession.AdSession: For debugging purposes only.
skipped() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback has stopped as a user skip interaction.
STANDALONE - Enum constant in enum class com.iab.omid.library.adsession.media.Position: The ad plays independently of any video content.
start() - Method in class com.iab.omid.library.adsession.AdSession: Notify all verification providers that the ad session has started and ad view tracking will begin.
start(float, float) - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media content has started playing.

T

tearDown(JavaScriptSessionService.TearDownHandler) - Method in class com.iab.omid.library.adsession.JavaScriptSessionService: Tear down this instance of the service.
thirdQuartile() - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that media playback has reached the third quartile.
toJSON() - Method in class com.iab.omid.library.adsession.media.VastProperties: For OM SDK internal use only.
toJsonObject() - Method in class com.iab.omid.library.adsession.AdSessionConfiguration: For OM SDK internal use only.
toJsonObject() - Method in class com.iab.omid.library.adsession.VerificationScriptResource: For OM SDK internal use only.
toString() - Method in enum class com.iab.omid.library.adsession.CreativeType
toString() - Method in enum class com.iab.omid.library.adsession.ErrorType
toString() - Method in enum class com.iab.omid.library.adsession.ImpressionType
toString() - Method in enum class com.iab.omid.library.adsession.media.InteractionType
toString() - Method in enum class com.iab.omid.library.adsession.media.PlayerState
toString() - Method in enum class com.iab.omid.library.adsession.media.Position
toString() - Method in enum class com.iab.omid.library.adsession.Owner

U

UNSPECIFIED - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: The integration is not declaring the criteria for the OMID impression.
updateLastActivity() - Static method in class com.iab.omid.library.Omid: Notify OM SDK to update last activity time when users interact on CTV devices.

V

valueOf(String) - Static method in enum class com.iab.omid.library.adsession.CreativeType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.iab.omid.library.adsession.ErrorType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.iab.omid.library.adsession.FriendlyObstructionPurpose: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.iab.omid.library.adsession.ImpressionType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.iab.omid.library.adsession.media.InteractionType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.iab.omid.library.adsession.media.PlayerState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.iab.omid.library.adsession.media.Position: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.iab.omid.library.adsession.Owner: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.iab.omid.library.adsession.CreativeType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.iab.omid.library.adsession.ErrorType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.iab.omid.library.adsession.FriendlyObstructionPurpose: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.iab.omid.library.adsession.ImpressionType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.iab.omid.library.adsession.media.InteractionType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.iab.omid.library.adsession.media.PlayerState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.iab.omid.library.adsession.media.Position: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.iab.omid.library.adsession.Owner: Returns an array containing the constants of this enum class, in the order they are declared.
VastProperties - Class in com.iab.omid.library.adsession.media: This object is used to capture key VAST properties so this can be shared with all registered verification providers.
VerificationScriptResource - Class in com.iab.omid.library.adsession: Details about the verification provider which will be supplied to the ad session.
VIDEO - Enum constant in enum class com.iab.omid.library.adsession.CreativeType: Rendered instream or as standalone video, verification code provided in metadata.
VIDEO - Enum constant in enum class com.iab.omid.library.adsession.ErrorType: The integration is publishing a "video" error to verification scripts.
VIDEO_CONTROLS - Enum constant in enum class com.iab.omid.library.adsession.FriendlyObstructionPurpose: The friendly obstruction relates to interacting with a video (such as play/pause buttons).
VIEWABLE - Enum constant in enum class com.iab.omid.library.adsession.ImpressionType: The integration is using viewable criteria (1 second for display, 2 seconds while playing for video, and at least 50% of the creative is visible) for the OMID impression.
volumeChange(float) - Method in class com.iab.omid.library.adsession.media.MediaEvents: Notify all media listeners that the media player volume has changed.

A B C D E F G H I J L M N O P R S T U V
All Classes and Interfaces|All Packages