aws-sdk-ivsrealtime 1.18.0 → 1.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivsrealtime/client.rb +265 -227
- data/lib/aws-sdk-ivsrealtime/client_api.rb +98 -76
- data/lib/aws-sdk-ivsrealtime/types.rb +515 -439
- data/lib/aws-sdk-ivsrealtime/waiters.rb +15 -0
- data/lib/aws-sdk-ivsrealtime.rb +2 -1
- data/sig/client.rbs +76 -67
- data/sig/types.rbs +90 -76
- metadata +5 -4
@@ -22,6 +22,29 @@ module Aws::IVSRealTime
|
|
22
22
|
include Aws::Structure
|
23
23
|
end
|
24
24
|
|
25
|
+
# Object specifying an auto-participant-recording configuration.
|
26
|
+
#
|
27
|
+
# @!attribute [rw] storage_configuration_arn
|
28
|
+
# ARN of the StorageConfiguration resource to use for auto participant
|
29
|
+
# recording. Default: "" (empty string, no storage configuration is
|
30
|
+
# specified). Individual participant recording cannot be started
|
31
|
+
# unless a storage configuration is specified, when a Stage is created
|
32
|
+
# or updated.
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] media_types
|
36
|
+
# Types of media to be recorded. Default: `AUDIO_VIDEO`.
|
37
|
+
# @return [Array<String>]
|
38
|
+
#
|
39
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/AutoParticipantRecordingConfiguration AWS API Documentation
|
40
|
+
#
|
41
|
+
class AutoParticipantRecordingConfiguration < Struct.new(
|
42
|
+
:storage_configuration_arn,
|
43
|
+
:media_types)
|
44
|
+
SENSITIVE = []
|
45
|
+
include Aws::Structure
|
46
|
+
end
|
47
|
+
|
25
48
|
# Object specifying a channel as a destination.
|
26
49
|
#
|
27
50
|
# @!attribute [rw] channel_arn
|
@@ -50,33 +73,23 @@ module Aws::IVSRealTime
|
|
50
73
|
# ARN of the Composition resource.
|
51
74
|
# @return [String]
|
52
75
|
#
|
53
|
-
# @!attribute [rw] destinations
|
54
|
-
# Array of Destination objects. A Composition can contain either one
|
55
|
-
# destination (`channel` or `s3`) or two (one `channel` and one `s3`).
|
56
|
-
# @return [Array<Types::Destination>]
|
57
|
-
#
|
58
|
-
# @!attribute [rw] end_time
|
59
|
-
# UTC time of the Composition end. This is an ISO 8601 timestamp;
|
60
|
-
# *note that this is returned as a string*.
|
61
|
-
# @return [Time]
|
62
|
-
#
|
63
|
-
# @!attribute [rw] layout
|
64
|
-
# Layout object to configure composition parameters.
|
65
|
-
# @return [Types::LayoutConfiguration]
|
66
|
-
#
|
67
76
|
# @!attribute [rw] stage_arn
|
68
77
|
# ARN of the stage used as input
|
69
78
|
# @return [String]
|
70
79
|
#
|
71
|
-
# @!attribute [rw] start_time
|
72
|
-
# UTC time of the Composition start. This is an ISO 8601 timestamp;
|
73
|
-
# *note that this is returned as a string*.
|
74
|
-
# @return [Time]
|
75
|
-
#
|
76
80
|
# @!attribute [rw] state
|
77
81
|
# State of the Composition.
|
78
82
|
# @return [String]
|
79
83
|
#
|
84
|
+
# @!attribute [rw] layout
|
85
|
+
# Layout object to configure composition parameters.
|
86
|
+
# @return [Types::LayoutConfiguration]
|
87
|
+
#
|
88
|
+
# @!attribute [rw] destinations
|
89
|
+
# Array of Destination objects. A Composition can contain either one
|
90
|
+
# destination (`channel` or `s3`) or two (one `channel` and one `s3`).
|
91
|
+
# @return [Array<Types::Destination>]
|
92
|
+
#
|
80
93
|
# @!attribute [rw] tags
|
81
94
|
# Tags attached to the resource. Array of maps, each of the form
|
82
95
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -89,17 +102,27 @@ module Aws::IVSRealTime
|
|
89
102
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
90
103
|
# @return [Hash<String,String>]
|
91
104
|
#
|
105
|
+
# @!attribute [rw] start_time
|
106
|
+
# UTC time of the Composition start. This is an ISO 8601 timestamp;
|
107
|
+
# *note that this is returned as a string*.
|
108
|
+
# @return [Time]
|
109
|
+
#
|
110
|
+
# @!attribute [rw] end_time
|
111
|
+
# UTC time of the Composition end. This is an ISO 8601 timestamp;
|
112
|
+
# *note that this is returned as a string*.
|
113
|
+
# @return [Time]
|
114
|
+
#
|
92
115
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Composition AWS API Documentation
|
93
116
|
#
|
94
117
|
class Composition < Struct.new(
|
95
118
|
:arn,
|
96
|
-
:destinations,
|
97
|
-
:end_time,
|
98
|
-
:layout,
|
99
119
|
:stage_arn,
|
100
|
-
:start_time,
|
101
120
|
:state,
|
102
|
-
:
|
121
|
+
:layout,
|
122
|
+
:destinations,
|
123
|
+
:tags,
|
124
|
+
:start_time,
|
125
|
+
:end_time)
|
103
126
|
SENSITIVE = []
|
104
127
|
include Aws::Structure
|
105
128
|
end
|
@@ -110,23 +133,13 @@ module Aws::IVSRealTime
|
|
110
133
|
# ARN of the Composition resource.
|
111
134
|
# @return [String]
|
112
135
|
#
|
113
|
-
# @!attribute [rw] destinations
|
114
|
-
# Array of Destination objects.
|
115
|
-
# @return [Array<Types::DestinationSummary>]
|
116
|
-
#
|
117
|
-
# @!attribute [rw] end_time
|
118
|
-
# UTC time of the Composition end. This is an ISO 8601 timestamp;
|
119
|
-
# *note that this is returned as a string*.
|
120
|
-
# @return [Time]
|
121
|
-
#
|
122
136
|
# @!attribute [rw] stage_arn
|
123
137
|
# ARN of the attached stage.
|
124
138
|
# @return [String]
|
125
139
|
#
|
126
|
-
# @!attribute [rw]
|
127
|
-
#
|
128
|
-
#
|
129
|
-
# @return [Time]
|
140
|
+
# @!attribute [rw] destinations
|
141
|
+
# Array of Destination objects.
|
142
|
+
# @return [Array<Types::DestinationSummary>]
|
130
143
|
#
|
131
144
|
# @!attribute [rw] state
|
132
145
|
# State of the Composition resource.
|
@@ -144,16 +157,26 @@ module Aws::IVSRealTime
|
|
144
157
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
145
158
|
# @return [Hash<String,String>]
|
146
159
|
#
|
160
|
+
# @!attribute [rw] start_time
|
161
|
+
# UTC time of the Composition start. This is an ISO 8601 timestamp;
|
162
|
+
# *note that this is returned as a string*.
|
163
|
+
# @return [Time]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] end_time
|
166
|
+
# UTC time of the Composition end. This is an ISO 8601 timestamp;
|
167
|
+
# *note that this is returned as a string*.
|
168
|
+
# @return [Time]
|
169
|
+
#
|
147
170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CompositionSummary AWS API Documentation
|
148
171
|
#
|
149
172
|
class CompositionSummary < Struct.new(
|
150
173
|
:arn,
|
151
|
-
:destinations,
|
152
|
-
:end_time,
|
153
174
|
:stage_arn,
|
154
|
-
:
|
175
|
+
:destinations,
|
155
176
|
:state,
|
156
|
-
:tags
|
177
|
+
:tags,
|
178
|
+
:start_time,
|
179
|
+
:end_time)
|
157
180
|
SENSITIVE = []
|
158
181
|
include Aws::Structure
|
159
182
|
end
|
@@ -174,6 +197,11 @@ module Aws::IVSRealTime
|
|
174
197
|
# Optional name to identify the resource.
|
175
198
|
# @return [String]
|
176
199
|
#
|
200
|
+
# @!attribute [rw] video
|
201
|
+
# Video configuration. Default: video resolution 1280x720, bitrate
|
202
|
+
# 2500 kbps, 30 fps.
|
203
|
+
# @return [Types::Video]
|
204
|
+
#
|
177
205
|
# @!attribute [rw] tags
|
178
206
|
# Tags attached to the resource. Array of maps, each of the form
|
179
207
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -186,17 +214,12 @@ module Aws::IVSRealTime
|
|
186
214
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
187
215
|
# @return [Hash<String,String>]
|
188
216
|
#
|
189
|
-
# @!attribute [rw] video
|
190
|
-
# Video configuration. Default: video resolution 1280x720, bitrate
|
191
|
-
# 2500 kbps, 30 fps.
|
192
|
-
# @return [Types::Video]
|
193
|
-
#
|
194
217
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateEncoderConfigurationRequest AWS API Documentation
|
195
218
|
#
|
196
219
|
class CreateEncoderConfigurationRequest < Struct.new(
|
197
220
|
:name,
|
198
|
-
:
|
199
|
-
:
|
221
|
+
:video,
|
222
|
+
:tags)
|
200
223
|
SENSITIVE = []
|
201
224
|
include Aws::Structure
|
202
225
|
end
|
@@ -213,28 +236,15 @@ module Aws::IVSRealTime
|
|
213
236
|
include Aws::Structure
|
214
237
|
end
|
215
238
|
|
216
|
-
# @!attribute [rw]
|
217
|
-
#
|
218
|
-
#
|
219
|
-
# maximum length of this field is 1 KB total. *This field is exposed
|
220
|
-
# to all stage participants and should not be used for personally
|
221
|
-
# identifying, confidential, or sensitive information.*
|
222
|
-
# @return [Hash<String,String>]
|
223
|
-
#
|
224
|
-
# @!attribute [rw] capabilities
|
225
|
-
# Set of capabilities that the user is allowed to perform in the
|
226
|
-
# stage. Default: `PUBLISH, SUBSCRIBE`.
|
227
|
-
# @return [Array<String>]
|
239
|
+
# @!attribute [rw] stage_arn
|
240
|
+
# ARN of the stage to which this token is scoped.
|
241
|
+
# @return [String]
|
228
242
|
#
|
229
243
|
# @!attribute [rw] duration
|
230
244
|
# Duration (in minutes), after which the token expires. Default: 720
|
231
245
|
# (12 hours).
|
232
246
|
# @return [Integer]
|
233
247
|
#
|
234
|
-
# @!attribute [rw] stage_arn
|
235
|
-
# ARN of the stage to which this token is scoped.
|
236
|
-
# @return [String]
|
237
|
-
#
|
238
248
|
# @!attribute [rw] user_id
|
239
249
|
# Name that can be specified to help identify the token. This can be
|
240
250
|
# any UTF-8 encoded text. *This field is exposed to all stage
|
@@ -242,14 +252,27 @@ module Aws::IVSRealTime
|
|
242
252
|
# confidential, or sensitive information.*
|
243
253
|
# @return [String]
|
244
254
|
#
|
255
|
+
# @!attribute [rw] attributes
|
256
|
+
# Application-provided attributes to encode into the token and attach
|
257
|
+
# to a stage. Map keys and values can contain UTF-8 encoded text. The
|
258
|
+
# maximum length of this field is 1 KB total. *This field is exposed
|
259
|
+
# to all stage participants and should not be used for personally
|
260
|
+
# identifying, confidential, or sensitive information.*
|
261
|
+
# @return [Hash<String,String>]
|
262
|
+
#
|
263
|
+
# @!attribute [rw] capabilities
|
264
|
+
# Set of capabilities that the user is allowed to perform in the
|
265
|
+
# stage. Default: `PUBLISH, SUBSCRIBE`.
|
266
|
+
# @return [Array<String>]
|
267
|
+
#
|
245
268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateParticipantTokenRequest AWS API Documentation
|
246
269
|
#
|
247
270
|
class CreateParticipantTokenRequest < Struct.new(
|
248
|
-
:attributes,
|
249
|
-
:capabilities,
|
250
|
-
:duration,
|
251
271
|
:stage_arn,
|
252
|
-
:
|
272
|
+
:duration,
|
273
|
+
:user_id,
|
274
|
+
:attributes,
|
275
|
+
:capabilities)
|
253
276
|
SENSITIVE = []
|
254
277
|
include Aws::Structure
|
255
278
|
end
|
@@ -287,30 +310,36 @@ module Aws::IVSRealTime
|
|
287
310
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
288
311
|
# @return [Hash<String,String>]
|
289
312
|
#
|
313
|
+
# @!attribute [rw] auto_participant_recording_configuration
|
314
|
+
# Auto participant recording configuration object attached to the
|
315
|
+
# stage.
|
316
|
+
# @return [Types::AutoParticipantRecordingConfiguration]
|
317
|
+
#
|
290
318
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStageRequest AWS API Documentation
|
291
319
|
#
|
292
320
|
class CreateStageRequest < Struct.new(
|
293
321
|
:name,
|
294
322
|
:participant_token_configurations,
|
295
|
-
:tags
|
323
|
+
:tags,
|
324
|
+
:auto_participant_recording_configuration)
|
296
325
|
SENSITIVE = []
|
297
326
|
include Aws::Structure
|
298
327
|
end
|
299
328
|
|
329
|
+
# @!attribute [rw] stage
|
330
|
+
# The stage that was created.
|
331
|
+
# @return [Types::Stage]
|
332
|
+
#
|
300
333
|
# @!attribute [rw] participant_tokens
|
301
334
|
# Participant tokens attached to the stage. These correspond to the
|
302
335
|
# `participants` in the request.
|
303
336
|
# @return [Array<Types::ParticipantToken>]
|
304
337
|
#
|
305
|
-
# @!attribute [rw] stage
|
306
|
-
# The stage that was created.
|
307
|
-
# @return [Types::Stage]
|
308
|
-
#
|
309
338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStageResponse AWS API Documentation
|
310
339
|
#
|
311
340
|
class CreateStageResponse < Struct.new(
|
312
|
-
:
|
313
|
-
:
|
341
|
+
:stage,
|
342
|
+
:participant_tokens)
|
314
343
|
SENSITIVE = []
|
315
344
|
include Aws::Structure
|
316
345
|
end
|
@@ -408,56 +437,56 @@ module Aws::IVSRealTime
|
|
408
437
|
|
409
438
|
# Object specifying the status of a Destination.
|
410
439
|
#
|
411
|
-
# @!attribute [rw] configuration
|
412
|
-
# Configuration used to create this destination.
|
413
|
-
# @return [Types::DestinationConfiguration]
|
414
|
-
#
|
415
|
-
# @!attribute [rw] detail
|
416
|
-
# Optional details regarding the status of the destination.
|
417
|
-
# @return [Types::DestinationDetail]
|
418
|
-
#
|
419
|
-
# @!attribute [rw] end_time
|
420
|
-
# UTC time of the destination end. This is an ISO 8601 timestamp;
|
421
|
-
# *note that this is returned as a string*.
|
422
|
-
# @return [Time]
|
423
|
-
#
|
424
440
|
# @!attribute [rw] id
|
425
441
|
# Unique identifier for this destination, assigned by IVS.
|
426
442
|
# @return [String]
|
427
443
|
#
|
444
|
+
# @!attribute [rw] state
|
445
|
+
# State of the Composition Destination.
|
446
|
+
# @return [String]
|
447
|
+
#
|
428
448
|
# @!attribute [rw] start_time
|
429
449
|
# UTC time of the destination start. This is an ISO 8601 timestamp;
|
430
450
|
# *note that this is returned as a string*.
|
431
451
|
# @return [Time]
|
432
452
|
#
|
433
|
-
# @!attribute [rw]
|
434
|
-
#
|
435
|
-
#
|
453
|
+
# @!attribute [rw] end_time
|
454
|
+
# UTC time of the destination end. This is an ISO 8601 timestamp;
|
455
|
+
# *note that this is returned as a string*.
|
456
|
+
# @return [Time]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] configuration
|
459
|
+
# Configuration used to create this destination.
|
460
|
+
# @return [Types::DestinationConfiguration]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] detail
|
463
|
+
# Optional details regarding the status of the destination.
|
464
|
+
# @return [Types::DestinationDetail]
|
436
465
|
#
|
437
466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Destination AWS API Documentation
|
438
467
|
#
|
439
468
|
class Destination < Struct.new(
|
440
|
-
:configuration,
|
441
|
-
:detail,
|
442
|
-
:end_time,
|
443
469
|
:id,
|
470
|
+
:state,
|
444
471
|
:start_time,
|
445
|
-
:
|
472
|
+
:end_time,
|
473
|
+
:configuration,
|
474
|
+
:detail)
|
446
475
|
SENSITIVE = []
|
447
476
|
include Aws::Structure
|
448
477
|
end
|
449
478
|
|
450
479
|
# Complex data type that defines destination-configuration objects.
|
451
480
|
#
|
481
|
+
# @!attribute [rw] name
|
482
|
+
# Name that can be specified to help identify the destination.
|
483
|
+
# @return [String]
|
484
|
+
#
|
452
485
|
# @!attribute [rw] channel
|
453
486
|
# An IVS channel to be used for broadcasting, for server-side
|
454
487
|
# composition. Either a `channel` or an `s3` must be specified.
|
455
488
|
# @return [Types::ChannelDestinationConfiguration]
|
456
489
|
#
|
457
|
-
# @!attribute [rw] name
|
458
|
-
# Name that can be specified to help identify the destination.
|
459
|
-
# @return [String]
|
460
|
-
#
|
461
490
|
# @!attribute [rw] s3
|
462
491
|
# An S3 storage configuration to be used for recording video data.
|
463
492
|
# Either a `channel` or an `s3` must be specified.
|
@@ -466,8 +495,8 @@ module Aws::IVSRealTime
|
|
466
495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DestinationConfiguration AWS API Documentation
|
467
496
|
#
|
468
497
|
class DestinationConfiguration < Struct.new(
|
469
|
-
:channel,
|
470
498
|
:name,
|
499
|
+
:channel,
|
471
500
|
:s3)
|
472
501
|
SENSITIVE = []
|
473
502
|
include Aws::Structure
|
@@ -489,35 +518,39 @@ module Aws::IVSRealTime
|
|
489
518
|
|
490
519
|
# Summary information about a Destination.
|
491
520
|
#
|
492
|
-
# @!attribute [rw] end_time
|
493
|
-
# UTC time of the destination end. This is an ISO 8601 timestamp;
|
494
|
-
# *note that this is returned as a string*.
|
495
|
-
# @return [Time]
|
496
|
-
#
|
497
521
|
# @!attribute [rw] id
|
498
522
|
# Unique identifier for this destination, assigned by IVS.
|
499
523
|
# @return [String]
|
500
524
|
#
|
525
|
+
# @!attribute [rw] state
|
526
|
+
# State of the Composition Destination.
|
527
|
+
# @return [String]
|
528
|
+
#
|
501
529
|
# @!attribute [rw] start_time
|
502
530
|
# UTC time of the destination start. This is an ISO 8601 timestamp;
|
503
531
|
# *note that this is returned as a string*.
|
504
532
|
# @return [Time]
|
505
533
|
#
|
506
|
-
# @!attribute [rw]
|
507
|
-
#
|
508
|
-
#
|
534
|
+
# @!attribute [rw] end_time
|
535
|
+
# UTC time of the destination end. This is an ISO 8601 timestamp;
|
536
|
+
# *note that this is returned as a string*.
|
537
|
+
# @return [Time]
|
509
538
|
#
|
510
539
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DestinationSummary AWS API Documentation
|
511
540
|
#
|
512
541
|
class DestinationSummary < Struct.new(
|
513
|
-
:end_time,
|
514
542
|
:id,
|
543
|
+
:state,
|
515
544
|
:start_time,
|
516
|
-
:
|
545
|
+
:end_time)
|
517
546
|
SENSITIVE = []
|
518
547
|
include Aws::Structure
|
519
548
|
end
|
520
549
|
|
550
|
+
# @!attribute [rw] stage_arn
|
551
|
+
# ARN of the stage to which the participant is attached.
|
552
|
+
# @return [String]
|
553
|
+
#
|
521
554
|
# @!attribute [rw] participant_id
|
522
555
|
# Identifier of the participant to be disconnected. This is assigned
|
523
556
|
# by IVS and returned by CreateParticipantToken.
|
@@ -527,16 +560,12 @@ module Aws::IVSRealTime
|
|
527
560
|
# Description of why this participant is being disconnected.
|
528
561
|
# @return [String]
|
529
562
|
#
|
530
|
-
# @!attribute [rw] stage_arn
|
531
|
-
# ARN of the stage to which the participant is attached.
|
532
|
-
# @return [String]
|
533
|
-
#
|
534
563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DisconnectParticipantRequest AWS API Documentation
|
535
564
|
#
|
536
565
|
class DisconnectParticipantRequest < Struct.new(
|
566
|
+
:stage_arn,
|
537
567
|
:participant_id,
|
538
|
-
:reason
|
539
|
-
:stage_arn)
|
568
|
+
:reason)
|
540
569
|
SENSITIVE = []
|
541
570
|
include Aws::Structure
|
542
571
|
end
|
@@ -555,6 +584,11 @@ module Aws::IVSRealTime
|
|
555
584
|
# Optional name to identify the resource.
|
556
585
|
# @return [String]
|
557
586
|
#
|
587
|
+
# @!attribute [rw] video
|
588
|
+
# Video configuration. Default: video resolution 1280x720, bitrate
|
589
|
+
# 2500 kbps, 30 fps
|
590
|
+
# @return [Types::Video]
|
591
|
+
#
|
558
592
|
# @!attribute [rw] tags
|
559
593
|
# Tags attached to the resource. Array of maps, each of the form
|
560
594
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -567,18 +601,13 @@ module Aws::IVSRealTime
|
|
567
601
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
568
602
|
# @return [Hash<String,String>]
|
569
603
|
#
|
570
|
-
# @!attribute [rw] video
|
571
|
-
# Video configuration. Default: video resolution 1280x720, bitrate
|
572
|
-
# 2500 kbps, 30 fps
|
573
|
-
# @return [Types::Video]
|
574
|
-
#
|
575
604
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/EncoderConfiguration AWS API Documentation
|
576
605
|
#
|
577
606
|
class EncoderConfiguration < Struct.new(
|
578
607
|
:arn,
|
579
608
|
:name,
|
580
|
-
:
|
581
|
-
:
|
609
|
+
:video,
|
610
|
+
:tags)
|
582
611
|
SENSITIVE = []
|
583
612
|
include Aws::Structure
|
584
613
|
end
|
@@ -617,22 +646,13 @@ module Aws::IVSRealTime
|
|
617
646
|
|
618
647
|
# An occurrence during a stage session.
|
619
648
|
#
|
620
|
-
# @!attribute [rw]
|
621
|
-
#
|
622
|
-
#
|
623
|
-
# an error event, this field is null. `INSUFFICIENT_CAPABILITIES`
|
624
|
-
# indicates that the participant tried to take an action that the
|
625
|
-
# participant’s token is not allowed to do. For more information about
|
626
|
-
# participant capabilities, see the `capabilities` field in
|
627
|
-
# CreateParticipantToken. `QUOTA_EXCEEDED` indicates that the number
|
628
|
-
# of participants who want to publish/subscribe to a stage exceeds the
|
629
|
-
# quota; for more information, see [Service Quotas][1].
|
630
|
-
# `PUBLISHER_NOT_FOUND` indicates that the participant tried to
|
631
|
-
# subscribe to a publisher that doesn’t exist.
|
632
|
-
#
|
633
|
-
#
|
649
|
+
# @!attribute [rw] name
|
650
|
+
# The name of the event.
|
651
|
+
# @return [String]
|
634
652
|
#
|
635
|
-
#
|
653
|
+
# @!attribute [rw] participant_id
|
654
|
+
# Unique identifier for the participant who triggered the event. This
|
655
|
+
# is assigned by IVS.
|
636
656
|
# @return [String]
|
637
657
|
#
|
638
658
|
# @!attribute [rw] event_time
|
@@ -640,29 +660,38 @@ module Aws::IVSRealTime
|
|
640
660
|
# occurred.
|
641
661
|
# @return [Time]
|
642
662
|
#
|
643
|
-
# @!attribute [rw] name
|
644
|
-
# The name of the event.
|
645
|
-
# @return [String]
|
646
|
-
#
|
647
|
-
# @!attribute [rw] participant_id
|
648
|
-
# Unique identifier for the participant who triggered the event. This
|
649
|
-
# is assigned by IVS.
|
650
|
-
# @return [String]
|
651
|
-
#
|
652
663
|
# @!attribute [rw] remote_participant_id
|
653
664
|
# Unique identifier for the remote participant. For a subscribe event,
|
654
665
|
# this is the publisher. For a publish or join event, this is null.
|
655
666
|
# This is assigned by IVS.
|
656
667
|
# @return [String]
|
657
668
|
#
|
669
|
+
# @!attribute [rw] error_code
|
670
|
+
# If the event is an error event, the error code is provided to give
|
671
|
+
# insight into the specific error that occurred. If the event is not
|
672
|
+
# an error event, this field is null. `INSUFFICIENT_CAPABILITIES`
|
673
|
+
# indicates that the participant tried to take an action that the
|
674
|
+
# participant’s token is not allowed to do. For more information about
|
675
|
+
# participant capabilities, see the `capabilities` field in
|
676
|
+
# CreateParticipantToken. `QUOTA_EXCEEDED` indicates that the number
|
677
|
+
# of participants who want to publish/subscribe to a stage exceeds the
|
678
|
+
# quota; for more information, see [Service Quotas][1].
|
679
|
+
# `PUBLISHER_NOT_FOUND` indicates that the participant tried to
|
680
|
+
# subscribe to a publisher that doesn’t exist.
|
681
|
+
#
|
682
|
+
#
|
683
|
+
#
|
684
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html
|
685
|
+
# @return [String]
|
686
|
+
#
|
658
687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Event AWS API Documentation
|
659
688
|
#
|
660
689
|
class Event < Struct.new(
|
661
|
-
:error_code,
|
662
|
-
:event_time,
|
663
690
|
:name,
|
664
691
|
:participant_id,
|
665
|
-
:
|
692
|
+
:event_time,
|
693
|
+
:remote_participant_id,
|
694
|
+
:error_code)
|
666
695
|
SENSITIVE = []
|
667
696
|
include Aws::Structure
|
668
697
|
end
|
@@ -715,25 +744,25 @@ module Aws::IVSRealTime
|
|
715
744
|
include Aws::Structure
|
716
745
|
end
|
717
746
|
|
718
|
-
# @!attribute [rw]
|
719
|
-
#
|
720
|
-
# returned by CreateParticipantToken.
|
747
|
+
# @!attribute [rw] stage_arn
|
748
|
+
# Stage ARN.
|
721
749
|
# @return [String]
|
722
750
|
#
|
723
751
|
# @!attribute [rw] session_id
|
724
752
|
# ID of a session within the stage.
|
725
753
|
# @return [String]
|
726
754
|
#
|
727
|
-
# @!attribute [rw]
|
728
|
-
#
|
755
|
+
# @!attribute [rw] participant_id
|
756
|
+
# Unique identifier for the participant. This is assigned by IVS and
|
757
|
+
# returned by CreateParticipantToken.
|
729
758
|
# @return [String]
|
730
759
|
#
|
731
760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetParticipantRequest AWS API Documentation
|
732
761
|
#
|
733
762
|
class GetParticipantRequest < Struct.new(
|
734
|
-
:
|
763
|
+
:stage_arn,
|
735
764
|
:session_id,
|
736
|
-
:
|
765
|
+
:participant_id)
|
737
766
|
SENSITIVE = []
|
738
767
|
include Aws::Structure
|
739
768
|
end
|
@@ -774,19 +803,19 @@ module Aws::IVSRealTime
|
|
774
803
|
include Aws::Structure
|
775
804
|
end
|
776
805
|
|
777
|
-
# @!attribute [rw] session_id
|
778
|
-
# ID of a session within the stage.
|
779
|
-
# @return [String]
|
780
|
-
#
|
781
806
|
# @!attribute [rw] stage_arn
|
782
807
|
# ARN of the stage for which the information is to be retrieved.
|
783
808
|
# @return [String]
|
784
809
|
#
|
810
|
+
# @!attribute [rw] session_id
|
811
|
+
# ID of a session within the stage.
|
812
|
+
# @return [String]
|
813
|
+
#
|
785
814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageSessionRequest AWS API Documentation
|
786
815
|
#
|
787
816
|
class GetStageSessionRequest < Struct.new(
|
788
|
-
:
|
789
|
-
:
|
817
|
+
:stage_arn,
|
818
|
+
:session_id)
|
790
819
|
SENSITIVE = []
|
791
820
|
include Aws::Structure
|
792
821
|
end
|
@@ -840,11 +869,6 @@ module Aws::IVSRealTime
|
|
840
869
|
# ParticipantTokenConfiguration is placed in the featured slot.
|
841
870
|
# @return [String]
|
842
871
|
#
|
843
|
-
# @!attribute [rw] grid_gap
|
844
|
-
# Specifies the spacing between participant tiles in pixels. Default:
|
845
|
-
# `2`.
|
846
|
-
# @return [Integer]
|
847
|
-
#
|
848
872
|
# @!attribute [rw] omit_stopped_video
|
849
873
|
# Determines whether to omit participants with stopped video in the
|
850
874
|
# composition. Default: `false`.
|
@@ -860,14 +884,19 @@ module Aws::IVSRealTime
|
|
860
884
|
# the grid and to `CONTAIN` fill mode for featured participants.
|
861
885
|
# @return [String]
|
862
886
|
#
|
887
|
+
# @!attribute [rw] grid_gap
|
888
|
+
# Specifies the spacing between participant tiles in pixels. Default:
|
889
|
+
# `2`.
|
890
|
+
# @return [Integer]
|
891
|
+
#
|
863
892
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GridConfiguration AWS API Documentation
|
864
893
|
#
|
865
894
|
class GridConfiguration < Struct.new(
|
866
895
|
:featured_participant_attribute,
|
867
|
-
:grid_gap,
|
868
896
|
:omit_stopped_video,
|
869
897
|
:video_aspect_ratio,
|
870
|
-
:video_fill_mode
|
898
|
+
:video_fill_mode,
|
899
|
+
:grid_gap)
|
871
900
|
SENSITIVE = []
|
872
901
|
include Aws::Structure
|
873
902
|
end
|
@@ -904,31 +933,31 @@ module Aws::IVSRealTime
|
|
904
933
|
include Aws::Structure
|
905
934
|
end
|
906
935
|
|
936
|
+
# @!attribute [rw] filter_by_stage_arn
|
937
|
+
# Filters the Composition list to match the specified Stage ARN.
|
938
|
+
# @return [String]
|
939
|
+
#
|
907
940
|
# @!attribute [rw] filter_by_encoder_configuration_arn
|
908
941
|
# Filters the Composition list to match the specified
|
909
942
|
# EncoderConfiguration attached to at least one of its output.
|
910
943
|
# @return [String]
|
911
944
|
#
|
912
|
-
# @!attribute [rw]
|
913
|
-
#
|
945
|
+
# @!attribute [rw] next_token
|
946
|
+
# The first Composition to retrieve. This is used for pagination; see
|
947
|
+
# the `nextToken` response field.
|
914
948
|
# @return [String]
|
915
949
|
#
|
916
950
|
# @!attribute [rw] max_results
|
917
951
|
# Maximum number of results to return. Default: 100.
|
918
952
|
# @return [Integer]
|
919
953
|
#
|
920
|
-
# @!attribute [rw] next_token
|
921
|
-
# The first Composition to retrieve. This is used for pagination; see
|
922
|
-
# the `nextToken` response field.
|
923
|
-
# @return [String]
|
924
|
-
#
|
925
954
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListCompositionsRequest AWS API Documentation
|
926
955
|
#
|
927
956
|
class ListCompositionsRequest < Struct.new(
|
928
|
-
:filter_by_encoder_configuration_arn,
|
929
957
|
:filter_by_stage_arn,
|
930
|
-
:
|
931
|
-
:next_token
|
958
|
+
:filter_by_encoder_configuration_arn,
|
959
|
+
:next_token,
|
960
|
+
:max_results)
|
932
961
|
SENSITIVE = []
|
933
962
|
include Aws::Structure
|
934
963
|
end
|
@@ -951,20 +980,20 @@ module Aws::IVSRealTime
|
|
951
980
|
include Aws::Structure
|
952
981
|
end
|
953
982
|
|
954
|
-
# @!attribute [rw] max_results
|
955
|
-
# Maximum number of results to return. Default: 100.
|
956
|
-
# @return [Integer]
|
957
|
-
#
|
958
983
|
# @!attribute [rw] next_token
|
959
984
|
# The first encoder configuration to retrieve. This is used for
|
960
985
|
# pagination; see the `nextToken` response field.
|
961
986
|
# @return [String]
|
962
987
|
#
|
988
|
+
# @!attribute [rw] max_results
|
989
|
+
# Maximum number of results to return. Default: 100.
|
990
|
+
# @return [Integer]
|
991
|
+
#
|
963
992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListEncoderConfigurationsRequest AWS API Documentation
|
964
993
|
#
|
965
994
|
class ListEncoderConfigurationsRequest < Struct.new(
|
966
|
-
:
|
967
|
-
:
|
995
|
+
:next_token,
|
996
|
+
:max_results)
|
968
997
|
SENSITIVE = []
|
969
998
|
include Aws::Structure
|
970
999
|
end
|
@@ -988,13 +1017,12 @@ module Aws::IVSRealTime
|
|
988
1017
|
include Aws::Structure
|
989
1018
|
end
|
990
1019
|
|
991
|
-
# @!attribute [rw]
|
992
|
-
#
|
993
|
-
# @return [
|
1020
|
+
# @!attribute [rw] stage_arn
|
1021
|
+
# Stage ARN.
|
1022
|
+
# @return [String]
|
994
1023
|
#
|
995
|
-
# @!attribute [rw]
|
996
|
-
#
|
997
|
-
# pagination; see the `nextToken` response field.
|
1024
|
+
# @!attribute [rw] session_id
|
1025
|
+
# ID of a session within the stage.
|
998
1026
|
# @return [String]
|
999
1027
|
#
|
1000
1028
|
# @!attribute [rw] participant_id
|
@@ -1002,22 +1030,23 @@ module Aws::IVSRealTime
|
|
1002
1030
|
# returned by CreateParticipantToken.
|
1003
1031
|
# @return [String]
|
1004
1032
|
#
|
1005
|
-
# @!attribute [rw]
|
1006
|
-
#
|
1033
|
+
# @!attribute [rw] next_token
|
1034
|
+
# The first participant event to retrieve. This is used for
|
1035
|
+
# pagination; see the `nextToken` response field.
|
1007
1036
|
# @return [String]
|
1008
1037
|
#
|
1009
|
-
# @!attribute [rw]
|
1010
|
-
#
|
1011
|
-
# @return [
|
1038
|
+
# @!attribute [rw] max_results
|
1039
|
+
# Maximum number of results to return. Default: 50.
|
1040
|
+
# @return [Integer]
|
1012
1041
|
#
|
1013
1042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantEventsRequest AWS API Documentation
|
1014
1043
|
#
|
1015
1044
|
class ListParticipantEventsRequest < Struct.new(
|
1016
|
-
:
|
1017
|
-
:next_token,
|
1018
|
-
:participant_id,
|
1045
|
+
:stage_arn,
|
1019
1046
|
:session_id,
|
1020
|
-
:
|
1047
|
+
:participant_id,
|
1048
|
+
:next_token,
|
1049
|
+
:max_results)
|
1021
1050
|
SENSITIVE = []
|
1022
1051
|
include Aws::Structure
|
1023
1052
|
end
|
@@ -1040,185 +1069,195 @@ module Aws::IVSRealTime
|
|
1040
1069
|
include Aws::Structure
|
1041
1070
|
end
|
1042
1071
|
|
1072
|
+
# @!attribute [rw] stage_arn
|
1073
|
+
# Stage ARN.
|
1074
|
+
# @return [String]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] session_id
|
1077
|
+
# ID of the session within the stage.
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] filter_by_user_id
|
1081
|
+
# Filters the response list to match the specified user ID. Only one
|
1082
|
+
# of `filterByUserId`, `filterByPublished`, `filterByState`, or
|
1083
|
+
# `filterByRecordingState` can be provided per request. A `userId` is
|
1084
|
+
# a customer-assigned name to help identify the token; this can be
|
1085
|
+
# used to link a participant to a user in the customer’s own systems.
|
1086
|
+
# @return [String]
|
1087
|
+
#
|
1043
1088
|
# @!attribute [rw] filter_by_published
|
1044
1089
|
# Filters the response list to only show participants who published
|
1045
1090
|
# during the stage session. Only one of `filterByUserId`,
|
1046
|
-
# `filterByPublished`, or `
|
1091
|
+
# `filterByPublished`, `filterByState`, or `filterByRecordingState`
|
1092
|
+
# can be provided per request.
|
1047
1093
|
# @return [Boolean]
|
1048
1094
|
#
|
1049
1095
|
# @!attribute [rw] filter_by_state
|
1050
1096
|
# Filters the response list to only show participants in the specified
|
1051
|
-
# state. Only one of `filterByUserId`, `filterByPublished`,
|
1052
|
-
# `filterByState` can be provided per
|
1097
|
+
# state. Only one of `filterByUserId`, `filterByPublished`,
|
1098
|
+
# `filterByState`, or `filterByRecordingState` can be provided per
|
1099
|
+
# request.
|
1053
1100
|
# @return [String]
|
1054
1101
|
#
|
1055
|
-
# @!attribute [rw] filter_by_user_id
|
1056
|
-
# Filters the response list to match the specified user ID. Only one
|
1057
|
-
# of `filterByUserId`, `filterByPublished`, or `filterByState` can be
|
1058
|
-
# provided per request. A `userId` is a customer-assigned name to help
|
1059
|
-
# identify the token; this can be used to link a participant to a user
|
1060
|
-
# in the customer’s own systems.
|
1061
|
-
# @return [String]
|
1062
|
-
#
|
1063
|
-
# @!attribute [rw] max_results
|
1064
|
-
# Maximum number of results to return. Default: 50.
|
1065
|
-
# @return [Integer]
|
1066
|
-
#
|
1067
1102
|
# @!attribute [rw] next_token
|
1068
1103
|
# The first participant to retrieve. This is used for pagination; see
|
1069
1104
|
# the `nextToken` response field.
|
1070
1105
|
# @return [String]
|
1071
1106
|
#
|
1072
|
-
# @!attribute [rw]
|
1073
|
-
#
|
1074
|
-
# @return [
|
1107
|
+
# @!attribute [rw] max_results
|
1108
|
+
# Maximum number of results to return. Default: 50.
|
1109
|
+
# @return [Integer]
|
1075
1110
|
#
|
1076
|
-
# @!attribute [rw]
|
1077
|
-
#
|
1111
|
+
# @!attribute [rw] filter_by_recording_state
|
1112
|
+
# Filters the response list to only show participants with the
|
1113
|
+
# specified recording state. Only one of `filterByUserId`,
|
1114
|
+
# `filterByPublished`, `filterByState`, or `filterByRecordingState`
|
1115
|
+
# can be provided per request.
|
1078
1116
|
# @return [String]
|
1079
1117
|
#
|
1080
1118
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantsRequest AWS API Documentation
|
1081
1119
|
#
|
1082
1120
|
class ListParticipantsRequest < Struct.new(
|
1121
|
+
:stage_arn,
|
1122
|
+
:session_id,
|
1123
|
+
:filter_by_user_id,
|
1083
1124
|
:filter_by_published,
|
1084
1125
|
:filter_by_state,
|
1085
|
-
:filter_by_user_id,
|
1086
|
-
:max_results,
|
1087
1126
|
:next_token,
|
1088
|
-
:
|
1089
|
-
:
|
1127
|
+
:max_results,
|
1128
|
+
:filter_by_recording_state)
|
1090
1129
|
SENSITIVE = []
|
1091
1130
|
include Aws::Structure
|
1092
1131
|
end
|
1093
1132
|
|
1133
|
+
# @!attribute [rw] participants
|
1134
|
+
# List of the matching participants (summary information only).
|
1135
|
+
# @return [Array<Types::ParticipantSummary>]
|
1136
|
+
#
|
1094
1137
|
# @!attribute [rw] next_token
|
1095
1138
|
# If there are more participants than `maxResults`, use `nextToken` in
|
1096
1139
|
# the request to get the next set.
|
1097
1140
|
# @return [String]
|
1098
1141
|
#
|
1099
|
-
# @!attribute [rw] participants
|
1100
|
-
# List of the matching participants (summary information only).
|
1101
|
-
# @return [Array<Types::ParticipantSummary>]
|
1102
|
-
#
|
1103
1142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantsResponse AWS API Documentation
|
1104
1143
|
#
|
1105
1144
|
class ListParticipantsResponse < Struct.new(
|
1106
|
-
:
|
1107
|
-
:
|
1145
|
+
:participants,
|
1146
|
+
:next_token)
|
1108
1147
|
SENSITIVE = []
|
1109
1148
|
include Aws::Structure
|
1110
1149
|
end
|
1111
1150
|
|
1112
|
-
# @!attribute [rw]
|
1113
|
-
#
|
1114
|
-
# @return [
|
1151
|
+
# @!attribute [rw] stage_arn
|
1152
|
+
# Stage ARN.
|
1153
|
+
# @return [String]
|
1115
1154
|
#
|
1116
1155
|
# @!attribute [rw] next_token
|
1117
1156
|
# The first stage session to retrieve. This is used for pagination;
|
1118
1157
|
# see the `nextToken` response field.
|
1119
1158
|
# @return [String]
|
1120
1159
|
#
|
1121
|
-
# @!attribute [rw]
|
1122
|
-
#
|
1123
|
-
# @return [
|
1160
|
+
# @!attribute [rw] max_results
|
1161
|
+
# Maximum number of results to return. Default: 50.
|
1162
|
+
# @return [Integer]
|
1124
1163
|
#
|
1125
1164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStageSessionsRequest AWS API Documentation
|
1126
1165
|
#
|
1127
1166
|
class ListStageSessionsRequest < Struct.new(
|
1128
|
-
:
|
1167
|
+
:stage_arn,
|
1129
1168
|
:next_token,
|
1130
|
-
:
|
1169
|
+
:max_results)
|
1131
1170
|
SENSITIVE = []
|
1132
1171
|
include Aws::Structure
|
1133
1172
|
end
|
1134
1173
|
|
1174
|
+
# @!attribute [rw] stage_sessions
|
1175
|
+
# List of matching stage sessions.
|
1176
|
+
# @return [Array<Types::StageSessionSummary>]
|
1177
|
+
#
|
1135
1178
|
# @!attribute [rw] next_token
|
1136
1179
|
# If there are more stage sessions than `maxResults`, use `nextToken`
|
1137
1180
|
# in the request to get the next set.
|
1138
1181
|
# @return [String]
|
1139
1182
|
#
|
1140
|
-
# @!attribute [rw] stage_sessions
|
1141
|
-
# List of matching stage sessions.
|
1142
|
-
# @return [Array<Types::StageSessionSummary>]
|
1143
|
-
#
|
1144
1183
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStageSessionsResponse AWS API Documentation
|
1145
1184
|
#
|
1146
1185
|
class ListStageSessionsResponse < Struct.new(
|
1147
|
-
:
|
1148
|
-
:
|
1186
|
+
:stage_sessions,
|
1187
|
+
:next_token)
|
1149
1188
|
SENSITIVE = []
|
1150
1189
|
include Aws::Structure
|
1151
1190
|
end
|
1152
1191
|
|
1153
|
-
# @!attribute [rw] max_results
|
1154
|
-
# Maximum number of results to return. Default: 50.
|
1155
|
-
# @return [Integer]
|
1156
|
-
#
|
1157
1192
|
# @!attribute [rw] next_token
|
1158
1193
|
# The first stage to retrieve. This is used for pagination; see the
|
1159
1194
|
# `nextToken` response field.
|
1160
1195
|
# @return [String]
|
1161
1196
|
#
|
1197
|
+
# @!attribute [rw] max_results
|
1198
|
+
# Maximum number of results to return. Default: 50.
|
1199
|
+
# @return [Integer]
|
1200
|
+
#
|
1162
1201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStagesRequest AWS API Documentation
|
1163
1202
|
#
|
1164
1203
|
class ListStagesRequest < Struct.new(
|
1165
|
-
:
|
1166
|
-
:
|
1204
|
+
:next_token,
|
1205
|
+
:max_results)
|
1167
1206
|
SENSITIVE = []
|
1168
1207
|
include Aws::Structure
|
1169
1208
|
end
|
1170
1209
|
|
1210
|
+
# @!attribute [rw] stages
|
1211
|
+
# List of the matching stages (summary information only).
|
1212
|
+
# @return [Array<Types::StageSummary>]
|
1213
|
+
#
|
1171
1214
|
# @!attribute [rw] next_token
|
1172
1215
|
# If there are more stages than `maxResults`, use `nextToken` in the
|
1173
1216
|
# request to get the next set.
|
1174
1217
|
# @return [String]
|
1175
1218
|
#
|
1176
|
-
# @!attribute [rw] stages
|
1177
|
-
# List of the matching stages (summary information only).
|
1178
|
-
# @return [Array<Types::StageSummary>]
|
1179
|
-
#
|
1180
1219
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStagesResponse AWS API Documentation
|
1181
1220
|
#
|
1182
1221
|
class ListStagesResponse < Struct.new(
|
1183
|
-
:
|
1184
|
-
:
|
1222
|
+
:stages,
|
1223
|
+
:next_token)
|
1185
1224
|
SENSITIVE = []
|
1186
1225
|
include Aws::Structure
|
1187
1226
|
end
|
1188
1227
|
|
1189
|
-
# @!attribute [rw] max_results
|
1190
|
-
# Maximum number of storage configurations to return. Default: your
|
1191
|
-
# service quota or 100, whichever is smaller.
|
1192
|
-
# @return [Integer]
|
1193
|
-
#
|
1194
1228
|
# @!attribute [rw] next_token
|
1195
1229
|
# The first storage configuration to retrieve. This is used for
|
1196
1230
|
# pagination; see the `nextToken` response field.
|
1197
1231
|
# @return [String]
|
1198
1232
|
#
|
1233
|
+
# @!attribute [rw] max_results
|
1234
|
+
# Maximum number of storage configurations to return. Default: your
|
1235
|
+
# service quota or 100, whichever is smaller.
|
1236
|
+
# @return [Integer]
|
1237
|
+
#
|
1199
1238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStorageConfigurationsRequest AWS API Documentation
|
1200
1239
|
#
|
1201
1240
|
class ListStorageConfigurationsRequest < Struct.new(
|
1202
|
-
:
|
1203
|
-
:
|
1241
|
+
:next_token,
|
1242
|
+
:max_results)
|
1204
1243
|
SENSITIVE = []
|
1205
1244
|
include Aws::Structure
|
1206
1245
|
end
|
1207
1246
|
|
1247
|
+
# @!attribute [rw] storage_configurations
|
1248
|
+
# List of the matching storage configurations.
|
1249
|
+
# @return [Array<Types::StorageConfigurationSummary>]
|
1250
|
+
#
|
1208
1251
|
# @!attribute [rw] next_token
|
1209
1252
|
# If there are more storage configurations than `maxResults`, use
|
1210
1253
|
# `nextToken` in the request to get the next set.
|
1211
1254
|
# @return [String]
|
1212
1255
|
#
|
1213
|
-
# @!attribute [rw] storage_configurations
|
1214
|
-
# List of the matching storage configurations.
|
1215
|
-
# @return [Array<Types::StorageConfigurationSummary>]
|
1216
|
-
#
|
1217
1256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStorageConfigurationsResponse AWS API Documentation
|
1218
1257
|
#
|
1219
1258
|
class ListStorageConfigurationsResponse < Struct.new(
|
1220
|
-
:
|
1221
|
-
:
|
1259
|
+
:storage_configurations,
|
1260
|
+
:next_token)
|
1222
1261
|
SENSITIVE = []
|
1223
1262
|
include Aws::Structure
|
1224
1263
|
end
|
@@ -1251,20 +1290,21 @@ module Aws::IVSRealTime
|
|
1251
1290
|
|
1252
1291
|
# Object describing a participant that has joined a stage.
|
1253
1292
|
#
|
1254
|
-
# @!attribute [rw]
|
1255
|
-
#
|
1256
|
-
#
|
1257
|
-
# maximum length of this field is 1 KB total. *This field is exposed
|
1258
|
-
# to all stage participants and should not be used for personally
|
1259
|
-
# identifying, confidential, or sensitive information*.
|
1260
|
-
# @return [Hash<String,String>]
|
1293
|
+
# @!attribute [rw] participant_id
|
1294
|
+
# Unique identifier for this participant, assigned by IVS.
|
1295
|
+
# @return [String]
|
1261
1296
|
#
|
1262
|
-
# @!attribute [rw]
|
1263
|
-
#
|
1297
|
+
# @!attribute [rw] user_id
|
1298
|
+
# Customer-assigned name to help identify the token; this can be used
|
1299
|
+
# to link a participant to a user in the customer’s own systems. This
|
1300
|
+
# can be any UTF-8 encoded text. *This field is exposed to all stage
|
1301
|
+
# participants and should not be used for personally identifying,
|
1302
|
+
# confidential, or sensitive information*.
|
1264
1303
|
# @return [String]
|
1265
1304
|
#
|
1266
|
-
# @!attribute [rw]
|
1267
|
-
#
|
1305
|
+
# @!attribute [rw] state
|
1306
|
+
# Whether the participant is connected to or disconnected from the
|
1307
|
+
# stage.
|
1268
1308
|
# @return [String]
|
1269
1309
|
#
|
1270
1310
|
# @!attribute [rw] first_join_time
|
@@ -1272,6 +1312,18 @@ module Aws::IVSRealTime
|
|
1272
1312
|
# joined the stage session.
|
1273
1313
|
# @return [Time]
|
1274
1314
|
#
|
1315
|
+
# @!attribute [rw] attributes
|
1316
|
+
# Application-provided attributes to encode into the token and attach
|
1317
|
+
# to a stage. Map keys and values can contain UTF-8 encoded text. The
|
1318
|
+
# maximum length of this field is 1 KB total. *This field is exposed
|
1319
|
+
# to all stage participants and should not be used for personally
|
1320
|
+
# identifying, confidential, or sensitive information*.
|
1321
|
+
# @return [Hash<String,String>]
|
1322
|
+
#
|
1323
|
+
# @!attribute [rw] published
|
1324
|
+
# Whether the participant ever published to the stage session.
|
1325
|
+
# @return [Boolean]
|
1326
|
+
#
|
1275
1327
|
# @!attribute [rw] isp_name
|
1276
1328
|
# The participant’s Internet Service Provider.
|
1277
1329
|
# @return [String]
|
@@ -1284,70 +1336,62 @@ module Aws::IVSRealTime
|
|
1284
1336
|
# The participant’s operating system version.
|
1285
1337
|
# @return [String]
|
1286
1338
|
#
|
1287
|
-
# @!attribute [rw]
|
1288
|
-
#
|
1339
|
+
# @!attribute [rw] browser_name
|
1340
|
+
# The participant’s browser.
|
1289
1341
|
# @return [String]
|
1290
1342
|
#
|
1291
|
-
# @!attribute [rw]
|
1292
|
-
#
|
1293
|
-
# @return [
|
1343
|
+
# @!attribute [rw] browser_version
|
1344
|
+
# The participant’s browser version.
|
1345
|
+
# @return [String]
|
1294
1346
|
#
|
1295
1347
|
# @!attribute [rw] sdk_version
|
1296
1348
|
# The participant’s SDK version.
|
1297
1349
|
# @return [String]
|
1298
1350
|
#
|
1299
|
-
# @!attribute [rw]
|
1300
|
-
#
|
1301
|
-
#
|
1351
|
+
# @!attribute [rw] recording_s3_bucket_name
|
1352
|
+
# Name of the S3 bucket to where the participant is being recorded, if
|
1353
|
+
# individual participant recording is enabled, or "" (empty string),
|
1354
|
+
# if recording is not enabled.
|
1302
1355
|
# @return [String]
|
1303
1356
|
#
|
1304
|
-
# @!attribute [rw]
|
1305
|
-
#
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
#
|
1309
|
-
#
|
1357
|
+
# @!attribute [rw] recording_s3_prefix
|
1358
|
+
# S3 prefix of the S3 bucket to where the participant is being
|
1359
|
+
# recorded, if individual participant recording is enabled, or ""
|
1360
|
+
# (empty string), if recording is not enabled.
|
1361
|
+
# @return [String]
|
1362
|
+
#
|
1363
|
+
# @!attribute [rw] recording_state
|
1364
|
+
# Participant’s recording state.
|
1310
1365
|
# @return [String]
|
1311
1366
|
#
|
1312
1367
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Participant AWS API Documentation
|
1313
1368
|
#
|
1314
1369
|
class Participant < Struct.new(
|
1315
|
-
:
|
1316
|
-
:
|
1317
|
-
:
|
1370
|
+
:participant_id,
|
1371
|
+
:user_id,
|
1372
|
+
:state,
|
1318
1373
|
:first_join_time,
|
1374
|
+
:attributes,
|
1375
|
+
:published,
|
1319
1376
|
:isp_name,
|
1320
1377
|
:os_name,
|
1321
1378
|
:os_version,
|
1322
|
-
:
|
1323
|
-
:
|
1379
|
+
:browser_name,
|
1380
|
+
:browser_version,
|
1324
1381
|
:sdk_version,
|
1325
|
-
:
|
1326
|
-
:
|
1382
|
+
:recording_s3_bucket_name,
|
1383
|
+
:recording_s3_prefix,
|
1384
|
+
:recording_state)
|
1327
1385
|
SENSITIVE = []
|
1328
1386
|
include Aws::Structure
|
1329
1387
|
end
|
1330
1388
|
|
1331
1389
|
# Summary object describing a participant that has joined a stage.
|
1332
1390
|
#
|
1333
|
-
# @!attribute [rw] first_join_time
|
1334
|
-
# ISO 8601 timestamp (returned as a string) when the participant first
|
1335
|
-
# joined the stage session.
|
1336
|
-
# @return [Time]
|
1337
|
-
#
|
1338
1391
|
# @!attribute [rw] participant_id
|
1339
1392
|
# Unique identifier for this participant, assigned by IVS.
|
1340
1393
|
# @return [String]
|
1341
1394
|
#
|
1342
|
-
# @!attribute [rw] published
|
1343
|
-
# Whether the participant ever published to the stage session.
|
1344
|
-
# @return [Boolean]
|
1345
|
-
#
|
1346
|
-
# @!attribute [rw] state
|
1347
|
-
# Whether the participant is connected to or disconnected from the
|
1348
|
-
# stage.
|
1349
|
-
# @return [String]
|
1350
|
-
#
|
1351
1395
|
# @!attribute [rw] user_id
|
1352
1396
|
# Customer-assigned name to help identify the token; this can be used
|
1353
1397
|
# to link a participant to a user in the customer’s own systems. This
|
@@ -1356,14 +1400,33 @@ module Aws::IVSRealTime
|
|
1356
1400
|
# confidential, or sensitive information*.
|
1357
1401
|
# @return [String]
|
1358
1402
|
#
|
1403
|
+
# @!attribute [rw] state
|
1404
|
+
# Whether the participant is connected to or disconnected from the
|
1405
|
+
# stage.
|
1406
|
+
# @return [String]
|
1407
|
+
#
|
1408
|
+
# @!attribute [rw] first_join_time
|
1409
|
+
# ISO 8601 timestamp (returned as a string) when the participant first
|
1410
|
+
# joined the stage session.
|
1411
|
+
# @return [Time]
|
1412
|
+
#
|
1413
|
+
# @!attribute [rw] published
|
1414
|
+
# Whether the participant ever published to the stage session.
|
1415
|
+
# @return [Boolean]
|
1416
|
+
#
|
1417
|
+
# @!attribute [rw] recording_state
|
1418
|
+
# Participant’s recording state.
|
1419
|
+
# @return [String]
|
1420
|
+
#
|
1359
1421
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ParticipantSummary AWS API Documentation
|
1360
1422
|
#
|
1361
1423
|
class ParticipantSummary < Struct.new(
|
1362
|
-
:first_join_time,
|
1363
1424
|
:participant_id,
|
1364
|
-
:
|
1425
|
+
:user_id,
|
1365
1426
|
:state,
|
1366
|
-
:
|
1427
|
+
:first_join_time,
|
1428
|
+
:published,
|
1429
|
+
:recording_state)
|
1367
1430
|
SENSITIVE = []
|
1368
1431
|
include Aws::Structure
|
1369
1432
|
end
|
@@ -1374,6 +1437,22 @@ module Aws::IVSRealTime
|
|
1374
1437
|
# functionality based on token contents. The format of tokens could
|
1375
1438
|
# change in the future.
|
1376
1439
|
#
|
1440
|
+
# @!attribute [rw] participant_id
|
1441
|
+
# Unique identifier for this participant token, assigned by IVS.
|
1442
|
+
# @return [String]
|
1443
|
+
#
|
1444
|
+
# @!attribute [rw] token
|
1445
|
+
# The issued client token, encrypted.
|
1446
|
+
# @return [String]
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] user_id
|
1449
|
+
# Customer-assigned name to help identify the token; this can be used
|
1450
|
+
# to link a participant to a user in the customer’s own systems. This
|
1451
|
+
# can be any UTF-8 encoded text. *This field is exposed to all stage
|
1452
|
+
# participants and should not be used for personally identifying,
|
1453
|
+
# confidential, or sensitive information.*
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1377
1456
|
# @!attribute [rw] attributes
|
1378
1457
|
# Application-provided attributes to encode into the token and attach
|
1379
1458
|
# to a stage. *This field is exposed to all stage participants and
|
@@ -1381,53 +1460,50 @@ module Aws::IVSRealTime
|
|
1381
1460
|
# sensitive information.*
|
1382
1461
|
# @return [Hash<String,String>]
|
1383
1462
|
#
|
1384
|
-
# @!attribute [rw] capabilities
|
1385
|
-
# Set of capabilities that the user is allowed to perform in the
|
1386
|
-
# stage.
|
1387
|
-
# @return [Array<String>]
|
1388
|
-
#
|
1389
1463
|
# @!attribute [rw] duration
|
1390
1464
|
# Duration (in minutes), after which the participant token expires.
|
1391
1465
|
# Default: 720 (12 hours).
|
1392
1466
|
# @return [Integer]
|
1393
1467
|
#
|
1468
|
+
# @!attribute [rw] capabilities
|
1469
|
+
# Set of capabilities that the user is allowed to perform in the
|
1470
|
+
# stage.
|
1471
|
+
# @return [Array<String>]
|
1472
|
+
#
|
1394
1473
|
# @!attribute [rw] expiration_time
|
1395
1474
|
# ISO 8601 timestamp (returned as a string) for when this token
|
1396
1475
|
# expires.
|
1397
1476
|
# @return [Time]
|
1398
1477
|
#
|
1399
|
-
# @!attribute [rw] participant_id
|
1400
|
-
# Unique identifier for this participant token, assigned by IVS.
|
1401
|
-
# @return [String]
|
1402
|
-
#
|
1403
|
-
# @!attribute [rw] token
|
1404
|
-
# The issued client token, encrypted.
|
1405
|
-
# @return [String]
|
1406
|
-
#
|
1407
|
-
# @!attribute [rw] user_id
|
1408
|
-
# Customer-assigned name to help identify the token; this can be used
|
1409
|
-
# to link a participant to a user in the customer’s own systems. This
|
1410
|
-
# can be any UTF-8 encoded text. *This field is exposed to all stage
|
1411
|
-
# participants and should not be used for personally identifying,
|
1412
|
-
# confidential, or sensitive information.*
|
1413
|
-
# @return [String]
|
1414
|
-
#
|
1415
1478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ParticipantToken AWS API Documentation
|
1416
1479
|
#
|
1417
1480
|
class ParticipantToken < Struct.new(
|
1418
|
-
:attributes,
|
1419
|
-
:capabilities,
|
1420
|
-
:duration,
|
1421
|
-
:expiration_time,
|
1422
1481
|
:participant_id,
|
1423
1482
|
:token,
|
1424
|
-
:user_id
|
1483
|
+
:user_id,
|
1484
|
+
:attributes,
|
1485
|
+
:duration,
|
1486
|
+
:capabilities,
|
1487
|
+
:expiration_time)
|
1425
1488
|
SENSITIVE = [:token]
|
1426
1489
|
include Aws::Structure
|
1427
1490
|
end
|
1428
1491
|
|
1429
1492
|
# Object specifying a participant token configuration in a stage.
|
1430
1493
|
#
|
1494
|
+
# @!attribute [rw] duration
|
1495
|
+
# Duration (in minutes), after which the corresponding participant
|
1496
|
+
# token expires. Default: 720 (12 hours).
|
1497
|
+
# @return [Integer]
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] user_id
|
1500
|
+
# Customer-assigned name to help identify the token; this can be used
|
1501
|
+
# to link a participant to a user in the customer’s own systems. This
|
1502
|
+
# can be any UTF-8 encoded text. *This field is exposed to all stage
|
1503
|
+
# participants and should not be used for personally identifying,
|
1504
|
+
# confidential, or sensitive information.*
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1431
1507
|
# @!attribute [rw] attributes
|
1432
1508
|
# Application-provided attributes to encode into the corresponding
|
1433
1509
|
# participant token and attach to a stage. Map keys and values can
|
@@ -1442,26 +1518,13 @@ module Aws::IVSRealTime
|
|
1442
1518
|
# stage.
|
1443
1519
|
# @return [Array<String>]
|
1444
1520
|
#
|
1445
|
-
# @!attribute [rw] duration
|
1446
|
-
# Duration (in minutes), after which the corresponding participant
|
1447
|
-
# token expires. Default: 720 (12 hours).
|
1448
|
-
# @return [Integer]
|
1449
|
-
#
|
1450
|
-
# @!attribute [rw] user_id
|
1451
|
-
# Customer-assigned name to help identify the token; this can be used
|
1452
|
-
# to link a participant to a user in the customer’s own systems. This
|
1453
|
-
# can be any UTF-8 encoded text. *This field is exposed to all stage
|
1454
|
-
# participants and should not be used for personally identifying,
|
1455
|
-
# confidential, or sensitive information.*
|
1456
|
-
# @return [String]
|
1457
|
-
#
|
1458
1521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ParticipantTokenConfiguration AWS API Documentation
|
1459
1522
|
#
|
1460
1523
|
class ParticipantTokenConfiguration < Struct.new(
|
1461
|
-
:attributes,
|
1462
|
-
:capabilities,
|
1463
1524
|
:duration,
|
1464
|
-
:user_id
|
1525
|
+
:user_id,
|
1526
|
+
:attributes,
|
1527
|
+
:capabilities)
|
1465
1528
|
SENSITIVE = []
|
1466
1529
|
include Aws::Structure
|
1467
1530
|
end
|
@@ -1491,38 +1554,37 @@ module Aws::IVSRealTime
|
|
1491
1554
|
# ParticipantTokenConfiguration is placed in the featured slot.
|
1492
1555
|
# @return [String]
|
1493
1556
|
#
|
1557
|
+
# @!attribute [rw] omit_stopped_video
|
1558
|
+
# Determines whether to omit participants with stopped video in the
|
1559
|
+
# composition. Default: `false`.
|
1560
|
+
# @return [Boolean]
|
1561
|
+
#
|
1562
|
+
# @!attribute [rw] video_fill_mode
|
1563
|
+
# Defines how video fits within the participant tile. Default:
|
1564
|
+
# `COVER`.
|
1565
|
+
# @return [String]
|
1566
|
+
#
|
1494
1567
|
# @!attribute [rw] grid_gap
|
1495
1568
|
# Specifies the spacing between participant tiles in pixels. Default:
|
1496
1569
|
# `0`.
|
1497
1570
|
# @return [Integer]
|
1498
1571
|
#
|
1499
|
-
# @!attribute [rw]
|
1500
|
-
#
|
1501
|
-
#
|
1502
|
-
#
|
1572
|
+
# @!attribute [rw] pip_participant_attribute
|
1573
|
+
# Identifies the PiP slot. A participant with this attribute set to
|
1574
|
+
# `"true"` (as a string value) in ParticipantTokenConfiguration is
|
1575
|
+
# placed in the PiP slot.
|
1576
|
+
# @return [String]
|
1503
1577
|
#
|
1504
1578
|
# @!attribute [rw] pip_behavior
|
1505
1579
|
# Defines PiP behavior when all participants have left. Default:
|
1506
1580
|
# `STATIC`.
|
1507
1581
|
# @return [String]
|
1508
1582
|
#
|
1509
|
-
# @!attribute [rw] pip_height
|
1510
|
-
# Specifies the height of the PiP window in pixels. When this is not
|
1511
|
-
# set explicitly, `pipHeight`’s value will be based on the size of the
|
1512
|
-
# composition and the aspect ratio of the participant’s video.
|
1513
|
-
# @return [Integer]
|
1514
|
-
#
|
1515
1583
|
# @!attribute [rw] pip_offset
|
1516
1584
|
# Sets the PiP window’s offset position in pixels from the closest
|
1517
1585
|
# edges determined by `PipPosition`. Default: `0`.
|
1518
1586
|
# @return [Integer]
|
1519
1587
|
#
|
1520
|
-
# @!attribute [rw] pip_participant_attribute
|
1521
|
-
# Identifies the PiP slot. A participant with this attribute set to
|
1522
|
-
# `"true"` (as a string value) in ParticipantTokenConfiguration is
|
1523
|
-
# placed in the PiP slot.
|
1524
|
-
# @return [String]
|
1525
|
-
#
|
1526
1588
|
# @!attribute [rw] pip_position
|
1527
1589
|
# Determines the corner position of the PiP window. Default:
|
1528
1590
|
# `BOTTOM_RIGHT`.
|
@@ -1534,24 +1596,25 @@ module Aws::IVSRealTime
|
|
1534
1596
|
# composition and the aspect ratio of the participant’s video.
|
1535
1597
|
# @return [Integer]
|
1536
1598
|
#
|
1537
|
-
# @!attribute [rw]
|
1538
|
-
#
|
1539
|
-
# `
|
1540
|
-
#
|
1599
|
+
# @!attribute [rw] pip_height
|
1600
|
+
# Specifies the height of the PiP window in pixels. When this is not
|
1601
|
+
# set explicitly, `pipHeight`’s value will be based on the size of the
|
1602
|
+
# composition and the aspect ratio of the participant’s video.
|
1603
|
+
# @return [Integer]
|
1541
1604
|
#
|
1542
1605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/PipConfiguration AWS API Documentation
|
1543
1606
|
#
|
1544
1607
|
class PipConfiguration < Struct.new(
|
1545
1608
|
:featured_participant_attribute,
|
1546
|
-
:grid_gap,
|
1547
1609
|
:omit_stopped_video,
|
1610
|
+
:video_fill_mode,
|
1611
|
+
:grid_gap,
|
1612
|
+
:pip_participant_attribute,
|
1548
1613
|
:pip_behavior,
|
1549
|
-
:pip_height,
|
1550
1614
|
:pip_offset,
|
1551
|
-
:pip_participant_attribute,
|
1552
1615
|
:pip_position,
|
1553
1616
|
:pip_width,
|
1554
|
-
:
|
1617
|
+
:pip_height)
|
1555
1618
|
SENSITIVE = []
|
1556
1619
|
include Aws::Structure
|
1557
1620
|
end
|
@@ -1585,6 +1648,11 @@ module Aws::IVSRealTime
|
|
1585
1648
|
# A complex type that describes an S3 location where recorded videos
|
1586
1649
|
# will be stored.
|
1587
1650
|
#
|
1651
|
+
# @!attribute [rw] storage_configuration_arn
|
1652
|
+
# ARN of the StorageConfiguration where recorded videos will be
|
1653
|
+
# stored.
|
1654
|
+
# @return [String]
|
1655
|
+
#
|
1588
1656
|
# @!attribute [rw] encoder_configuration_arns
|
1589
1657
|
# ARNs of the EncoderConfiguration resource. The encoder configuration
|
1590
1658
|
# and stage resources must be in the same AWS account and region.
|
@@ -1596,17 +1664,12 @@ module Aws::IVSRealTime
|
|
1596
1664
|
# the recording format for storing a recording in Amazon S3.
|
1597
1665
|
# @return [Types::RecordingConfiguration]
|
1598
1666
|
#
|
1599
|
-
# @!attribute [rw] storage_configuration_arn
|
1600
|
-
# ARN of the StorageConfiguration where recorded videos will be
|
1601
|
-
# stored.
|
1602
|
-
# @return [String]
|
1603
|
-
#
|
1604
1667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/S3DestinationConfiguration AWS API Documentation
|
1605
1668
|
#
|
1606
1669
|
class S3DestinationConfiguration < Struct.new(
|
1670
|
+
:storage_configuration_arn,
|
1607
1671
|
:encoder_configuration_arns,
|
1608
|
-
:recording_configuration
|
1609
|
-
:storage_configuration_arn)
|
1672
|
+
:recording_configuration)
|
1610
1673
|
SENSITIVE = []
|
1611
1674
|
include Aws::Structure
|
1612
1675
|
end
|
@@ -1656,10 +1719,6 @@ module Aws::IVSRealTime
|
|
1656
1719
|
|
1657
1720
|
# Object specifying a stage.
|
1658
1721
|
#
|
1659
|
-
# @!attribute [rw] active_session_id
|
1660
|
-
# ID of the active session within the stage.
|
1661
|
-
# @return [String]
|
1662
|
-
#
|
1663
1722
|
# @!attribute [rw] arn
|
1664
1723
|
# Stage ARN.
|
1665
1724
|
# @return [String]
|
@@ -1668,6 +1727,10 @@ module Aws::IVSRealTime
|
|
1668
1727
|
# Stage name.
|
1669
1728
|
# @return [String]
|
1670
1729
|
#
|
1730
|
+
# @!attribute [rw] active_session_id
|
1731
|
+
# ID of the active session within the stage.
|
1732
|
+
# @return [String]
|
1733
|
+
#
|
1671
1734
|
# @!attribute [rw] tags
|
1672
1735
|
# Tags attached to the resource. Array of maps, each of the form
|
1673
1736
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -1680,13 +1743,19 @@ module Aws::IVSRealTime
|
|
1680
1743
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1681
1744
|
# @return [Hash<String,String>]
|
1682
1745
|
#
|
1746
|
+
# @!attribute [rw] auto_participant_recording_configuration
|
1747
|
+
# Auto-participant-recording configuration object attached to the
|
1748
|
+
# stage.
|
1749
|
+
# @return [Types::AutoParticipantRecordingConfiguration]
|
1750
|
+
#
|
1683
1751
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Stage AWS API Documentation
|
1684
1752
|
#
|
1685
1753
|
class Stage < Struct.new(
|
1686
|
-
:active_session_id,
|
1687
1754
|
:arn,
|
1688
1755
|
:name,
|
1689
|
-
:
|
1756
|
+
:active_session_id,
|
1757
|
+
:tags,
|
1758
|
+
:auto_participant_recording_configuration)
|
1690
1759
|
SENSITIVE = []
|
1691
1760
|
include Aws::Structure
|
1692
1761
|
end
|
@@ -1697,11 +1766,6 @@ module Aws::IVSRealTime
|
|
1697
1766
|
# shorter periods of time (i.e., a session), which is helpful when
|
1698
1767
|
# stages are used over long periods of time.
|
1699
1768
|
#
|
1700
|
-
# @!attribute [rw] end_time
|
1701
|
-
# ISO 8601 timestamp (returned as a string) when the stage session
|
1702
|
-
# ended. This is null if the stage is active.
|
1703
|
-
# @return [Time]
|
1704
|
-
#
|
1705
1769
|
# @!attribute [rw] session_id
|
1706
1770
|
# ID of the session within the stage.
|
1707
1771
|
# @return [String]
|
@@ -1711,23 +1775,23 @@ module Aws::IVSRealTime
|
|
1711
1775
|
# began.
|
1712
1776
|
# @return [Time]
|
1713
1777
|
#
|
1778
|
+
# @!attribute [rw] end_time
|
1779
|
+
# ISO 8601 timestamp (returned as a string) when the stage session
|
1780
|
+
# ended. This is null if the stage is active.
|
1781
|
+
# @return [Time]
|
1782
|
+
#
|
1714
1783
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StageSession AWS API Documentation
|
1715
1784
|
#
|
1716
1785
|
class StageSession < Struct.new(
|
1717
|
-
:end_time,
|
1718
1786
|
:session_id,
|
1719
|
-
:start_time
|
1787
|
+
:start_time,
|
1788
|
+
:end_time)
|
1720
1789
|
SENSITIVE = []
|
1721
1790
|
include Aws::Structure
|
1722
1791
|
end
|
1723
1792
|
|
1724
1793
|
# Summary information about a stage session.
|
1725
1794
|
#
|
1726
|
-
# @!attribute [rw] end_time
|
1727
|
-
# ISO 8601 timestamp (returned as a string) when the stage session
|
1728
|
-
# ended. This is null if the stage is active.
|
1729
|
-
# @return [Time]
|
1730
|
-
#
|
1731
1795
|
# @!attribute [rw] session_id
|
1732
1796
|
# ID of the session within the stage.
|
1733
1797
|
# @return [String]
|
@@ -1737,22 +1801,23 @@ module Aws::IVSRealTime
|
|
1737
1801
|
# began.
|
1738
1802
|
# @return [Time]
|
1739
1803
|
#
|
1804
|
+
# @!attribute [rw] end_time
|
1805
|
+
# ISO 8601 timestamp (returned as a string) when the stage session
|
1806
|
+
# ended. This is null if the stage is active.
|
1807
|
+
# @return [Time]
|
1808
|
+
#
|
1740
1809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StageSessionSummary AWS API Documentation
|
1741
1810
|
#
|
1742
1811
|
class StageSessionSummary < Struct.new(
|
1743
|
-
:end_time,
|
1744
1812
|
:session_id,
|
1745
|
-
:start_time
|
1813
|
+
:start_time,
|
1814
|
+
:end_time)
|
1746
1815
|
SENSITIVE = []
|
1747
1816
|
include Aws::Structure
|
1748
1817
|
end
|
1749
1818
|
|
1750
1819
|
# Summary information about a stage.
|
1751
1820
|
#
|
1752
|
-
# @!attribute [rw] active_session_id
|
1753
|
-
# ID of the active session within the stage.
|
1754
|
-
# @return [String]
|
1755
|
-
#
|
1756
1821
|
# @!attribute [rw] arn
|
1757
1822
|
# Stage ARN.
|
1758
1823
|
# @return [String]
|
@@ -1761,6 +1826,10 @@ module Aws::IVSRealTime
|
|
1761
1826
|
# Stage name.
|
1762
1827
|
# @return [String]
|
1763
1828
|
#
|
1829
|
+
# @!attribute [rw] active_session_id
|
1830
|
+
# ID of the active session within the stage.
|
1831
|
+
# @return [String]
|
1832
|
+
#
|
1764
1833
|
# @!attribute [rw] tags
|
1765
1834
|
# Tags attached to the resource. Array of maps, each of the form
|
1766
1835
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -1776,17 +1845,17 @@ module Aws::IVSRealTime
|
|
1776
1845
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StageSummary AWS API Documentation
|
1777
1846
|
#
|
1778
1847
|
class StageSummary < Struct.new(
|
1779
|
-
:active_session_id,
|
1780
1848
|
:arn,
|
1781
1849
|
:name,
|
1850
|
+
:active_session_id,
|
1782
1851
|
:tags)
|
1783
1852
|
SENSITIVE = []
|
1784
1853
|
include Aws::Structure
|
1785
1854
|
end
|
1786
1855
|
|
1787
|
-
# @!attribute [rw]
|
1788
|
-
#
|
1789
|
-
# @return [
|
1856
|
+
# @!attribute [rw] stage_arn
|
1857
|
+
# ARN of the stage to be used for compositing.
|
1858
|
+
# @return [String]
|
1790
1859
|
#
|
1791
1860
|
# @!attribute [rw] idempotency_token
|
1792
1861
|
# Idempotency token.
|
@@ -1799,9 +1868,9 @@ module Aws::IVSRealTime
|
|
1799
1868
|
# Layout object to configure composition parameters.
|
1800
1869
|
# @return [Types::LayoutConfiguration]
|
1801
1870
|
#
|
1802
|
-
# @!attribute [rw]
|
1803
|
-
#
|
1804
|
-
# @return [
|
1871
|
+
# @!attribute [rw] destinations
|
1872
|
+
# Array of destination configuration.
|
1873
|
+
# @return [Array<Types::DestinationConfiguration>]
|
1805
1874
|
#
|
1806
1875
|
# @!attribute [rw] tags
|
1807
1876
|
# Tags attached to the resource. Array of maps, each of the form
|
@@ -1818,10 +1887,10 @@ module Aws::IVSRealTime
|
|
1818
1887
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StartCompositionRequest AWS API Documentation
|
1819
1888
|
#
|
1820
1889
|
class StartCompositionRequest < Struct.new(
|
1821
|
-
:
|
1890
|
+
:stage_arn,
|
1822
1891
|
:idempotency_token,
|
1823
1892
|
:layout,
|
1824
|
-
:
|
1893
|
+
:destinations,
|
1825
1894
|
:tags)
|
1826
1895
|
SENSITIVE = []
|
1827
1896
|
include Aws::Structure
|
@@ -1998,11 +2067,18 @@ module Aws::IVSRealTime
|
|
1998
2067
|
# Name of the stage to be updated.
|
1999
2068
|
# @return [String]
|
2000
2069
|
#
|
2070
|
+
# @!attribute [rw] auto_participant_recording_configuration
|
2071
|
+
# Auto-participant-recording configuration object to attach to the
|
2072
|
+
# stage. Auto-participant-recording configuration cannot be updated
|
2073
|
+
# while recording is active.
|
2074
|
+
# @return [Types::AutoParticipantRecordingConfiguration]
|
2075
|
+
#
|
2001
2076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateStageRequest AWS API Documentation
|
2002
2077
|
#
|
2003
2078
|
class UpdateStageRequest < Struct.new(
|
2004
2079
|
:arn,
|
2005
|
-
:name
|
2080
|
+
:name,
|
2081
|
+
:auto_participant_recording_configuration)
|
2006
2082
|
SENSITIVE = []
|
2007
2083
|
include Aws::Structure
|
2008
2084
|
end
|
@@ -2034,33 +2110,33 @@ module Aws::IVSRealTime
|
|
2034
2110
|
|
2035
2111
|
# Settings for video.
|
2036
2112
|
#
|
2037
|
-
# @!attribute [rw]
|
2038
|
-
#
|
2113
|
+
# @!attribute [rw] width
|
2114
|
+
# Video-resolution width. Note that the maximum value is determined by
|
2115
|
+
# `width` times `height`, such that the maximum total pixels is
|
2116
|
+
# 2073600 (1920x1080 or 1080x1920). Default: 1280.
|
2039
2117
|
# @return [Integer]
|
2040
2118
|
#
|
2041
|
-
# @!attribute [rw] framerate
|
2042
|
-
# Video frame rate, in fps. Default: 30.
|
2043
|
-
# @return [Float]
|
2044
|
-
#
|
2045
2119
|
# @!attribute [rw] height
|
2046
2120
|
# Video-resolution height. Note that the maximum value is determined
|
2047
2121
|
# by `width` times `height`, such that the maximum total pixels is
|
2048
2122
|
# 2073600 (1920x1080 or 1080x1920). Default: 720.
|
2049
2123
|
# @return [Integer]
|
2050
2124
|
#
|
2051
|
-
# @!attribute [rw]
|
2052
|
-
# Video
|
2053
|
-
#
|
2054
|
-
#
|
2125
|
+
# @!attribute [rw] framerate
|
2126
|
+
# Video frame rate, in fps. Default: 30.
|
2127
|
+
# @return [Float]
|
2128
|
+
#
|
2129
|
+
# @!attribute [rw] bitrate
|
2130
|
+
# Bitrate for generated output, in bps. Default: 2500000.
|
2055
2131
|
# @return [Integer]
|
2056
2132
|
#
|
2057
2133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Video AWS API Documentation
|
2058
2134
|
#
|
2059
2135
|
class Video < Struct.new(
|
2060
|
-
:
|
2061
|
-
:framerate,
|
2136
|
+
:width,
|
2062
2137
|
:height,
|
2063
|
-
:
|
2138
|
+
:framerate,
|
2139
|
+
:bitrate)
|
2064
2140
|
SENSITIVE = []
|
2065
2141
|
include Aws::Structure
|
2066
2142
|
end
|