OBJECT

Video

GraphQL Schema definition

1 type Video {
2 
3 #   A link to an image which contains an animated preview of the video.
4 animatedPreviewURL: String 
5 
6 #   A list of bookmarks for this video.
7 bookmarks(first: Int, after: Cursor): VideoBookmarkConnection 
8 
9 #   The type of broadcast the video originated from.
10 broadcastType: BroadcastType 
11 
12 #   A paginated list of clips for this video.
13 #   When criteria is not specified, the default values are used.
14 clips(first: Int, after: Cursor, curatorIDs: [ID!], sort: SortOrder): ClipConnection 
15 
16 #   A paginated list of comments against this video.
17 comments(
18 first: Int,
19 after: Cursor,
20 last: Int,
21 Before: Cursor,
22 contentOffsetSeconds: Int
23 ): VideoCommentConnection 
24 
25 #   A list of tags describing the video.
26 contentTags: [Tag!] 
27 
28 #   The time the video metadata record was created.
29 createdAt: Time 
30 
31 #   The user who created this video.
32 #   This will be either the broadcaster or one of their editors.
33 creator: User 
34 
35 #   NOTE: named `deleteAt` in Vinyl.
36 deletedAt: Time 
37 
38 #   A description of the video, formatted in markdown.
39 description: String 
40 
41 #   Download information of the video. NOTE: Request this field only when a user is 
42 #   requesting a download
43 #   since it will go through a process to generate a download URL on the backend.
44 download: VideoDownload 
45 
46 #   The length of the video.
47 duration: Duration @deprecated( reason: "Use length instead, as it's easier to parse."  )
48 
49 #   The game the video is depicting.
50 game: Game 
51 
52 #   The video's identifier.
53 id: ID! 
54 
55 #   Whether the video has been soft deleted.
56 isDeleted: Boolean! 
57 
58 #   Which language the video is in.
59 language: String 
60 
61 #   The length of the video, as an int, in seconds.
62 lengthSeconds: Int 
63 
64 #   A list of moments for this video.
65 moments(
66 first: Int,
67 after: Cursor,
68 sort: SortOrder,
69 types: [VideoMomentType],
70 momentRequestType: VideoMomentRequestType
71 ): VideoMomentConnection 
72 
73 #   Publicly available muted segment info, detailing which parts of the video
74 #   have had audio removed.
75 muteInfo: VideoMuteInfo 
76 
77 #   For highlights, the number of seconds offset from the beginning of the past 
78 #   broadcast the highlight starts.
79 #   For past broadcasts and uploads, this means nothing.
80 offsetSeconds: Int 
81 
82 #   The owner of the video.
83 owner: User 
84 
85 #   The playback access token that determines whether the user can watch the video.
86 #   Fetched for both authed and unauthed users.
87 playbackAccessToken(params: PlaybackAccessTokenParams!): PlaybackAccessToken 
88 
89 #   The URL to the thumbnail which should be displayed for the video.
90 #   If either `height` or `width` are not given, a templated value (i.e. `{height}`, 
91 #   `{width}`) will be present in the URL instead.
92 previewThumbnailURL(height: Int, width: Int): String! 
93 
94 #   The time when the archive/highlight/upload was first ever available to public,
95 #   even if it is not currently public.
96 publishedAt: Time 
97 
98 #   The reactions associated with this video.
99 reactions: [Reaction] 
100 
101 #   The time the video was recorded.
102 recordedAt: Time 
103 
104 #   The reason a video is restricted if the given video is a restricted video.
105 #   For a video that is not restricted, this field can be null.
106 resourceRestriction: ResourceRestriction 
107 
108 #   The reason a video is restricted if the given video is a restricted video.
109 #   For a video that is not restricted, this field can be null.
110 restriction: VideoRestriction @deprecated( reason: "Restriction will be moved over to resourceRestriction instead"  )
111 
112 #   Either PRIVATE or PUBLIC.
113 scope: VideoPrivacyScope 
114 
115 #   A link to a sprite sheet image made up of preview thumbnails when seeking the 
116 #   video timeline.
117 seekPreviewsURL: String 
118 
119 #   The authenticated user's relationship with this video.
120 self: VideoSelfEdge 
121 
122 #   When broadcastType is:
123 #   - ARCHIVE: status goes from RECORDING to RECORDED.
124 #   - HIGHLIGHT: status goes from UNPROCESSED to RECORDED.
125 #   - UPLOAD: status goes from CREATED to UPLOADING, to PENDING_TRANSCODE, to 
126 #   RECORDED, or FAILED if anything goes wrong.
127 #   - PREMIERE_UPLOAD: status goes from CREATED to UPLOADING, to PENDING_TRANSCODE, 
128 #   to RECORDED, or FAILED if anything goes wrong for this legacy broadcast type.
129 #   - PAST_PREMIERE: status goes from RECORDING to RECORDED for this legacy 
130 #   broadcast type.
131 status: VideoStatus 
132 
133 #   The suggested details for creating an automated highlight from this video.
134 suggestedHighlight: VideoSuggestedHighlight 
135 
136 #   An array of tags describing the video. This field will be deprecated soon. 
137 #   Please use `Video.contentTag` instead.
138 tags: [String] 
139 
140 #   A list of thumbnail URLs for the video, ordered by descending priority.
141 #   Owners can insert custom thumbnails into this list.
142 #   If either `height` or `width` are not given, a templated value (i.e. `{height}`, 
143 #   `{width}`) will be present in the URL instead.
144 thumbnailURLs(height: Int, width: Int): [String] 
145 
146 #   The title of the video.
147 title: String 
148 
149 #   A paginated list of clips featuring this vod that is, by default, ordered by 
150 #   view count descending.
151 #   When criteria is not specified, the default values are used.
152 topClips(first: Int, after: Cursor, criteria: VideoTopClipsInput): ClipConnection 
153 
154 #   The most recent time the video data was updated.
155 updatedAt: Time 
156 
157 #   The numer of views this video has. Can be delayed by up to 15 minutes.
158 viewCount: Int 
159 
160 #   For a scheduled video, the time when the video will be made available to the
161 #   public (the time when the scope will be automatically set to "public").
162 #   For a video that is public or not scheduled, is null.
163 viewableAt: Time 
164 
165 }

