Display SDK/com.smartadserver.android.library.model/SASNativeVideoAdElement

SASNativeVideoAdElement

open class SASNativeVideoAdElement : SASAdElement

This class represents a native video ad element

Constructors

constructor()

Default constructor

constructor(@NonNull nativeVideoJSON: JSONObject, timeout: Long, @Nullable remoteLoggerManager: SASRemoteLoggerManager)

Constructs a SASNativeVideoAdElement from the specified JSONObject

Properties

AUDIO_MODE_AUTO

val AUDIO_MODE_AUTO: Int = 1

AUDIO_MODE_MUTE

val AUDIO_MODE_MUTE: Int = 0

AUDIO_MODE_ON

val AUDIO_MODE_ON: Int = 2

BACKGROUND_RESIZE_100_PERCENT

val BACKGROUND_RESIZE_100_PERCENT: Int = 2

BACKGROUND_RESIZE_CONTAIN

val BACKGROUND_RESIZE_CONTAIN: Int = 1

BACKGROUND_RESIZE_COVER

val BACKGROUND_RESIZE_COVER: Int = 0

CALL_TO_ACTION_TYPE_APPLICATION

val CALL_TO_ACTION_TYPE_APPLICATION: Int = 2

CALL_TO_ACTION_TYPE_CUSTOM

val CALL_TO_ACTION_TYPE_CUSTOM: Int = 3

CALL_TO_ACTION_TYPE_VIDEO

val CALL_TO_ACTION_TYPE_VIDEO: Int = 1

CALL_TO_ACTION_TYPE_WEBSITE

val CALL_TO_ACTION_TYPE_WEBSITE: Int = 0

REDIRECT_ON_FIRST_CLICK

val REDIRECT_ON_FIRST_CLICK: String = "redirectOnFirstClick"

SECURED_TRANSACTION_TOKEN

val SECURED_TRANSACTION_TOKEN: String = "securedTransactionToken"

selectedMediaFile

@get:Nullable

open val selectedMediaFile: SCSVastMediaFile

SKIP_POLICY_ALWAYS

val SKIP_POLICY_ALWAYS: Int = 0

SKIP_POLICY_NEVER

val SKIP_POLICY_NEVER: Int = 1

SKIP_POLICY_VAST_CONTROLLED

val SKIP_POLICY_VAST_CONTROLLED: Int = 2

TRACKING_EVENT_NAME_CLICK

val TRACKING_EVENT_NAME_CLICK: String = "click"

TRACKING_EVENT_NAME_COMPLETE

val TRACKING_EVENT_NAME_COMPLETE: String = "complete"

TRACKING_EVENT_NAME_CREATIVE_VIEW

val TRACKING_EVENT_NAME_CREATIVE_VIEW: String = "creativeView"

TRACKING_EVENT_NAME_EXIT_FULLSCREEN

val TRACKING_EVENT_NAME_EXIT_FULLSCREEN: String = "exitFullscreen"

TRACKING_EVENT_NAME_FIRST_QUARTILE

val TRACKING_EVENT_NAME_FIRST_QUARTILE: String = "firstQuartile"

TRACKING_EVENT_NAME_FULLSCREEN

val TRACKING_EVENT_NAME_FULLSCREEN: String = "fullscreen"

TRACKING_EVENT_NAME_LOADED

val TRACKING_EVENT_NAME_LOADED: String = "loaded"

TRACKING_EVENT_NAME_MIDPOINT

val TRACKING_EVENT_NAME_MIDPOINT: String = "midpoint"

TRACKING_EVENT_NAME_MUTE

val TRACKING_EVENT_NAME_MUTE: String = "mute"

TRACKING_EVENT_NAME_PAUSE

val TRACKING_EVENT_NAME_PAUSE: String = "pause"

TRACKING_EVENT_NAME_PLAYER_COLLAPSE

val TRACKING_EVENT_NAME_PLAYER_COLLAPSE: String = "playerCollapse"

