OBJECT

Clip

A recorded, replayable part of a live broadcast.

GraphQL Schema definition

1 type Clip {
2 
3 #   The broadcast of the clip. This should only be used to fetch the ID of the 
4 #   broadcast.
5 #   Because not all videos have broadcasts (e.g. uploads), not all clips will have a 
6 #   broadcast.
7 broadcast: Broadcast 
8 
9 #   The broadcaster from which the clip originated.
10 broadcaster: User 
11 
12 #   The curator's clip champ badge if it has been attained on the broadcaster's 
13 #   channel.
14 #   This has been deprecated and will be always be null.
15 champBadge: Badge @deprecated( reason: "Clip Champ Badges are no longer being awarded"  )
16 
17 #   The time when the clip was created.
18 createdAt: Time! 
19 
20 #   Different video qualities are being created in the background.
21 #   The creation state indicates when the source quality clip is playable
22 #   and transcoding of the clip in other video qualities has begun.
23 creationState: ClipCreationState 
24 
25 #   The user who created the clip.
26 curator: User 
27 
28 #   The duration of the clip, in seconds.
29 durationSeconds: Int! 
30 
31 #   The URL used in the embed player.
32 embedURL: String! 
33 
34 #   The game depicted in the clip.
35 game: Game 
36 
37 #   The clip's unique identifier.
38 id: ID! 
39 
40 #   Whether or not the clip has been published.
41 isPublished: Boolean 
42 
43 #   The language of the clip.
44 language: Language! 
45 
46 #   The playback access token that determines whether the user can watch the clip.
47 #   Fetched for both authed and unauthed users.
48 playbackAccessToken(params: PlaybackAccessTokenParams!): PlaybackAccessToken 
49 
50 #   Metadata around the raw media.
51 rawMedia: ClipRawMedia! 
52 
53 #   The different quality options of this clip's raw media used for editing.
54 rawVideoQualities: [ClipVideoQuality!] 
55 
56 #   The reactions associated with this clips.
57 reactions: [Reaction] 
58 
59 #   Lists of related clips based on different algorithms.
60 relatedClips: ClipRelatedClips 
61 
62 #   A URL-friendly identifier.
63 slug: String! 
64 
65 #   A URL to a thumbnail image.
66 #   Valid sizes are "86x45", "260x147", and "480x272".
67 thumbnailURL(width: Int, height: Int): String! 
68 
69 #   The title of the clip.
70 title: String! 
71 
72 #   A URL to the clip's page.
73 url: String! 
74 
75 #   The video of the clip. Because not all broadcasts are archived, not all clips 
76 #   will
77 #   have a video.
78 video: Video 
79 
80 #   The number of seconds into a VOD this clip was generated from.
81 videoOffsetSeconds: Int 
82 
83 #   The different quality options of this clip available for playback.
84 #   The clip will first be available in the source video quality, indicated by when 
85 #   the
86 #   clipCreationState is 'CREATED'. videoQualities will gradually be added to 
87 #   afterwards as
88 #   more video quality options become playable.
89 videoQualities: [ClipVideoQuality!] 
90 
91 #   The number of times this clip has been viewed.
92 viewCount: Int! 
93 
94 }

1	type Clip {
2
3	# The broadcast of the clip. This should only be used to fetch the ID of the
4	# broadcast.
5	# Because not all videos have broadcasts (e.g. uploads), not all clips will have a
6	# broadcast.
7	broadcast: Broadcast
8
9	# The broadcaster from which the clip originated.
10	broadcaster: User
11
12	# The curator's clip champ badge if it has been attained on the broadcaster's
13	# channel.
14	# This has been deprecated and will be always be null.
15	champBadge: Badge @deprecated( reason: "Clip Champ Badges are no longer being awarded" )
16
17	# The time when the clip was created.
18	createdAt: Time!
19
20	# Different video qualities are being created in the background.
21	# The creation state indicates when the source quality clip is playable
22	# and transcoding of the clip in other video qualities has begun.
23	creationState: ClipCreationState
24
25	# The user who created the clip.
26	curator: User
27
28	# The duration of the clip, in seconds.
29	durationSeconds: Int!
30
31	# The URL used in the embed player.
32	embedURL: String!
33
34	# The game depicted in the clip.
35	game: Game
36
37	# The clip's unique identifier.
38	id: ID!
39
40	# Whether or not the clip has been published.
41	isPublished: Boolean
42
43	# The language of the clip.
44	language: Language!
45
46	# The playback access token that determines whether the user can watch the clip.
47	# Fetched for both authed and unauthed users.
48	playbackAccessToken(params: PlaybackAccessTokenParams!): PlaybackAccessToken
49
50	# Metadata around the raw media.
51	rawMedia: ClipRawMedia!
52
53	# The different quality options of this clip's raw media used for editing.
54	rawVideoQualities: [ClipVideoQuality!]
55
56	# The reactions associated with this clips.
57	reactions: [Reaction]
58
59	# Lists of related clips based on different algorithms.
60	relatedClips: ClipRelatedClips
61
62	# A URL-friendly identifier.
63	slug: String!
64
65	# A URL to a thumbnail image.
66	# Valid sizes are "86x45", "260x147", and "480x272".
67	thumbnailURL(width: Int, height: Int): String!
68
69	# The title of the clip.
70	title: String!
71
72	# A URL to the clip's page.
73	url: String!
74
75	# The video of the clip. Because not all broadcasts are archived, not all clips
76	# will
77	# have a video.
78	video: Video
79
80	# The number of seconds into a VOD this clip was generated from.
81	videoOffsetSeconds: Int
82
83	# The different quality options of this clip available for playback.
84	# The clip will first be available in the source video quality, indicated by when
85	# the
86	# clipCreationState is 'CREATED'. videoQualities will gradually be added to
87	# afterwards as
88	# more video quality options become playable.
89	videoQualities: [ClipVideoQuality!]
90
91	# The number of times this clip has been viewed.
92	viewCount: Int!
93
94	}

Clip

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by