1	type Video {
2
3	# A link to an image which contains an animated preview of the video.
4	animatedPreviewURL: String
5
6	# A list of bookmarks for this video.
7	bookmarks(first: Int, after: Cursor): VideoBookmarkConnection
8
9	# The type of broadcast the video originated from.
10	broadcastType: BroadcastType
11
12	# A paginated list of clips for this video.
13	# When criteria is not specified, the default values are used.
14	clips(first: Int, after: Cursor, curatorIDs: [ID!], sort: SortOrder): ClipConnection
15
16	# A paginated list of comments against this video.
17	comments(
18	first: Int,
19	after: Cursor,
20	last: Int,
21	Before: Cursor,
22	contentOffsetSeconds: Int
23	): VideoCommentConnection
24
25	# A list of tags describing the video.
26	contentTags: [Tag!]
27
28	# The time the video metadata record was created.
29	createdAt: Time
30
31	# The user who created this video.
32	# This will be either the broadcaster or one of their editors.
33	creator: User
34
35	# NOTE: named `deleteAt` in Vinyl.
36	deletedAt: Time
37
38	# A description of the video, formatted in markdown.
39	description: String
40
41	# Download information of the video. NOTE: Request this field only when a user is
42	# requesting a download
43	# since it will go through a process to generate a download URL on the backend.
44	download: VideoDownload
45
46	# The length of the video.
47	duration: Duration @deprecated( reason: "Use length instead, as it's easier to parse." )
48
49	# The game the video is depicting.
50	game: Game
51
52	# The video's identifier.
53	id: ID!
54
55	# Whether the video has been soft deleted.
56	isDeleted: Boolean!
57
58	# Which language the video is in.
59	language: String
60
61	# The length of the video, as an int, in seconds.
62	lengthSeconds: Int
63
64	# A list of moments for this video.
65	moments(
66	first: Int,
67	after: Cursor,
68	sort: SortOrder,
69	types: [VideoMomentType],
70	momentRequestType: VideoMomentRequestType
71	): VideoMomentConnection
72
73	# Publicly available muted segment info, detailing which parts of the video
74	# have had audio removed.
75	muteInfo: VideoMuteInfo
76
77	# For highlights, the number of seconds offset from the beginning of the past
78	# broadcast the highlight starts.
79	# For past broadcasts and uploads, this means nothing.
80	offsetSeconds: Int
81
82	# The owner of the video.
83	owner: User
84
85	# The playback access token that determines whether the user can watch the video.
86	# Fetched for both authed and unauthed users.
87	playbackAccessToken(params: PlaybackAccessTokenParams!): PlaybackAccessToken
88
89	# The URL to the thumbnail which should be displayed for the video.
90	# If either `height` or `width` are not given, a templated value (i.e. `{height}`,
91	# `{width}`) will be present in the URL instead.
92	previewThumbnailURL(height: Int, width: Int): String!
93
94	# The time when the archive/highlight/upload was first ever available to public,
95	# even if it is not currently public.
96	publishedAt: Time
97
98	# The reactions associated with this video.
99	reactions: [Reaction]
100
101	# The time the video was recorded.
102	recordedAt: Time
103
104	# The reason a video is restricted if the given video is a restricted video.
105	# For a video that is not restricted, this field can be null.
106	resourceRestriction: ResourceRestriction
107
108	# The reason a video is restricted if the given video is a restricted video.
109	# For a video that is not restricted, this field can be null.
110	restriction: VideoRestriction @deprecated( reason: "Restriction will be moved over to resourceRestriction instead" )
111
112	# Either PRIVATE or PUBLIC.
113	scope: VideoPrivacyScope
114
115	# A link to a sprite sheet image made up of preview thumbnails when seeking the
116	# video timeline.
117	seekPreviewsURL: String
118
119	# The authenticated user's relationship with this video.
120	self: VideoSelfEdge
121
122	# When broadcastType is:
123	# - ARCHIVE: status goes from RECORDING to RECORDED.
124	# - HIGHLIGHT: status goes from UNPROCESSED to RECORDED.
125	# - UPLOAD: status goes from CREATED to UPLOADING, to PENDING_TRANSCODE, to
126	# RECORDED, or FAILED if anything goes wrong.
127	# - PREMIERE_UPLOAD: status goes from CREATED to UPLOADING, to PENDING_TRANSCODE,
128	# to RECORDED, or FAILED if anything goes wrong for this legacy broadcast type.
129	# - PAST_PREMIERE: status goes from RECORDING to RECORDED for this legacy
130	# broadcast type.
131	status: VideoStatus
132
133	# The suggested details for creating an automated highlight from this video.
134	suggestedHighlight: VideoSuggestedHighlight
135
136	# An array of tags describing the video. This field will be deprecated soon.
137	# Please use `Video.contentTag` instead.
138	tags: [String]
139
140	# A list of thumbnail URLs for the video, ordered by descending priority.
141	# Owners can insert custom thumbnails into this list.
142	# If either `height` or `width` are not given, a templated value (i.e. `{height}`,
143	# `{width}`) will be present in the URL instead.
144	thumbnailURLs(height: Int, width: Int): [String]
145
146	# The title of the video.
147	title: String
148
149	# A paginated list of clips featuring this vod that is, by default, ordered by
150	# view count descending.
151	# When criteria is not specified, the default values are used.
152	topClips(first: Int, after: Cursor, criteria: VideoTopClipsInput): ClipConnection
153
154	# The most recent time the video data was updated.
155	updatedAt: Time
156
157	# The numer of views this video has. Can be delayed by up to 15 minutes.
158	viewCount: Int
159
160	# For a scheduled video, the time when the video will be made available to the
161	# public (the time when the scope will be automatically set to "public").
162	# For a video that is public or not scheduled, is null.
163	viewableAt: Time
164
165	}

Video

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by