TRACKING_EVENT_NAME_PLAYER_EXPAND

val TRACKING_EVENT_NAME_PLAYER_EXPAND: String = "playerExpand"

TRACKING_EVENT_NAME_PROGRESS

val TRACKING_EVENT_NAME_PROGRESS: String = "progress"

TRACKING_EVENT_NAME_RESUME

val TRACKING_EVENT_NAME_RESUME: String = "resume"

TRACKING_EVENT_NAME_REWIND

val TRACKING_EVENT_NAME_REWIND: String = "rewind"

TRACKING_EVENT_NAME_SKIP

val TRACKING_EVENT_NAME_SKIP: String = "skip"

TRACKING_EVENT_NAME_START

val TRACKING_EVENT_NAME_START: String = "start"

TRACKING_EVENT_NAME_THIRD_QUARTILE

val TRACKING_EVENT_NAME_THIRD_QUARTILE: String = "thirdQuartile"

TRACKING_EVENT_NAME_TIME_TO_CLICK

val TRACKING_EVENT_NAME_TIME_TO_CLICK: String = "timeToClick"

TRACKING_EVENT_NAME_UNMUTE

val TRACKING_EVENT_NAME_UNMUTE: String = "unmute"

TRACKING_EVENT_NAMES

val TRACKING_EVENT_NAMES: Array<String>

VAST_COMPANION_AS_BACKGROUND

val VAST_COMPANION_AS_BACKGROUND: String = "companionBackground"

VIDEO_POSITION_BOTTOM

val VIDEO_POSITION_BOTTOM: Int = 2

VIDEO_POSITION_CENTER

val VIDEO_POSITION_CENTER: Int = 1

VIDEO_POSITION_TOP

val VIDEO_POSITION_TOP: Int = 0

VIDEO_REWARD

val VIDEO_REWARD: String = "reward"

VIDEO_REWARD_AMOUNT

val VIDEO_REWARD_AMOUNT: String = "amount"

VIDEO_REWARD_CURRENCY

val VIDEO_REWARD_CURRENCY: String = "currency"

Functions

getAdParameters

@Nullable

open fun getAdParameters(): String

Returns the AdParameters string of the VAST Ad of this SASNativeVideoAdElement

getAdVerifications

@Nullable

open fun getAdVerifications(): ArrayList<SCSVastAdVerification>

Returns a list of ad verification scripts

getAudioMode

open fun getAudioMode(): Int

Gets the audio mode policy when playing the video ad

getBackgroundClickTrackingUrl

@Nullable

open fun getBackgroundClickTrackingUrl(): String

Returns the companion click tracking url if available

getBackgroundClickUrl

@Nullable

open fun getBackgroundClickUrl(): String

Returns the companion click url if available

getBackgroundColor

open fun getBackgroundColor(): Int

Gets the background color of the video layer

getBackgroundImageUrl

@Nullable

open fun getBackgroundImageUrl(): String

Gets the URL of the background image to use for the video.

getBackgroundResizeMode

open fun getBackgroundResizeMode(): Int

Gets the resize policy for the background image

getBlurDownScaleFactorHighEnd

open fun getBlurDownScaleFactorHighEnd(): Int

Returns the downscale factor when computing blurred background image for high end devices

getBlurDownScaleFactorLowEnd

open fun getBlurDownScaleFactorLowEnd(): Int

Returns the downscale factor when computing blurred background image for low end devices

getBlurRadius

open fun getBlurRadius(): Int

Returns the blur radius parameter used for the dynamic background

getCallToActionCustomText

@Nullable

open fun getCallToActionCustomText(): String

Returns the custom text for call to action of this SASNativeVideoAdElement

getCallToActionType

open fun getCallToActionType(): Int

Returns the type of the click URL, either a website, a video, or an application

getCompanionImpressionUrl

@Nullable

open fun getCompanionImpressionUrl(): String

Returns the background impression url if available

