com.amazon.speech.speechlet.interfaces.display.element

Class Image

java.lang.Object

com.amazon.speech.speechlet.interfaces.display.element.Image

public class Image
extends Object

This class represents an image that can be embedded within a display template. When including the image, you may provide a number of image instances with different sizes. The image size selected will be the smallest possible size that matches the desired aspect ratio and gives a clear image for the size of the screen where the image is being rendered. If an appropriately sized URL has not been provided, the next larger image size will be used and scaled down.

Constructor Summary

Constructors

Constructor and Description
Image()

Method Summary

Modifier and Type	Method and Description
String	getContentDescription() Returns the content description for use by screen readers.
String	getLargeSourceUrl() Returns the large source URL.
String	getSmallSourceUrl() Returns the small source URL.
List<ImageInstance>	getSources() Gets the list of image instances.
void	setContentDescription(String contentDescription) Sets the content description for use by screen readers.
void	setLargeSourceUrl(String largeSourceUrl) Deprecated.
void	setSmallSourceUrl(String smallSourceUrl) Deprecated.
void	setSources(List<ImageInstance> sources) Sets the list of image instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Image

public Image()

Method Detail

getContentDescription

public String getContentDescription()

Returns the content description for use by screen readers.

Returns:

the content description for use by screen readers

setContentDescription

public void setContentDescription(String contentDescription)

Sets the content description for use by screen readers.

Parameters:

contentDescription - the content description for use by screen readers

getSmallSourceUrl

public String getSmallSourceUrl()

Returns the small source URL.

Returns:

the small source URL

setSmallSourceUrl

@Deprecated
public void setSmallSourceUrl(String smallSourceUrl)

Deprecated.

Sets the small source URL. This field is deprecated. Use setSources(List) instead .

Parameters:

smallSourceUrl - the small source URL

getLargeSourceUrl

public String getLargeSourceUrl()

Returns the large source URL.

Returns:

the large source URL

setLargeSourceUrl

@Deprecated
public void setLargeSourceUrl(String largeSourceUrl)

Deprecated.

Sets the large source URL. This field is deprecated. Use setSources(List) instead .

Parameters:

largeSourceUrl - the large source URL

getSources

public List<ImageInstance> getSources()

Gets the list of image instances.

Returns:

the list of image instances

setSources

public void setSources(List<ImageInstance> sources)

Sets the list of image instances.

Parameters:

sources - the list of image instances