IChannelMetadata

Interface for the ChannelMetadata class.

Accessors

attributes

Get Signature

get attributes(): string[]

Gets the attributes of the channel.

Returns

string[]

The list of attributes of the channel. Please refer to the developer guide for a recommended list of canonical values for this field.

---

channelGroupId

Get Signature

get channelGroupId(): string

Gets the channel group ID of the channel

Returns

string

The channel group ID of the channel. Empty string is returned if no ChannelGroupId was provided.

---

channelType

Get Signature

get channelType(): ChannelTypeEnum

Gets the channel type.

Returns

ChannelTypeEnum

The source of the channel.

---

externalIdList

Get Signature

get externalIdList(): IExternalId[]

Gets the ExternalId list of the channel.

Returns

IExternalId[]

The list of identifiers used to identify the channel in external lineup sources.

---

genres

Get Signature

get genres(): string[]

Gets the list of genres pertaining to the channel.

Returns

string[]

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

---

logoUrl

Get Signature

get logoUrl(): string

Gets the logo url of the channel.

Returns

string

The logo url.

---

name

Get Signature

get name(): string

Gets the channel name.

Returns

string

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

---

sortRank

Get Signature

get sortRank(): number

Gets the sort rank of the channel.

Details

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.

Returns

number

The sort rank of this channel relative to other channels.

---

videoResolution

Get Signature

get videoResolution(): string

Gets the video resolution string 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.

---

Last updated: Sep 30, 2025