Index

A B C E F G I 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.
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.

B

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

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.
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, String, String) - Static method in class com.iab.omid.library.adsession.AdSessionContext: Create a new "native" ad session context.
createNativeAdSessionContext(Partner, String, List, String, String, UniversalAdId) - 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.

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.
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.
FULLSCREEN - Enum constant in enum class com.iab.omid.library.adsession.media.PlayerState: The player has entered fullscreen mode.

G

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).
getUniversalAdId() - Method in class com.iab.omid.library.adsession.AdSessionContext
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

I

impressionOccurred() - Method in class com.iab.omid.library.adsession.AdEvents: Notify the ad session that an impression event has occurred.
injectScriptContentIntoHtml(String, String) - Static method in class com.iab.omid.library.ScriptInjector: Injects the supplied OM SDK JS content into the served HTML.
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.

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.

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

NORMAL - Enum constant in enum class com.iab.omid.library.adsession.media.PlayerState: The player's default playback size.

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.

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.
removeFriendlyObstruction(View) - Method in class com.iab.omid.library.adsession.AdSession: Remove registered friendly obstruction.
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.
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

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.media.PlayerState
toString() - Method in enum class com.iab.omid.library.adsession.media.Position

U

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.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.
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.
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.
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 E F G I L M N O P R S T U V
All Classes and Interfaces|All Packages