getDebugInfo

@NonNull

open fun getDebugInfo(): String

Overriden to add extra info

getEventTrackingURL

@Nullable

open fun getEventTrackingURL(@Nullable eventName: String): Array<String>

Returns the tracking URLs for a given event

getHtmlLayerAdElement

@Nullable

open fun getHtmlLayerAdElement(): SASAdElement

Returns the post video html ad if any

getMediaDuration

open fun getMediaDuration(): Int

Returns the media duration.

getMediaHeight

open fun getMediaHeight(): Int

Returns the height of the current media, or -1 if not available

getMediaWidth

open fun getMediaWidth(): Int

Returns the width of the current media, or -1 if not available

getPosterImageOffsetPosition

@Nullable

open fun getPosterImageOffsetPosition(): String

Returns the time within the video where to extract a frame to use as a poster image.

getPosterImageUrl

@Nullable

open fun getPosterImageUrl(): String

Returns the URL of the poster image to use for the video.

getProgressOffset

@Nullable

open fun getProgressOffset(): String

Returns the String representing the time offset from the beginning of the video when the progress tracking URL must be fired.

getReward

@Nullable

open fun getReward(): SASReward

Returns the reward for this native video if available

getSkipOffset

@Nullable

open fun getSkipOffset(): String

getSkipPolicy

open fun getSkipPolicy(): Int

Returns the skip button policy

getTintColor

open fun getTintColor(): Int

Returns the Color of the tint layer

getTintOpacity

open fun getTintOpacity(): Int

Returns the opacity (between 0 and 100, 100 being fully opaque) of the tint layer

getVASTLoadingTime

open fun getVASTLoadingTime(): Long

Returns the VASTLoadingTime, or -1 if no VAST downloaded.

getVideoDebugInfo

@NonNull

open fun getVideoDebugInfo(): String

debug string continaing info pertaining to this video

getVideoTrackingEventList

@NonNull

open fun getVideoTrackingEventList(videoDuration: Long): ArrayList<SCSTrackingEvent>

Create an ArrayList of SASVideoTrackingEvent (as SCSTrackingEvent) based on mEventTrackingURLMap.

getVideoUrl

@Nullable

open fun getVideoUrl(): String

Returns the URL of the video of this SASNativeVideoAdElement

getVideoVerticalPosition

open fun getVideoVerticalPosition(): Int

Gets the video vertical position

getVPAIDUrl

@Nullable

open fun getVPAIDUrl(): String

Returns the URL of the VPAID Ad of this SASNativeVideoAdElement

isAutoclose

open fun isAutoclose(): Boolean

Returns whether the ad should close when video ends

isAutoplay

open fun isAutoplay(): Boolean

Returns whether the video should start playing as soon as it is ready to play.

isRedirectsOnFirstClickEnabled

open fun isRedirectsOnFirstClickEnabled(): Boolean

Returns whether this video redirects on first click in Video-Read format

isRestartWhenEnteringFullscreen

open fun isRestartWhenEnteringFullscreen(): Boolean

Returns whether the video should restart from the beginning when entering fullscreen for the first time.

isStickToTopEnabled

open fun isStickToTopEnabled(): Boolean

