Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
Android Documentation
SdlArtwork

Class SdlArtwork

Hierarchy

java.lang.Object
     com.smartdevicelink.managers.file.filetypes.SdlFile

Package
com.smartdevicelink.managers.file.filetypes
All Implemented Interfaces
java.lang.Cloneable

Overview

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

Constructors

SdlArtwork()

Creates a new instance of SdlArtwork

public SdlArtwork()

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

Creates a new instance of SdlArtwork

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

Constructor 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( String fileName, FileType fileType, Uri uri, boolean persistentFile )

Creates a new instance of SdlArtwork

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

Constructor 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( String fileName, FileType fileType, byte[] data, boolean persistentFile )

Creates a new instance of SdlArtwork

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

Constructor 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( StaticIconName staticIconName )

Creates a new instance of SdlArtwork

public SdlArtwork(StaticIconName staticIconName)

Constructor Parameters

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

Methods

setTemplateImage( boolean isTemplate )

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

public void setTemplateImage(boolean isTemplate)

Method Parameters

isTemplate
boolean that tells whether this SdlArtwork is a template image

isTemplateImage()

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

public boolean isTemplateImage()

setType( FileType fileType )

public void setType(FileType fileType)

Method Parameters

fileType

getImageRPC()

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

public com.smartdevicelink.proxy.rpc.Image getImageRPC()

clone()

Creates a deep copy of the object

public com.smartdevicelink.managers.file.filetypes.SdlArtwork clone()

Inherited Methods

From Class Methods
com.smartdevicelink.managers.file.filetypes.SdlFile setName, getName, setResourceId, getResourceId, setUri, getUri, setFileData, getFileData, setType, getType, setPersistent, isPersistent, setStaticIcon, isStaticIcon, getOverwrite, setOverwrite, hashCode, equals, clone
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section