OBJECT

Stream

A live stream.

GraphQL Schema definition

1 type Stream {
2 
3 #   The associated archive of the stream.
4 archiveVideo: Video 
5 
6 averageFPS: Float 
7 
8 bitrate: Float 
9 
10 #   The language the stream is being broadcasted in.
11 broadcastLanguage: Language 
12 
13 #   The user who is broadcasting the live stream.
14 broadcaster: User 
15 
16 #   Software being used for the broadcast.
17 broadcasterSoftware: String 
18 
19 #   channel is deprecated.
20 channel: Channel @deprecated( reason: "Channel fields have been merged into User. Use stream.broadcaster instead."  )
21 
22 #   Number of clips created since stream start.
23 clipCount: Int 
24 
25 codec: String 
26 
27 #   The time streaming started.
28 createdAt: Time 
29 
30 #   The stream delay in seconds.
31 delayLengthSeconds: Int @deprecated( reason: "Not a supported feature anymore."  )
32 
33 #   Information about what directories the stream is categorized in.
34 directories: [Directory]! @deprecated( reason: "This was made for Communities, but the feature is officially dead. Use 'game' instead"  )
35 
36 #   Information about the game being streamed.
37 game: Game 
38 
39 #   The height of the stream's video, in pixels.
40 height: Int 
41 
42 #   The stream's unique identifier.
43 id: ID! 
44 
45 #   Whether the stream is hidden from its directory.
46 isDirectoryHidden: Boolean 
47 
48 #   Information about whether the channel is encrypted.
49 isEncrypted: Boolean 
50 
51 #   Whether the broadcaster has indicated the stream is intended for mature 
52 #   audiences only.
53 isMature: Boolean @deprecated( reason: "Use broadcaster.broadcastSettings.isMature instead"  )
54 
55 #   Whether the broadcaster is partnered with Twitch.
56 isPartner: Boolean 
57 
58 #   Whether or not viewers of this stream can receive drops.
59 #   Note: Actually earning drops additionally requires that the game have an
60 #   active drops campaign and is done at the discretion of the developer.
61 isStreamDropsEnabled: Boolean 
62 
63 #   The lanugage setting of the streaming user.
64 language: Language 
65 
66 #   When the stream was last updated.
67 lastUpdatedAt: Time 
68 
69 #   The maximum height of the stream's video, in pixels.
70 maxHeight: Int @deprecated( reason: "Not a supported feature anymore"  )
71 
72 #   Platform-specific (e.g. Xbox, PlayStation) metadata.
73 platform: Platform 
74 
75 #   The playback access token that determines whether the user can watch the stream.
76 #   Fetched for both authed and unauthed users.
77 playbackAccessToken(params: PlaybackAccessTokenParams!): PlaybackAccessToken 
78 
79 #   A URL to a dynamically sized image.
80 #   If either `height` or `width` are not given, a templated value will be present 
81 #   instead.
82 previewImageURL(height: Int, width: Int): String 
83 
84 #   The restriction that is currently active on the channel for restricting a user's 
85 #   access to it.
86 restriction: ResourceRestriction @deprecated( reason: "Use Channel.restriction for full restriction data or Stream.restrictionType for stream's restriction type"  )
87 
88 #   The list of restriction options that were applied in addition to the restriction 
89 #   type for this stream.
90 restrictionOptions: [ResourceRestrictionOption!]! 
91 
92 #   The type of restriction this stream currently has.
93 restrictionType: String 
94 
95 #   self contains information on the relationship between the current user 
96 #   (anonymous or authenticated) and this stream.
97 self: StreamSelfConnection 
98 
99 #   Tags are used as a discovery and search mechanism for tags and tagged content.
100 #   The tag data may not be updated immediately after streamers update their tags.
101 #   Please use User.tags instead if you want real time data from Graffiti.
102 #   For example, you should use Stream.tags for the channel page and the browse 
103 #   page, but use User.tags for the dashboard.
104 tags: [Tag!] 
105 
106 #   A user-defined title describing the stream.
107 title: String @deprecated( reason: "Title field in Users has been deprecated. Use broadcaster.broadcastSettings.title instead"  )
108 
109 #   What type of stream this is (e.g. live, playlist, watch_party).
110 type: String 
111 
112 #   The number of viewers currently watching the stream.
113 viewersCount: Int 
114 
115 #   The width of the stream's video, in pixels.
116 width: Int 
117 
118 }