Returns whether this video can enter into stick on top mode (i.e.

isStickToTopSkippable

open fun isStickToTopSkippable(): Boolean

Returns whether the stick to top mode can be dismissed (when the video is in this mode)

isUninterruptedPlayback

open fun isUninterruptedPlayback(): Boolean

Returns whether the video will plackback till its end no matter the viewability of the ad

isVideo360Mode

open fun isVideo360Mode(): Boolean

Returns whether this video is in 360 wide format.

setAudioMode

open fun setAudioMode(audioMode: Int)

Sets the audio mode policy when playing the video ad

setAutoclose

open fun setAutoclose(autoclose: Boolean)

Sets whether the ad should close when video ends

setAutoplay

open fun setAutoplay(autoplay: Boolean)

Sets whether the video should start playing as soon as it is ready to play.

setBackgroundColor

open fun setBackgroundColor(color: Int)

Sets the background color of the video layer

setBackgroundImageUrl

open fun setBackgroundImageUrl(@Nullable backgroundImageUrl: String)

Sets the URL of the background image to use for the video.

setBackgroundResizeMode

open fun setBackgroundResizeMode(backgroundResizeMode: Int)

Sets the resize policy for the background image

setBlurRadius

open fun setBlurRadius(blurRadius: Int)

Sets the blur radius parameter used for the dynamic background

setCallToActionCustomText

open fun setCallToActionCustomText(@Nullable callToActionCustomText: String)

Sets the custom text for call to action to use for the call to action button if action type is set to custom.

setCallToActionType

open fun setCallToActionType(callToActionType: Int)

Sets the type of the click URL, either a website, a video, an application or a custom type

setClickUrl

open fun setClickUrl(@NonNull clickUrl: String)

Sets the click url for this SASAdElement instance According to the work flow, if any VAST Click URL has been found, it will be overriden.

setEventTrackingURLs

open fun setEventTrackingURLs(eventName: String, eventTrackingURLs: Array<String>)

Sets the tracking URLs for a given event

setHtmlLayerAdElement

open fun setHtmlLayerAdElement(@Nullable htmlLayerAdElement: SASAdElement)

Sets the post video html ad

setMediaDuration

open fun setMediaDuration(duration: Int)

Sets the media duration.

setMediaHeight

open fun setMediaHeight(height: Int)

Sets the height of the current media, or -1 if not available

setMediaWidth

open fun setMediaWidth(width: Int)

Sets the width of the current media, or -1 if not available

setPosterImageOffsetPosition

open fun setPosterImageOffsetPosition(@Nullable posterImageOffsetPosition: String)

Sets the time within the video where to extract a frame to use as a poster image.

setPosterImageUrl

open fun setPosterImageUrl(@Nullable posterImageUrl: String)

Sets the URL of the poster image to use for the video.

setProgressOffset

open fun setProgressOffset(@Nullable progressOffset: String)

Sets the String representing the time offset from the beginning of the video when the progress tracking URL must be fired.

setRedirectsOnFirstClickEnabled

open fun setRedirectsOnFirstClickEnabled(enabled: Boolean)

Sets whether this video redirects on first click in Video-Read format

setRestartWhenEnteringFullscreen

open fun setRestartWhenEnteringFullscreen(restartWhenEnteringFullscreen: Boolean)

Sets whether the video should restart from the beginning when entering fullscreen for the first time.

setReward

open fun setReward(@Nullable reward: SASReward)

Sets the reward for this native video

setSkipPolicy

open fun setSkipPolicy(skipPolicy: Int)

Sets the skip button policy

setStickToTopEnabled

open fun setStickToTopEnabled(enabled: Boolean)

Sets whether this video can enter into stick on top mode (i.e.

setStickToTopSkippable

open fun setStickToTopSkippable(skippable: Boolean)

Sets whether the stick to top mode can be dismissed (when the video is in this mode)

setTintColor

open fun setTintColor(tintColor: Int)

Sets the Color of the tint layer

setTintOpacity

open fun setTintOpacity(tintOpacity: Int)

Sets the opacity (between 0 and 100, 100 being fully opaque) of the tint layer

setUninterruptedPlayback

open fun setUninterruptedPlayback(mUninterruptedPlayback: Boolean)

Sets whether the video will plackback till its end no matter the viewability of the ad.

setVideo360Mode

open fun setVideo360Mode(isVideo360Mode: Boolean)

Sets whether this video is in 360 wide format.

setVideoUrl

open fun setVideoUrl(@Nullable videoUrl: String)

Sets the URL of the video of this SASNativeVideoAdElement

setVideoVerticalPosition

open fun setVideoVerticalPosition(videoPosition: Int)

Sets the video vertical position