com.smartdevicelink.managers.file.filetypes

Class SdlArtwork

java.lang.Object

com.smartdevicelink.managers.file.filetypes.SdlFile

com.smartdevicelink.managers.file.filetypes.SdlArtwork

All Implemented Interfaces:

Cloneable

public class SdlArtwork
extends SdlFile
implements Cloneable

A class that extends SdlFile, representing artwork (JPEG, PNG, or BMP) to be uploaded to core

Constructor Summary

Constructors

Constructor and Description
SdlArtwork() Creates a new instance of SdlArtwork
SdlArtwork(StaticIconName staticIconName) Creates a new instance of SdlArtwork
SdlArtwork(String fileName, FileType fileType, byte[] data, boolean persistentFile) Creates a new instance of SdlArtwork
SdlArtwork(String fileName, FileType fileType, int id, boolean persistentFile) Creates a new instance of SdlArtwork
SdlArtwork(String fileName, FileType fileType, Uri uri, boolean persistentFile) Creates a new instance of SdlArtwork

Method Summary

Modifier and Type	Method and Description
SdlArtwork	clone() Creates a deep copy of the object
Image	getImageRPC() Gets the Image RPC representing this artwork.
boolean	isTemplateImage() Gets whether this SdlArtwork is a template image whose coloring should be decided by the HMI
void	setTemplateImage(boolean isTemplate) Sets whether this SdlArtwork is a template image whose coloring should be decided by the HMI
void	setType(FileType fileType) Sets the type of the file

Methods inherited from class com.smartdevicelink.managers.file.filetypes.SdlFile

equals, getFileData, getName, getOverwrite, getResourceId, getType, getUri, hashCode, isPersistent, isStaticIcon, setFileData, setName, setOverwrite, setPersistent, setResourceId, setStaticIcon, setUri

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SdlArtwork

public SdlArtwork()

Creates a new instance of SdlArtwork

SdlArtwork

public SdlArtwork(String fileName,
                  @NonNull
                  FileType fileType,
                  int id,
                  boolean persistentFile)

Creates a new instance of SdlArtwork

Parameters:

fileName - a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name

fileType - a FileType enum value representing the type of the file

id - an int value representing the android resource id of the file

persistentFile - a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

SdlArtwork

public SdlArtwork(String fileName,
                  @NonNull
                  FileType fileType,
                  Uri uri,
                  boolean persistentFile)

Creates a new instance of SdlArtwork

Parameters:

fileName - a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name

fileType - a FileType enum value representing the type of the file

uri - a URI value representing a file's location. Currently, it only supports local files

persistentFile - a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

SdlArtwork

public SdlArtwork(String fileName,
                  @NonNull
                  FileType fileType,
                  byte[] data,
                  boolean persistentFile)

Creates a new instance of SdlArtwork

Parameters:

fileName - a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name

fileType - a FileType enum value representing the type of the file

data - a byte array representing the data of the file

persistentFile - a boolean value that indicates if the file is meant to persist between sessions / ignition cycles

SdlArtwork

public SdlArtwork(@NonNull
                  StaticIconName staticIconName)

Creates a new instance of SdlArtwork

Parameters:

staticIconName - a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit

Method Detail

setTemplateImage

public void setTemplateImage(boolean isTemplate)

Sets whether this SdlArtwork is a template image whose coloring should be decided by the HMI

Parameters:

isTemplate - boolean that tells whether this SdlArtwork is a template image

isTemplateImage

public boolean isTemplateImage()

Gets whether this SdlArtwork is a template image whose coloring should be decided by the HMI

Returns:

boolean that tells whether this SdlArtwork is a template image

setType

public void setType(@NonNull
                    FileType fileType)

Description copied from class: SdlFile

Sets the type of the file

Overrides:

setType in class SdlFile

Parameters:

fileType - a FileType enum value representing the type of the file

getImageRPC

public Image getImageRPC()

Gets the Image RPC representing this artwork. Generally for use internally, you should instead pass an artwork to a Screen Manager method

Returns:

The Image RPC representing this artwork

clone

public SdlArtwork clone()

Creates a deep copy of the object

Overrides:

clone in class SdlFile

Returns:

deep copy of the object, null if an exception occurred