1	type Stream {
2
3	# The associated archive of the stream.
4	archiveVideo: Video
5
6	averageFPS: Float
7
8	bitrate: Float
9
10	# The language the stream is being broadcasted in.
11	broadcastLanguage: Language
12
13	# The user who is broadcasting the live stream.
14	broadcaster: User
15
16	# Software being used for the broadcast.
17	broadcasterSoftware: String
18
19	# channel is deprecated.
20	channel: Channel @deprecated( reason: "Channel fields have been merged into User. Use stream.broadcaster instead." )
21
22	# Number of clips created since stream start.
23	clipCount: Int
24
25	codec: String
26
27	# The time streaming started.
28	createdAt: Time
29
30	# The stream delay in seconds.
31	delayLengthSeconds: Int @deprecated( reason: "Not a supported feature anymore." )
32
33	# Information about what directories the stream is categorized in.
34	directories: [Directory]! @deprecated( reason: "This was made for Communities, but the feature is officially dead. Use 'game' instead" )
35
36	# Information about the game being streamed.
37	game: Game
38
39	# The height of the stream's video, in pixels.
40	height: Int
41
42	# The stream's unique identifier.
43	id: ID!
44
45	# Whether the stream is hidden from its directory.
46	isDirectoryHidden: Boolean
47
48	# Information about whether the channel is encrypted.
49	isEncrypted: Boolean
50
51	# Whether the broadcaster has indicated the stream is intended for mature
52	# audiences only.
53	isMature: Boolean @deprecated( reason: "Use broadcaster.broadcastSettings.isMature instead" )
54
55	# Whether the broadcaster is partnered with Twitch.
56	isPartner: Boolean
57
58	# Whether or not viewers of this stream can receive drops.
59	# Note: Actually earning drops additionally requires that the game have an
60	# active drops campaign and is done at the discretion of the developer.
61	isStreamDropsEnabled: Boolean
62
63	# The lanugage setting of the streaming user.
64	language: Language
65
66	# When the stream was last updated.
67	lastUpdatedAt: Time
68
69	# The maximum height of the stream's video, in pixels.
70	maxHeight: Int @deprecated( reason: "Not a supported feature anymore" )
71
72	# Platform-specific (e.g. Xbox, PlayStation) metadata.
73	platform: Platform
74
75	# The playback access token that determines whether the user can watch the stream.
76	# Fetched for both authed and unauthed users.
77	playbackAccessToken(params: PlaybackAccessTokenParams!): PlaybackAccessToken
78
79	# A URL to a dynamically sized image.
80	# If either `height` or `width` are not given, a templated value will be present
81	# instead.
82	previewImageURL(height: Int, width: Int): String
83
84	# The restriction that is currently active on the channel for restricting a user's
85	# access to it.
86	restriction: ResourceRestriction @deprecated( reason: "Use Channel.restriction for full restriction data or Stream.restrictionType for stream's restriction type" )
87
88	# The list of restriction options that were applied in addition to the restriction
89	# type for this stream.
90	restrictionOptions: [ResourceRestrictionOption!]!
91
92	# The type of restriction this stream currently has.
93	restrictionType: String
94
95	# self contains information on the relationship between the current user
96	# (anonymous or authenticated) and this stream.
97	self: StreamSelfConnection
98
99	# Tags are used as a discovery and search mechanism for tags and tagged content.
100	# The tag data may not be updated immediately after streamers update their tags.
101	# Please use User.tags instead if you want real time data from Graffiti.
102	# For example, you should use Stream.tags for the channel page and the browse
103	# page, but use User.tags for the dashboard.
104	tags: [Tag!]
105
106	# A user-defined title describing the stream.
107	title: String @deprecated( reason: "Title field in Users has been deprecated. Use broadcaster.broadcastSettings.title instead" )
108
109	# What type of stream this is (e.g. live, playlist, watch_party).
110	type: String
111
112	# The number of viewers currently watching the stream.
113	viewersCount: Int
114
115	# The width of the stream's video, in pixels.
116	width: Int
117
118	}

Stream

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by