OBJECT

HypeTrainConfig

The Hype Train config for a channel.

GraphQL Schema definition

1 type HypeTrainConfig {
2 
3 #   A custom setting that will be an emote that the user has chosen (or PogChamp if 
4 #   not set) to display in their Hype Train events.
5 calloutEmote: Emote 
6 
7 #   The conductor rewards for a Hype Train successful execution.
8 conductorRewards: [HypeTrainConductorReward!]! 
9 
10 #   The cooldown period between Hype Train executions.
11 cooldownPeriodMinutes: Int! 
12 
13 #   The difficulty of the Hype Train.
14 difficulty: HypeTrainDifficulty! 
15 
16 #   The configured levels of the Hype Train.
17 difficultySettings: [HypeTrainDifficultySettings!]! 
18 
19 #   The identifier for the hype train.
20 id: ID! 
21 
22 #   The boolean flag that denotes if the Hype Train is enabled or not.
23 isEnabled: Boolean! 
24 
25 #   The structure that holds the parameters for tweaking how a Hype Train gets 
26 #   kicked off.
27 kickoff: HypeTrainKickoffConfig! 
28 
29 #   The duration a Hype Train level executes for.
30 levelDurationSeconds: Int! 
31 
32 #   The threshold for a notification to be displayed.
33 notificationThresholds: [HypeTrainNotificationThreshold!]! 
34 
35 #   The conversion rates for all the actions that contribute to Hype Train progress.
36 participationConversionRates: [HypeTrainParticipationConversionRate!]! 
37 
38 #   Hex color for the current hype train. Null if not enabled or no theme color is 
39 #   set.
40 primaryHexColor: String 
41 
42 #   A boolean flag that indicates if the hype train settings should be personalized 
43 #   by Twitch.
44 shouldUsePersonalizedSettings: Boolean! 
45 
46 #   A custom setting for using the creators color as the base color of hype trains.
47 willUseCreatorColor: Boolean! 
48 
49 }

1	type HypeTrainConfig {
2
3	# A custom setting that will be an emote that the user has chosen (or PogChamp if
4	# not set) to display in their Hype Train events.
5	calloutEmote: Emote
6
7	# The conductor rewards for a Hype Train successful execution.
8	conductorRewards: [HypeTrainConductorReward!]!
9
10	# The cooldown period between Hype Train executions.
11	cooldownPeriodMinutes: Int!
12
13	# The difficulty of the Hype Train.
14	difficulty: HypeTrainDifficulty!
15
16	# The configured levels of the Hype Train.
17	difficultySettings: [HypeTrainDifficultySettings!]!
18
19	# The identifier for the hype train.
20	id: ID!
21
22	# The boolean flag that denotes if the Hype Train is enabled or not.
23	isEnabled: Boolean!
24
25	# The structure that holds the parameters for tweaking how a Hype Train gets
26	# kicked off.
27	kickoff: HypeTrainKickoffConfig!
28
29	# The duration a Hype Train level executes for.
30	levelDurationSeconds: Int!
31
32	# The threshold for a notification to be displayed.
33	notificationThresholds: [HypeTrainNotificationThreshold!]!
34
35	# The conversion rates for all the actions that contribute to Hype Train progress.
36	participationConversionRates: [HypeTrainParticipationConversionRate!]!
37
38	# Hex color for the current hype train. Null if not enabled or no theme color is
39	# set.
40	primaryHexColor: String
41
42	# A boolean flag that indicates if the hype train settings should be personalized
43	# by Twitch.
44	shouldUsePersonalizedSettings: Boolean!
45
46	# A custom setting for using the creators color as the base color of hype trains.
47	willUseCreatorColor: Boolean!
48
49	}

HypeTrainConfig

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by