public interface

Video

com.smaato.soma.sdk.video.ad.Video

Summary

Nested Classes
interface Video.OnClickListener A listener for the click event. 
interface Video.OnCloseListener A listener for the close event. 
interface Video.OnCompleteListener A listener for the complete event. 
interface Video.OnStartListener A listener for the start event. 
interface Video.OnTtlExpiredListener A listener for the TTL(time to live) expiration event. 
Public Methods
abstract String getAdSpaceId()
abstract String getPublisherId()
abstract UserInfo getUserInfo()
abstract boolean isAvailableForPresentation()
abstract void setCloseButtonEnabled(boolean enabled)
Sets an enabled flag if close button should/shouldn't be shown during Video ad playback.
abstract Video setOnClickListener(Video.OnClickListener onClickListener)
Sets Video.OnClickListener to receive click events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks.

abstract Video setOnCloseListener(Video.OnCloseListener onCloseListener)
Sets Video.OnCloseListener to receive close events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks.

abstract Video setOnCompleteListener(Video.OnCompleteListener onCompleteListener)
Sets Video.OnCompleteListener to receive video playback completion events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks.

abstract Video setOnStartListener(Video.OnStartListener onStartListener)
Sets Video.OnStartListener to receive start events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks.

abstract Video setOnTtlExpiredListener(Video.OnTtlExpiredListener onTtlExpiredListener)
Sets Video.OnTtlExpiredListener to receive TTL(time to live) expiration events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks.

abstract void show()
Shows successfully loaded ad.

Public Methods

public abstract String getAdSpaceId ()

Returns

public abstract String getPublisherId ()

Returns

public abstract UserInfo getUserInfo ()

Returns
  • UserInfo data object that contains user-related information been passed to com.smaato.soma.sdk.core.SomaSdk static methods.

public abstract boolean isAvailableForPresentation ()

Returns
  • true if ad is ready to be presented by @{link #show} call and false if not.

public abstract void setCloseButtonEnabled (boolean enabled)

Sets an enabled flag if close button should/shouldn't be shown during Video ad playback. Has no effect on Video ad that is already shown by show() call. The default value is false

Parameters
enabled a flag to pass if close button should enabled/disabled respectively.

public abstract Video setOnClickListener (Video.OnClickListener onClickListener)

Sets Video.OnClickListener to receive click events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks. It's responsibility of Video's user to keep instances from been collected by garbage collector.

Parameters
onClickListener to set
Returns
  • same Video instance to provide easy way of setters combining

public abstract Video setOnCloseListener (Video.OnCloseListener onCloseListener)

Sets Video.OnCloseListener to receive close events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks. It's responsibility of Video's user to keep instances from been collected by garbage collector.

Returns
  • same Video instance to provide easy way of setters combining.

public abstract Video setOnCompleteListener (Video.OnCompleteListener onCompleteListener)

Sets Video.OnCompleteListener to receive video playback completion events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks. It's responsibility of Video's user to keep instances from been collected by garbage collector.

Parameters
onCompleteListener to set
Returns
  • same Video instance to provide easy way of setters combining

public abstract Video setOnStartListener (Video.OnStartListener onStartListener)

Sets Video.OnStartListener to receive start events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks. It's responsibility of Video's user to keep instances from been collected by garbage collector.

Parameters
onStartListener to set
Returns
  • same Video instance to provide easy way of setters combining

public abstract Video setOnTtlExpiredListener (Video.OnTtlExpiredListener onTtlExpiredListener)

Sets Video.OnTtlExpiredListener to receive TTL(time to live) expiration events

Video instance keeps java.lang.ref.WeakReference on listener to prevent memory leaks. It's responsibility of Video's user to keep instances from been collected by garbage collector.

Parameters
onTtlExpiredListener to set
Returns
  • same Video instance to provide easy way of setters combining

public abstract void show ()

Shows successfully loaded ad.