TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixEmote

A Twitch emote.

Overview

Properties

formats

Type: HelixEmoteFormat[]

The formats that the emote is available in.

id

Type: string

The ID of the emote.

name

Type: string

The name of the emote.

scales

Type: HelixEmoteScale[]

The scales that the emote is available in.

themeModes

Type: HelixEmoteThemeMode[]

The theme modes that the emote is available in.

Methods

getAnimatedImageUrl(scale, themeMode)

Gets the URL of the emote image in animated format at the given scale and theme mode, or null if an animated emote image at that scale/theme mode doesn't exist.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteScale'1.0'

The scale of the image.

themeModeHelixEmoteThemeMode'light'

The theme mode of the image, either light or dark.

Return type: string | null

getFormattedImageUrl(scale, format, themeMode)

Gets the URL of the emote image in the given scale, format, and theme mode.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteScale'1.0'

The scale of the image, either 1.0 (small), 2.0 (medium), or 3.0 (large).

formatHelixEmoteFormat'static'

The format of the image, either static or animated.

themeModeHelixEmoteThemeMode'light'

The theme mode of the image, either light or dark.

Return type: string

getImageUrl(scale)

Gets the URL of the emote image in the given scale.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteImageScalenone

The scale of the image.

Return type: string

getStaticImageUrl(scale, themeMode)

Gets the URL of the emote image in static format at the given scale and theme mode, or null if a static emote image at that scale/theme mode doesn't exist.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteScale'1.0'

The scale of the image.

themeModeHelixEmoteThemeMode'light'

The theme mode of the image, either light or dark.

Return type: string | null