Class Icon

com.yandex.mobile.ads.video.models.ad

java.lang.Object ⇽ Icon

public class Icon

This class contains information about the icon.

Nested Classes

Constructors

Icon()

Methods

int describeContents()
String getApiFramework()

Returns the method used for binding to the icon.

Long getDuration()

Returns the duration, in milliseconds, for displaying the icon in the player.

Integer getHeight()

Returns the height of the icon (in pixels) that is used for the overlay on the ad.

IconHorizontalPosition getHorizontalPosition()

Returns the horizontal position of the icon (IconHorizontalPosition).

Long getOffset()

Returns the start time, in milliseconds, when the player should display the icon.

String getProgram()

Returns the advertising industry initiative that the icon supports.

IconResourceType getResourceType()

Returns the source resource type (IconResourceType).

String getResourceUrl()

Returns the source file URI for the icon.

IconVerticalPosition getVerticalPosition()

Returns the vertical position of the icon (IconVerticalPosition).

Integer getWidth()

Returns the width of the icon (in pixels) that is used for the overlay on the ad.

Integer getXPosition()

Returns the horizontal coordinate relative to the ad that the video player uses to display the icon in the upper-left corner.

Integer getYPosition()

Returns the vertical coordinate relative to the ad that the video player uses to display the icon in the upper-left corner.

void setApiFramework(final String apiFramework)

Sets the method used for binding to the icon.

void setDuration(final String duration)

Sets the duration, in milliseconds, for displaying the icon in the player.

void setHeight(final String height)

Sets the height of the icon (in pixels) that is used for the overlay on the ad.

void setHorizontalPosition(final String horizontalPosition)

Sets the horizontal position of the icon (IconHorizontalPosition).

void setOffset(final String offset)

Sets the start time, in milliseconds, when the player should display the icon.

void setProgram(final String program)

Specifies the advertising industry initiative that the icon supports.

void setResourceType(final String resourceType)

Sets the type of the source resource (IconResourceType).

void setResourceUrl(final String resourceUrl)

Sets the source file URI for the icon.

void setVerticalPosition(final String verticalPosition)

Sets the vertical position of the icon (IconVerticalPosition).

void setWidth(final String width)

Sets the width of the icon (in pixels) that is used for the overlay on the ad.

void writeToParcel(final Parcel dest, final int flags)

Fields

final Creator< Icon > CREATOR

Constructor Detail

Icon

public Icon ()

Method Detail

describeContents

public int describeContents ()

getApiFramework

public String getApiFramework ()

Returns the method used for binding to the icon.

Returns:

The method used for binding to the icon.

getDuration

public Long getDuration ()

Returns the duration, in milliseconds, for displaying the icon in the player.

Returns:

The duration, in milliseconds, for displaying the icon in the player.

getHeight

public Integer getHeight ()

Returns the height of the icon (in pixels) that is used for the overlay on the ad.

Returns:

The height of the icon (in pixels) that is used for the overlay on the ad.

getHorizontalPosition

public IconHorizontalPosition getHorizontalPosition ()

Returns the horizontal position of the icon (IconHorizontalPosition).

Returns:

Horizontal position of the icon.

getOffset

public Long getOffset ()

Returns the start time, in milliseconds, when the player should display the icon.

Returns:

Start time, in milliseconds, when the player should display the icon.

getProgram

public String getProgram ()

Returns the advertising industry initiative that the icon supports.

Returns:

Advertising industry initiative supported by the icon.

getResourceType

public IconResourceType getResourceType ()

Returns the source resource type (IconResourceType).

Returns:

The type of the source resource.

getResourceUrl

public String getResourceUrl ()

Returns the source file URI for the icon.

Returns:

The source file URI for the icon.

getVerticalPosition

public IconVerticalPosition getVerticalPosition ()

Returns the vertical position of the icon (IconVerticalPosition).

Returns:

Vertical position of the icon.

getWidth

public Integer getWidth ()

Returns the width of the icon (in pixels) that is used for the overlay on the ad.

Returns:

The width of the icon (in pixels) that is used for the overlay on the ad.

getXPosition

public Integer getXPosition ()

Returns the horizontal coordinate relative to the ad that the video player uses to display the icon in the upper-left corner.

The ad display area might not match the video player viewing area. Used if IconHorizontalPosition=leftOffset.

Returns:

Horizontal coordinate.

getYPosition

public Integer getYPosition ()

Returns the vertical coordinate relative to the ad that the video player uses to display the icon in the upper-left corner.

The ad display area might not match the video player viewing area. Used if IconVerticalPosition=topOffset.

Returns:

Vertical coordinate.

setApiFramework

public void setApiFramework (final String apiFramework)

Sets the method used for binding to the icon.

Parameters:
apiFramework

The method used for binding to the icon.

setDuration

public void setDuration (final String duration)

Sets the duration, in milliseconds, for displaying the icon in the player.

Parameters:
duration

The duration, in milliseconds, for displaying the icon in the player.

setHeight

public void setHeight (final String height)

Sets the height of the icon (in pixels) that is used for the overlay on the ad.

Parameters:
height

The height of the icon (in pixels) that is used for the overlay on the ad.

setHorizontalPosition

public void setHorizontalPosition (final String horizontalPosition)

Sets the horizontal position of the icon (IconHorizontalPosition).

Parameters:
horizontalPosition

Horizontal position of the icon (IconHorizontalPosition).

setOffset

public void setOffset (final String offset)

Sets the start time, in milliseconds, when the player should display the icon.

Parameters:
offset

Start time, in milliseconds, when the player should display the icon.

setProgram

public void setProgram (final String program)

Specifies the advertising industry initiative that the icon supports.

Parameters:
program

Advertising industry initiative supported by the icon.

setResourceType

public void setResourceType (final String resourceType)

Sets the type of the source resource (IconResourceType).

Parameters:
resourceType

Source resource type (IconResourceType).

setResourceUrl

public void setResourceUrl (final String resourceUrl)

Sets the source file URI for the icon.

Parameters:
resourceUrl

The source file URI for the icon.

setVerticalPosition

public void setVerticalPosition (final String verticalPosition)

Sets the vertical position of the icon (IconVerticalPosition).

Parameters:
verticalPosition

Vertical position of the icon (IconVerticalPosition).

setWidth

public void setWidth (final String width)

Sets the width of the icon (in pixels) that is used for the overlay on the ad.

Parameters:
width

The width of the icon (in pixels) that is used for the overlay on the ad.

writeToParcel

public void writeToParcel (final Parcel dest, final int flags)

Field Detail

CREATOR

public static CREATOR = new Creator<Icon>() { public Icon createFromParcel(final Parcel source) { return new Icon(source); } public Icon[] newArray(final int size) { return new Icon[size]; } }