IChannelMetadata

​

Interface IChannelMetadata

interface IChannelMetadata

Extends com.amazon.apmf.IStandard Interface that represents a ChannelMetadata.

​

Methods

​

getName()

string getName()

Gets the name of the channel.

​

Returns

string The marketing name for the channel, such as “The CW” or “Comedy Central”.

---

​

getChannelType()

ChannelType getChannelType()

Gets the type of the channel.

​

Returns

ChannelType Indicates the source of the channel.

---

​

getExternalIdList()

ExternalId[] getExternalIdList()

Gets the list of external ids for the channel.

​

Returns

ExternalId[] List of identifiers used to identify the channel in external lineup sources.

---

​

getGenres()

string[] getGenres()

Gets the list of genres for the channel.

​

Returns

string[] List of genres that apply to the channel. Please refer to the developer guide for a recommended list of canonical values for this field.

---

​

getAttributes()

string[] getAttributes()

Gets the list of attributes for the channel. Attributes are properties of the channel, which are checked when filtering, ordering, or searching for channels. Please refer to the developer guide for a recommended list of canonical values for this field.

​

Returns

string[] List of attributes of the channel.

---

​

getVideoResolution()

string getVideoResolution()

Gets the video resolution of the channel.

​

Returns

string The video resolution of the channel. Empty string is returned if no video resolution was provided. Please refer to the developer guide for a recommended list of canonical values for this field.

---

​

getLogoUrl()

string getLogoUrl()

Gets the logo URL of the channel.

​

Returns

string The logo URL of the channel. Used to render channel thumbnails. Empty string is returned if no logo URL was provided.

---

​

getSortRank()

i32 getSortRank()

Gets the sort rank of the channel.

​

Returns

i32 The sort rank of this channel relative to other channels. Channels with lower integer values for the sort rank will be display before channels with higher sort rank values in the Electronic Programming Guide (EPG) for this app. This is set to MAX Int32 by default if none was provided. Please reach out to your Amazon contact if you want to display channels according to their sort rank values.

---