tencentcloud-sdk-python-intl-en 3.0.1074__py2.py3-none-any.whl → 3.0.1076__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.
- tencentcloud/__init__.py +1 -1
- tencentcloud/advisor/v20200721/models.py +120 -0
- tencentcloud/aiart/v20221229/models.py +95 -0
- tencentcloud/ams/v20201229/models.py +432 -0
- tencentcloud/antiddos/v20200309/models.py +2806 -0
- tencentcloud/apigateway/v20180808/models.py +3945 -0
- tencentcloud/autoscaling/v20180419/models.py +2449 -5
- tencentcloud/batch/v20170312/models.py +1566 -0
- tencentcloud/billing/v20180709/models.py +2418 -0
- tencentcloud/cam/v20190116/models.py +1697 -0
- tencentcloud/captcha/v20190722/models.py +70 -0
- tencentcloud/car/v20220110/models.py +803 -0
- tencentcloud/cbs/v20170312/models.py +1245 -0
- tencentcloud/ccc/v20200210/models.py +1949 -1
- tencentcloud/cdb/v20170320/models.py +4821 -0
- tencentcloud/cdn/v20180606/models.py +4870 -8
- tencentcloud/cdwdoris/v20211228/models.py +3337 -0
- tencentcloud/cfg/v20210820/models.py +1194 -0
- tencentcloud/cfs/v20190719/models.py +1178 -0
- tencentcloud/cfw/v20190904/models.py +2378 -0
- tencentcloud/chdfs/v20201112/models.py +513 -0
- tencentcloud/ciam/v20210420/models.py +49 -0
- tencentcloud/ciam/v20220331/models.py +789 -0
- tencentcloud/ckafka/v20190819/models.py +2576 -0
- tencentcloud/clb/v20180317/models.py +3220 -1
- tencentcloud/cloudaudit/v20190319/models.py +519 -0
- tencentcloud/cls/v20201016/models.py +3652 -1
- tencentcloud/cmq/v20190304/models.py +571 -0
- tencentcloud/controlcenter/v20230110/models.py +15 -0
- tencentcloud/csip/v20221121/models.py +2881 -2
- tencentcloud/cvm/v20170312/models.py +2827 -0
- tencentcloud/cwp/v20180228/models.py +16412 -0
- tencentcloud/cynosdb/v20190107/models.py +4267 -4
- tencentcloud/dataintegration/v20220613/models.py +18 -0
- tencentcloud/dayu/v20180709/models.py +3541 -12
- tencentcloud/dbbrain/v20191016/models.py +1056 -0
- tencentcloud/dbbrain/v20210527/models.py +1763 -0
- tencentcloud/dc/v20180410/models.py +767 -0
- tencentcloud/dcdb/v20180411/models.py +2335 -0
- tencentcloud/dlc/v20210125/models.py +3985 -5
- tencentcloud/dms/v20200819/models.py +51 -0
- tencentcloud/dnspod/v20210323/models.py +1286 -0
- tencentcloud/domain/v20180808/models.py +855 -0
- tencentcloud/dts/v20180330/models.py +791 -0
- tencentcloud/dts/v20211206/models.py +2317 -1
- tencentcloud/eb/v20210416/models.py +858 -0
- tencentcloud/ecdn/v20191012/models.py +811 -0
- tencentcloud/ecm/v20190719/models.py +3972 -1
- tencentcloud/eiam/v20210420/models.py +1265 -0
- tencentcloud/emr/v20190103/models.py +2926 -7
- tencentcloud/es/v20180416/errorcodes.py +48 -0
- tencentcloud/es/v20180416/models.py +1525 -2
- tencentcloud/facefusion/v20220927/errorcodes.py +18 -0
- tencentcloud/facefusion/v20220927/facefusion_client.py +46 -0
- tencentcloud/facefusion/v20220927/models.py +818 -0
- tencentcloud/faceid/v20180301/models.py +2071 -0
- tencentcloud/gaap/v20180529/models.py +3103 -8
- tencentcloud/gme/v20180711/models.py +388 -0
- tencentcloud/gpm/v20200820/models.py +674 -0
- tencentcloud/gse/v20191112/models.py +972 -0
- tencentcloud/iai/v20200303/models.py +1430 -0
- tencentcloud/ims/v20201229/models.py +329 -0
- tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
- tencentcloud/iotcloud/v20210408/models.py +585 -0
- tencentcloud/ip/v20210409/models.py +178 -0
- tencentcloud/kms/v20190118/models.py +869 -0
- tencentcloud/lcic/v20220817/models.py +1658 -0
- tencentcloud/lighthouse/v20200324/models.py +2088 -0
- tencentcloud/live/v20180801/models.py +4287 -0
- tencentcloud/mariadb/v20170312/models.py +1905 -0
- tencentcloud/mdc/v20200828/models.py +1104 -0
- tencentcloud/mdl/v20200326/models.py +1911 -1
- tencentcloud/mdp/v20200527/models.py +452 -0
- tencentcloud/mongodb/v20190725/models.py +1234 -0
- tencentcloud/monitor/v20180724/models.py +5798 -2
- tencentcloud/mps/v20190612/models.py +8699 -105
- tencentcloud/msp/v20180319/models.py +183 -0
- tencentcloud/ocr/v20181119/models.py +3160 -1
- tencentcloud/omics/v20221128/models.py +1086 -0
- tencentcloud/organization/v20181225/models.py +285 -0
- tencentcloud/organization/v20210331/models.py +2267 -0
- tencentcloud/postgres/v20170312/models.py +3248 -0
- tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
- tencentcloud/privatedns/v20201028/models.py +1700 -0
- tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
- tencentcloud/redis/v20180412/models.py +3298 -3
- tencentcloud/rum/v20210622/models.py +2114 -0
- tencentcloud/scf/v20180416/models.py +1561 -0
- tencentcloud/ses/v20201002/models.py +649 -0
- tencentcloud/sms/v20190711/models.py +575 -0
- tencentcloud/sms/v20210111/models.py +593 -0
- tencentcloud/sqlserver/v20180328/models.py +2921 -2
- tencentcloud/ssl/v20191205/models.py +2267 -0
- tencentcloud/ssm/v20190923/models.py +678 -0
- tencentcloud/sts/v20180813/models.py +161 -0
- tencentcloud/tag/v20180813/models.py +784 -0
- tencentcloud/tat/v20201028/models.py +806 -0
- tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
- tencentcloud/tchd/v20230306/models.py +41 -0
- tencentcloud/tcmpp/v20240801/models.py +3761 -1
- tencentcloud/tcr/v20190924/models.py +1851 -0
- tencentcloud/tcss/v20201101/models.py +12523 -0
- tencentcloud/tdid/v20210519/models.py +1258 -0
- tencentcloud/tdmq/v20200217/models.py +3495 -0
- tencentcloud/tem/v20201221/models.py +803 -0
- tencentcloud/tem/v20210701/models.py +2551 -1
- tencentcloud/teo/v20220106/models.py +4731 -0
- tencentcloud/teo/v20220901/models.py +6066 -0
- tencentcloud/tiw/v20190919/models.py +1678 -1
- tencentcloud/tke/v20180525/models.py +3662 -0
- tencentcloud/tms/v20201229/models.py +176 -0
- tencentcloud/tmt/v20180321/models.py +65 -0
- tencentcloud/trtc/v20190722/models.py +1698 -8
- tencentcloud/tts/v20190823/models.py +72 -0
- tencentcloud/vm/v20201229/models.py +568 -0
- tencentcloud/vm/v20210922/models.py +636 -0
- tencentcloud/vod/v20180717/models.py +14078 -1
- tencentcloud/vod/v20180717/vod_client.py +33 -0
- tencentcloud/vpc/v20170312/models.py +6543 -1
- tencentcloud/waf/v20180125/models.py +4814 -0
- tencentcloud/wedata/v20210820/models.py +12594 -0
- tencentcloud/yunjing/v20180228/models.py +1867 -0
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/RECORD +126 -126
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_intl_en-3.0.1074.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/top_level.txt +0 -0
|
@@ -41,6 +41,9 @@ class ApplicationItem(AbstractModel):
|
|
|
41
41
|
|
|
42
42
|
@property
|
|
43
43
|
def SdkAppId(self):
|
|
44
|
+
"""SdkAppId of the whiteboard application.
|
|
45
|
+
:rtype: int
|
|
46
|
+
"""
|
|
44
47
|
return self._SdkAppId
|
|
45
48
|
|
|
46
49
|
@SdkAppId.setter
|
|
@@ -49,6 +52,9 @@ class ApplicationItem(AbstractModel):
|
|
|
49
52
|
|
|
50
53
|
@property
|
|
51
54
|
def AppName(self):
|
|
55
|
+
"""Application name.
|
|
56
|
+
:rtype: str
|
|
57
|
+
"""
|
|
52
58
|
return self._AppName
|
|
53
59
|
|
|
54
60
|
@AppName.setter
|
|
@@ -57,6 +63,9 @@ class ApplicationItem(AbstractModel):
|
|
|
57
63
|
|
|
58
64
|
@property
|
|
59
65
|
def CreateTime(self):
|
|
66
|
+
"""Creation time.
|
|
67
|
+
:rtype: str
|
|
68
|
+
"""
|
|
60
69
|
return self._CreateTime
|
|
61
70
|
|
|
62
71
|
@CreateTime.setter
|
|
@@ -65,6 +74,9 @@ class ApplicationItem(AbstractModel):
|
|
|
65
74
|
|
|
66
75
|
@property
|
|
67
76
|
def TagList(self):
|
|
77
|
+
"""Tag list.
|
|
78
|
+
:rtype: list of Tag
|
|
79
|
+
"""
|
|
68
80
|
return self._TagList
|
|
69
81
|
|
|
70
82
|
@TagList.setter
|
|
@@ -112,6 +124,9 @@ class ApplyTiwTrialResponse(AbstractModel):
|
|
|
112
124
|
|
|
113
125
|
@property
|
|
114
126
|
def RequestId(self):
|
|
127
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
128
|
+
:rtype: str
|
|
129
|
+
"""
|
|
115
130
|
return self._RequestId
|
|
116
131
|
|
|
117
132
|
@RequestId.setter
|
|
@@ -143,6 +158,9 @@ class AuthParam(AbstractModel):
|
|
|
143
158
|
|
|
144
159
|
@property
|
|
145
160
|
def SdkAppId(self):
|
|
161
|
+
"""SdkAppId of the whiteboard application.
|
|
162
|
+
:rtype: int
|
|
163
|
+
"""
|
|
146
164
|
return self._SdkAppId
|
|
147
165
|
|
|
148
166
|
@SdkAppId.setter
|
|
@@ -151,6 +169,9 @@ class AuthParam(AbstractModel):
|
|
|
151
169
|
|
|
152
170
|
@property
|
|
153
171
|
def UserId(self):
|
|
172
|
+
"""User ID.
|
|
173
|
+
:rtype: str
|
|
174
|
+
"""
|
|
154
175
|
return self._UserId
|
|
155
176
|
|
|
156
177
|
@UserId.setter
|
|
@@ -159,6 +180,9 @@ class AuthParam(AbstractModel):
|
|
|
159
180
|
|
|
160
181
|
@property
|
|
161
182
|
def UserSig(self):
|
|
183
|
+
"""Signature corresponding to the user ID.
|
|
184
|
+
:rtype: str
|
|
185
|
+
"""
|
|
162
186
|
return self._UserSig
|
|
163
187
|
|
|
164
188
|
@UserSig.setter
|
|
@@ -197,6 +221,9 @@ class Canvas(AbstractModel):
|
|
|
197
221
|
|
|
198
222
|
@property
|
|
199
223
|
def LayoutParams(self):
|
|
224
|
+
"""Width and height of the mixed stream canvas
|
|
225
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.LayoutParams`
|
|
226
|
+
"""
|
|
200
227
|
return self._LayoutParams
|
|
201
228
|
|
|
202
229
|
@LayoutParams.setter
|
|
@@ -205,6 +232,9 @@ class Canvas(AbstractModel):
|
|
|
205
232
|
|
|
206
233
|
@property
|
|
207
234
|
def BackgroundColor(self):
|
|
235
|
+
"""Background color, which is black by default. Its format is RGB. for example, "#FF0000" for the red color.
|
|
236
|
+
:rtype: str
|
|
237
|
+
"""
|
|
208
238
|
return self._BackgroundColor
|
|
209
239
|
|
|
210
240
|
@BackgroundColor.setter
|
|
@@ -245,6 +275,10 @@ If the video splicing feature is enabled, the real-time recording service will s
|
|
|
245
275
|
|
|
246
276
|
@property
|
|
247
277
|
def Enabled(self):
|
|
278
|
+
"""Whether to enable the video splicing feature
|
|
279
|
+
If the video splicing feature is enabled, the real-time recording service will splice multiple video clips resulting from the pause into one video.
|
|
280
|
+
:rtype: bool
|
|
281
|
+
"""
|
|
248
282
|
return self._Enabled
|
|
249
283
|
|
|
250
284
|
@Enabled.setter
|
|
@@ -253,6 +287,9 @@ If the video splicing feature is enabled, the real-time recording service will s
|
|
|
253
287
|
|
|
254
288
|
@property
|
|
255
289
|
def Image(self):
|
|
290
|
+
"""Download address of the padding image used during video splicing. If it is not specified, a pure black image is used by default.
|
|
291
|
+
:rtype: str
|
|
292
|
+
"""
|
|
256
293
|
return self._Image
|
|
257
294
|
|
|
258
295
|
@Image.setter
|
|
@@ -299,6 +336,9 @@ class CreateApplicationRequest(AbstractModel):
|
|
|
299
336
|
|
|
300
337
|
@property
|
|
301
338
|
def SdkAppId(self):
|
|
339
|
+
"""SdkAppId of the whiteboard application.
|
|
340
|
+
:rtype: int
|
|
341
|
+
"""
|
|
302
342
|
return self._SdkAppId
|
|
303
343
|
|
|
304
344
|
@SdkAppId.setter
|
|
@@ -307,6 +347,9 @@ class CreateApplicationRequest(AbstractModel):
|
|
|
307
347
|
|
|
308
348
|
@property
|
|
309
349
|
def AppName(self):
|
|
350
|
+
"""Application name.
|
|
351
|
+
:rtype: str
|
|
352
|
+
"""
|
|
310
353
|
return self._AppName
|
|
311
354
|
|
|
312
355
|
@AppName.setter
|
|
@@ -315,6 +358,9 @@ class CreateApplicationRequest(AbstractModel):
|
|
|
315
358
|
|
|
316
359
|
@property
|
|
317
360
|
def SKey(self):
|
|
361
|
+
"""SKey required for creating an IM application.
|
|
362
|
+
:rtype: str
|
|
363
|
+
"""
|
|
318
364
|
return self._SKey
|
|
319
365
|
|
|
320
366
|
@SKey.setter
|
|
@@ -323,6 +369,9 @@ class CreateApplicationRequest(AbstractModel):
|
|
|
323
369
|
|
|
324
370
|
@property
|
|
325
371
|
def TinyId(self):
|
|
372
|
+
"""TinyId required for creating an IM application.
|
|
373
|
+
:rtype: str
|
|
374
|
+
"""
|
|
326
375
|
return self._TinyId
|
|
327
376
|
|
|
328
377
|
@TinyId.setter
|
|
@@ -331,6 +380,9 @@ class CreateApplicationRequest(AbstractModel):
|
|
|
331
380
|
|
|
332
381
|
@property
|
|
333
382
|
def TagList(self):
|
|
383
|
+
"""List of tags to be bound.
|
|
384
|
+
:rtype: list of Tag
|
|
385
|
+
"""
|
|
334
386
|
return self._TagList
|
|
335
387
|
|
|
336
388
|
@TagList.setter
|
|
@@ -382,6 +434,9 @@ class CreateApplicationResponse(AbstractModel):
|
|
|
382
434
|
|
|
383
435
|
@property
|
|
384
436
|
def AppId(self):
|
|
437
|
+
"""AppId of the customer.
|
|
438
|
+
:rtype: int
|
|
439
|
+
"""
|
|
385
440
|
return self._AppId
|
|
386
441
|
|
|
387
442
|
@AppId.setter
|
|
@@ -390,6 +445,9 @@ class CreateApplicationResponse(AbstractModel):
|
|
|
390
445
|
|
|
391
446
|
@property
|
|
392
447
|
def AppName(self):
|
|
448
|
+
"""Application name.
|
|
449
|
+
:rtype: str
|
|
450
|
+
"""
|
|
393
451
|
return self._AppName
|
|
394
452
|
|
|
395
453
|
@AppName.setter
|
|
@@ -398,6 +456,9 @@ class CreateApplicationResponse(AbstractModel):
|
|
|
398
456
|
|
|
399
457
|
@property
|
|
400
458
|
def SdkAppId(self):
|
|
459
|
+
"""SdkAppId of the whiteboard application.
|
|
460
|
+
:rtype: int
|
|
461
|
+
"""
|
|
401
462
|
return self._SdkAppId
|
|
402
463
|
|
|
403
464
|
@SdkAppId.setter
|
|
@@ -406,6 +467,9 @@ class CreateApplicationResponse(AbstractModel):
|
|
|
406
467
|
|
|
407
468
|
@property
|
|
408
469
|
def RequestId(self):
|
|
470
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
471
|
+
:rtype: str
|
|
472
|
+
"""
|
|
409
473
|
return self._RequestId
|
|
410
474
|
|
|
411
475
|
@RequestId.setter
|
|
@@ -455,6 +519,9 @@ class CreateSnapshotTaskRequest(AbstractModel):
|
|
|
455
519
|
|
|
456
520
|
@property
|
|
457
521
|
def Whiteboard(self):
|
|
522
|
+
"""Whiteboard parameters.
|
|
523
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.SnapshotWhiteboard`
|
|
524
|
+
"""
|
|
458
525
|
return self._Whiteboard
|
|
459
526
|
|
|
460
527
|
@Whiteboard.setter
|
|
@@ -463,6 +530,9 @@ class CreateSnapshotTaskRequest(AbstractModel):
|
|
|
463
530
|
|
|
464
531
|
@property
|
|
465
532
|
def SdkAppId(self):
|
|
533
|
+
"""`SdkAppId` of the whiteboard application.
|
|
534
|
+
:rtype: int
|
|
535
|
+
"""
|
|
466
536
|
return self._SdkAppId
|
|
467
537
|
|
|
468
538
|
@SdkAppId.setter
|
|
@@ -471,6 +541,9 @@ class CreateSnapshotTaskRequest(AbstractModel):
|
|
|
471
541
|
|
|
472
542
|
@property
|
|
473
543
|
def RoomId(self):
|
|
544
|
+
"""Whiteboard room ID.
|
|
545
|
+
:rtype: int
|
|
546
|
+
"""
|
|
474
547
|
return self._RoomId
|
|
475
548
|
|
|
476
549
|
@RoomId.setter
|
|
@@ -479,6 +552,9 @@ class CreateSnapshotTaskRequest(AbstractModel):
|
|
|
479
552
|
|
|
480
553
|
@property
|
|
481
554
|
def CallbackURL(self):
|
|
555
|
+
"""Callback URL to which the whiteboard snapshot result is to be sent.
|
|
556
|
+
:rtype: str
|
|
557
|
+
"""
|
|
482
558
|
return self._CallbackURL
|
|
483
559
|
|
|
484
560
|
@CallbackURL.setter
|
|
@@ -487,6 +563,9 @@ class CreateSnapshotTaskRequest(AbstractModel):
|
|
|
487
563
|
|
|
488
564
|
@property
|
|
489
565
|
def COS(self):
|
|
566
|
+
"""`COS` bucket in which the generated whiteboard snapshot file is to be stored. If you leave this parameter empty, the generated file will be stored in the public bucket and retained for only three days.
|
|
567
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.SnapshotCOS`
|
|
568
|
+
"""
|
|
490
569
|
return self._COS
|
|
491
570
|
|
|
492
571
|
@COS.setter
|
|
@@ -495,6 +574,15 @@ class CreateSnapshotTaskRequest(AbstractModel):
|
|
|
495
574
|
|
|
496
575
|
@property
|
|
497
576
|
def SnapshotMode(self):
|
|
577
|
+
"""Whiteboard snapshot mode. Default value: `AllMarks`. Valid values:
|
|
578
|
+
|
|
579
|
+
`AllMarks`: Full mode. In this mode, a snapshot image is generated based on each whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client.
|
|
580
|
+
|
|
581
|
+
`LatestMarksOnly`: Single-page deduplication mode. In this mode, a snapshot image is generated based only on the latest whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client if the API is called multiple times for the same whiteboard snapshot.
|
|
582
|
+
|
|
583
|
+
**Note: The `LatestMarksOnly` mode takes effect only when the `addSnapshotMark` API is called by using Tencent Interactive Whiteboard SDK v2.6.8 or later. Otherwise, even if this parameter is set to `LatestMarksOnly`, the default `AllMarks` mode is used.**
|
|
584
|
+
:rtype: str
|
|
585
|
+
"""
|
|
498
586
|
return self._SnapshotMode
|
|
499
587
|
|
|
500
588
|
@SnapshotMode.setter
|
|
@@ -540,6 +628,9 @@ class CreateSnapshotTaskResponse(AbstractModel):
|
|
|
540
628
|
|
|
541
629
|
@property
|
|
542
630
|
def TaskID(self):
|
|
631
|
+
"""ID of the whiteboard snapshot task. This parameter is returned only if a task is created successfully.
|
|
632
|
+
:rtype: str
|
|
633
|
+
"""
|
|
543
634
|
return self._TaskID
|
|
544
635
|
|
|
545
636
|
@TaskID.setter
|
|
@@ -548,6 +639,9 @@ class CreateSnapshotTaskResponse(AbstractModel):
|
|
|
548
639
|
|
|
549
640
|
@property
|
|
550
641
|
def RequestId(self):
|
|
642
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
643
|
+
:rtype: str
|
|
644
|
+
"""
|
|
551
645
|
return self._RequestId
|
|
552
646
|
|
|
553
647
|
@RequestId.setter
|
|
@@ -623,6 +717,9 @@ If auto handling is enabled, the following processes are performed:
|
|
|
623
717
|
|
|
624
718
|
@property
|
|
625
719
|
def SdkAppId(self):
|
|
720
|
+
"""SdkAppId of the customer
|
|
721
|
+
:rtype: int
|
|
722
|
+
"""
|
|
626
723
|
return self._SdkAppId
|
|
627
724
|
|
|
628
725
|
@SdkAppId.setter
|
|
@@ -631,6 +728,9 @@ If auto handling is enabled, the following processes are performed:
|
|
|
631
728
|
|
|
632
729
|
@property
|
|
633
730
|
def Url(self):
|
|
731
|
+
"""URL of the transcoded document after URL encoding. URL encoding converts characters into a format that can be transmitted over the Internet. For example, URL encoding can convert the document URL http://example.com/Test.pdf into http://example.com/%E6%B5%8B%E8%AF%95.pdf. To improve the success rate of URL parsing, use URL encoding.
|
|
732
|
+
:rtype: str
|
|
733
|
+
"""
|
|
634
734
|
return self._Url
|
|
635
735
|
|
|
636
736
|
@Url.setter
|
|
@@ -639,6 +739,10 @@ If auto handling is enabled, the following processes are performed:
|
|
|
639
739
|
|
|
640
740
|
@property
|
|
641
741
|
def IsStaticPPT(self):
|
|
742
|
+
"""Whether the PowerPoint file is static. The default value is False.
|
|
743
|
+
If IsStaticPPT is False, documents with the .ppt or .pptx extension will be dynamically transcoded to HTML5 pages, and documents with other extensions will be statically transcoded to images. If IsStaticPPT is True, documents with any extensions will be statically transcoded to images.
|
|
744
|
+
:rtype: bool
|
|
745
|
+
"""
|
|
642
746
|
return self._IsStaticPPT
|
|
643
747
|
|
|
644
748
|
@IsStaticPPT.setter
|
|
@@ -647,6 +751,13 @@ If auto handling is enabled, the following processes are performed:
|
|
|
647
751
|
|
|
648
752
|
@property
|
|
649
753
|
def MinResolution(self):
|
|
754
|
+
"""Note: This parameter is disused. Use the MinScaleResolution parameter to pass in a resolution. For more information, see [CreateTranscode](https://intl.cloud.tencent.com/document/api/1137/40060?from_cn_redirect=1#SDK).
|
|
755
|
+
|
|
756
|
+
Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used.
|
|
757
|
+
|
|
758
|
+
Example: 1280x720. Note that the character between the numbers is the letter x.
|
|
759
|
+
:rtype: str
|
|
760
|
+
"""
|
|
650
761
|
return self._MinResolution
|
|
651
762
|
|
|
652
763
|
@MinResolution.setter
|
|
@@ -655,6 +766,11 @@ If auto handling is enabled, the following processes are performed:
|
|
|
655
766
|
|
|
656
767
|
@property
|
|
657
768
|
def ThumbnailResolution(self):
|
|
769
|
+
"""Resolution of the thumbnail generated for the dynamically transcoded PowerPoint file. If no value or null is specified for it or the resolution format is invalid, no thumbnail will be generated. The resolution format is the same as that of MinResolution.
|
|
770
|
+
|
|
771
|
+
For static transcoding, this parameter does not work.
|
|
772
|
+
:rtype: str
|
|
773
|
+
"""
|
|
658
774
|
return self._ThumbnailResolution
|
|
659
775
|
|
|
660
776
|
@ThumbnailResolution.setter
|
|
@@ -663,6 +779,12 @@ If auto handling is enabled, the following processes are performed:
|
|
|
663
779
|
|
|
664
780
|
@property
|
|
665
781
|
def CompressFileType(self):
|
|
782
|
+
"""Compression format of the transcoded file. If no value or null is specified for it or the specified format is invalid, no compression file will be generated. Currently, the following compression formats are supported:
|
|
783
|
+
|
|
784
|
+
`zip`: generates a .zip compression package.
|
|
785
|
+
`tar.gz: generates a .tar.gz compression package.
|
|
786
|
+
:rtype: str
|
|
787
|
+
"""
|
|
666
788
|
return self._CompressFileType
|
|
667
789
|
|
|
668
790
|
@CompressFileType.setter
|
|
@@ -671,6 +793,9 @@ If auto handling is enabled, the following processes are performed:
|
|
|
671
793
|
|
|
672
794
|
@property
|
|
673
795
|
def ExtraData(self):
|
|
796
|
+
"""Internal parameter.
|
|
797
|
+
:rtype: str
|
|
798
|
+
"""
|
|
674
799
|
return self._ExtraData
|
|
675
800
|
|
|
676
801
|
@ExtraData.setter
|
|
@@ -679,6 +804,13 @@ If auto handling is enabled, the following processes are performed:
|
|
|
679
804
|
|
|
680
805
|
@property
|
|
681
806
|
def Priority(self):
|
|
807
|
+
"""Document transcoding priority. This parameter takes effect only for PowerPoint dynamic transcoding. Valid values:<br/>
|
|
808
|
+
- low: Low transcoding priority. The task can transcode at most 500 MB of data or a 2000-page document, with a download timeout no longer than 10 minutes. Due to resource limits, these tasks may have to queue for a long period of time. Consider this before you use this feature.
|
|
809
|
+
- null: Normal transcoding priority. The task can transcode at most 200 MB of data or a 500-page document, with a download timeout no longer than 2 minutes.
|
|
810
|
+
<br/>
|
|
811
|
+
Note: For static transcoding such as PDF transcoding, each task can transcode at most 200 MB of data regardless of the transcoding priority.
|
|
812
|
+
:rtype: str
|
|
813
|
+
"""
|
|
682
814
|
return self._Priority
|
|
683
815
|
|
|
684
816
|
@Priority.setter
|
|
@@ -687,6 +819,12 @@ If auto handling is enabled, the following processes are performed:
|
|
|
687
819
|
|
|
688
820
|
@property
|
|
689
821
|
def MinScaleResolution(self):
|
|
822
|
+
"""Minimum resolution of the transcoded document. If no value or null is specified for it or the resolution format is invalid, the original document resolution is used.
|
|
823
|
+
Higher resolution brings clearer visual effect, but also means larger size of the transcoded image resources and longer loading time of the transcoded file. Set this parameter appropriately based on your actual scenario.
|
|
824
|
+
|
|
825
|
+
Example: 1280x720. Note that the character between the numbers is the letter x.
|
|
826
|
+
:rtype: str
|
|
827
|
+
"""
|
|
690
828
|
return self._MinScaleResolution
|
|
691
829
|
|
|
692
830
|
@MinScaleResolution.setter
|
|
@@ -695,6 +833,14 @@ If auto handling is enabled, the following processes are performed:
|
|
|
695
833
|
|
|
696
834
|
@property
|
|
697
835
|
def AutoHandleUnsupportedElement(self):
|
|
836
|
+
"""Specifies whether to enable auto handling of unsupported elements. By default, this feature is disabled.
|
|
837
|
+
|
|
838
|
+
If auto handling is enabled, the following processes are performed:
|
|
839
|
+
1. Inkblots: Remove unsupported inkblots, such as those drawn by using WPS.
|
|
840
|
+
2. Auto page flip: Clear the auto page clip settings in the PowerPoint file and set the page flip mode to mouse click.
|
|
841
|
+
3. Corrupted audio/videos: Remove the references to corrupted audio/videos in the PowerPoint file.
|
|
842
|
+
:rtype: bool
|
|
843
|
+
"""
|
|
698
844
|
return self._AutoHandleUnsupportedElement
|
|
699
845
|
|
|
700
846
|
@AutoHandleUnsupportedElement.setter
|
|
@@ -740,6 +886,9 @@ class CreateTranscodeResponse(AbstractModel):
|
|
|
740
886
|
|
|
741
887
|
@property
|
|
742
888
|
def TaskId(self):
|
|
889
|
+
"""Unique ID of the document transcoding task, which is used to query the task progress and transcoding result
|
|
890
|
+
:rtype: str
|
|
891
|
+
"""
|
|
743
892
|
return self._TaskId
|
|
744
893
|
|
|
745
894
|
@TaskId.setter
|
|
@@ -748,6 +897,9 @@ class CreateTranscodeResponse(AbstractModel):
|
|
|
748
897
|
|
|
749
898
|
@property
|
|
750
899
|
def RequestId(self):
|
|
900
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
901
|
+
:rtype: str
|
|
902
|
+
"""
|
|
751
903
|
return self._RequestId
|
|
752
904
|
|
|
753
905
|
@RequestId.setter
|
|
@@ -800,6 +952,9 @@ This parameter conflicts with the RecordControl parameter in the API for startin
|
|
|
800
952
|
|
|
801
953
|
@property
|
|
802
954
|
def OnlineRecordTaskId(self):
|
|
955
|
+
"""ID of the recording task.
|
|
956
|
+
:rtype: str
|
|
957
|
+
"""
|
|
803
958
|
return self._OnlineRecordTaskId
|
|
804
959
|
|
|
805
960
|
@OnlineRecordTaskId.setter
|
|
@@ -808,6 +963,9 @@ This parameter conflicts with the RecordControl parameter in the API for startin
|
|
|
808
963
|
|
|
809
964
|
@property
|
|
810
965
|
def SdkAppId(self):
|
|
966
|
+
"""SdkAppId of the whiteboard application.
|
|
967
|
+
:rtype: int
|
|
968
|
+
"""
|
|
811
969
|
return self._SdkAppId
|
|
812
970
|
|
|
813
971
|
@SdkAppId.setter
|
|
@@ -816,6 +974,11 @@ This parameter conflicts with the RecordControl parameter in the API for startin
|
|
|
816
974
|
|
|
817
975
|
@property
|
|
818
976
|
def Whiteboard(self):
|
|
977
|
+
"""Whiteboard parameters of the recording video generation task, such as the width and height of the whiteboard.
|
|
978
|
+
|
|
979
|
+
This parameter conflicts with the Whiteboard parameter in the API for starting a recording task. If the two Whiteboard parameters are both specified, the Whiteboard parameter in this API takes priority for recording video generation. If the Whiteboard parameter in this API is not specified, the Whiteboard parameter specified in the API for starting a recording task is used for recording video generation.
|
|
980
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.Whiteboard`
|
|
981
|
+
"""
|
|
819
982
|
return self._Whiteboard
|
|
820
983
|
|
|
821
984
|
@Whiteboard.setter
|
|
@@ -824,6 +987,11 @@ This parameter conflicts with the RecordControl parameter in the API for startin
|
|
|
824
987
|
|
|
825
988
|
@property
|
|
826
989
|
def Concat(self):
|
|
990
|
+
"""Video splicing parameters.
|
|
991
|
+
|
|
992
|
+
This parameter conflicts with the Concat parameter in the API for starting a recording task. If the two Concat parameters are both specified, the Concat parameter in this API takes priority for video splicing. If the Concat parameter in this API is not specified, the Concat parameter specified in the API for starting a recording task is used for video splicing.
|
|
993
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.Concat`
|
|
994
|
+
"""
|
|
827
995
|
return self._Concat
|
|
828
996
|
|
|
829
997
|
@Concat.setter
|
|
@@ -832,6 +1000,11 @@ This parameter conflicts with the RecordControl parameter in the API for startin
|
|
|
832
1000
|
|
|
833
1001
|
@property
|
|
834
1002
|
def MixStream(self):
|
|
1003
|
+
"""Video stream mixing parameters.
|
|
1004
|
+
|
|
1005
|
+
This parameter conflicts with the MixStream parameter in the API for starting a recording task. If the two MixStream parameters are both specified, the MixStream parameter in this API takes priority for video stream mixing. If the MixStream parameter in this API is not specified, the MixStream parameter specified in the API for starting a recording task is used for video stream mixing.
|
|
1006
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.MixStream`
|
|
1007
|
+
"""
|
|
835
1008
|
return self._MixStream
|
|
836
1009
|
|
|
837
1010
|
@MixStream.setter
|
|
@@ -840,6 +1013,11 @@ This parameter conflicts with the RecordControl parameter in the API for startin
|
|
|
840
1013
|
|
|
841
1014
|
@property
|
|
842
1015
|
def RecordControl(self):
|
|
1016
|
+
"""A group of video generation parameters. It specifies the streams to be generated, whether to disable audio recording for a stream, and whether to record only low-resolution videos, etc.
|
|
1017
|
+
|
|
1018
|
+
This parameter conflicts with the RecordControl parameter in the API for starting a recording task. If the two RecordControl parameters are both specified, the RecordControl parameter in this API takes priority for video generation control. If the RecordControl parameter in this API is not specified, the RecordControl parameter specified in the API for starting a recording task is used for video generation control.
|
|
1019
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.RecordControl`
|
|
1020
|
+
"""
|
|
843
1021
|
return self._RecordControl
|
|
844
1022
|
|
|
845
1023
|
@RecordControl.setter
|
|
@@ -848,6 +1026,9 @@ This parameter conflicts with the RecordControl parameter in the API for startin
|
|
|
848
1026
|
|
|
849
1027
|
@property
|
|
850
1028
|
def ExtraData(self):
|
|
1029
|
+
"""Internal parameter.
|
|
1030
|
+
:rtype: str
|
|
1031
|
+
"""
|
|
851
1032
|
return self._ExtraData
|
|
852
1033
|
|
|
853
1034
|
@ExtraData.setter
|
|
@@ -898,6 +1079,9 @@ class CreateVideoGenerationTaskResponse(AbstractModel):
|
|
|
898
1079
|
|
|
899
1080
|
@property
|
|
900
1081
|
def TaskId(self):
|
|
1082
|
+
"""ID of the video generation task.
|
|
1083
|
+
:rtype: str
|
|
1084
|
+
"""
|
|
901
1085
|
return self._TaskId
|
|
902
1086
|
|
|
903
1087
|
@TaskId.setter
|
|
@@ -906,6 +1090,9 @@ class CreateVideoGenerationTaskResponse(AbstractModel):
|
|
|
906
1090
|
|
|
907
1091
|
@property
|
|
908
1092
|
def RequestId(self):
|
|
1093
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1094
|
+
:rtype: str
|
|
1095
|
+
"""
|
|
909
1096
|
return self._RequestId
|
|
910
1097
|
|
|
911
1098
|
@RequestId.setter
|
|
@@ -935,6 +1122,9 @@ class CustomLayout(AbstractModel):
|
|
|
935
1122
|
|
|
936
1123
|
@property
|
|
937
1124
|
def Canvas(self):
|
|
1125
|
+
"""Mixed stream canvas parameter
|
|
1126
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.Canvas`
|
|
1127
|
+
"""
|
|
938
1128
|
return self._Canvas
|
|
939
1129
|
|
|
940
1130
|
@Canvas.setter
|
|
@@ -943,6 +1133,9 @@ class CustomLayout(AbstractModel):
|
|
|
943
1133
|
|
|
944
1134
|
@property
|
|
945
1135
|
def InputStreamList(self):
|
|
1136
|
+
"""Stream layout. The layout of each stream cannot exceed the canvas area.
|
|
1137
|
+
:rtype: list of StreamLayout
|
|
1138
|
+
"""
|
|
946
1139
|
return self._InputStreamList
|
|
947
1140
|
|
|
948
1141
|
@InputStreamList.setter
|
|
@@ -993,6 +1186,12 @@ yyyy-mm-dd HH:MM:SS
|
|
|
993
1186
|
|
|
994
1187
|
@property
|
|
995
1188
|
def Time(self):
|
|
1189
|
+
"""Time. The following formats are supported:
|
|
1190
|
+
yyyy-mm
|
|
1191
|
+
yyyy-mm-dd
|
|
1192
|
+
yyyy-mm-dd HH:MM:SS
|
|
1193
|
+
:rtype: str
|
|
1194
|
+
"""
|
|
996
1195
|
return self._Time
|
|
997
1196
|
|
|
998
1197
|
@Time.setter
|
|
@@ -1001,6 +1200,9 @@ yyyy-mm-dd HH:MM:SS
|
|
|
1001
1200
|
|
|
1002
1201
|
@property
|
|
1003
1202
|
def Value(self):
|
|
1203
|
+
"""Values required for drawing charts.
|
|
1204
|
+
:rtype: int
|
|
1205
|
+
"""
|
|
1004
1206
|
return self._Value
|
|
1005
1207
|
|
|
1006
1208
|
@Value.setter
|
|
@@ -1009,6 +1211,9 @@ yyyy-mm-dd HH:MM:SS
|
|
|
1009
1211
|
|
|
1010
1212
|
@property
|
|
1011
1213
|
def Details(self):
|
|
1214
|
+
"""Details of the values.
|
|
1215
|
+
:rtype: list of Detail
|
|
1216
|
+
"""
|
|
1012
1217
|
return self._Details
|
|
1013
1218
|
|
|
1014
1219
|
@Details.setter
|
|
@@ -1052,6 +1257,9 @@ class DescribeAPIServiceRequest(AbstractModel):
|
|
|
1052
1257
|
|
|
1053
1258
|
@property
|
|
1054
1259
|
def Service(self):
|
|
1260
|
+
"""Supported services are cos:GetService and cdn:DescribeDomainsConfig.
|
|
1261
|
+
:rtype: str
|
|
1262
|
+
"""
|
|
1055
1263
|
return self._Service
|
|
1056
1264
|
|
|
1057
1265
|
@Service.setter
|
|
@@ -1060,6 +1268,9 @@ class DescribeAPIServiceRequest(AbstractModel):
|
|
|
1060
1268
|
|
|
1061
1269
|
@property
|
|
1062
1270
|
def Data(self):
|
|
1271
|
+
"""Request parameters in JSON format.
|
|
1272
|
+
:rtype: str
|
|
1273
|
+
"""
|
|
1063
1274
|
return self._Data
|
|
1064
1275
|
|
|
1065
1276
|
@Data.setter
|
|
@@ -1097,6 +1308,9 @@ class DescribeAPIServiceResponse(AbstractModel):
|
|
|
1097
1308
|
|
|
1098
1309
|
@property
|
|
1099
1310
|
def ResponseData(self):
|
|
1311
|
+
"""Response data in JSON format.
|
|
1312
|
+
:rtype: str
|
|
1313
|
+
"""
|
|
1100
1314
|
return self._ResponseData
|
|
1101
1315
|
|
|
1102
1316
|
@ResponseData.setter
|
|
@@ -1105,6 +1319,9 @@ class DescribeAPIServiceResponse(AbstractModel):
|
|
|
1105
1319
|
|
|
1106
1320
|
@property
|
|
1107
1321
|
def RequestId(self):
|
|
1322
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1323
|
+
:rtype: str
|
|
1324
|
+
"""
|
|
1108
1325
|
return self._RequestId
|
|
1109
1326
|
|
|
1110
1327
|
@RequestId.setter
|
|
@@ -1143,6 +1360,9 @@ class DescribeApplicationInfosResponse(AbstractModel):
|
|
|
1143
1360
|
|
|
1144
1361
|
@property
|
|
1145
1362
|
def ApplicationInfos(self):
|
|
1363
|
+
"""Application list.
|
|
1364
|
+
:rtype: list of ApplicationItem
|
|
1365
|
+
"""
|
|
1146
1366
|
return self._ApplicationInfos
|
|
1147
1367
|
|
|
1148
1368
|
@ApplicationInfos.setter
|
|
@@ -1151,6 +1371,9 @@ class DescribeApplicationInfosResponse(AbstractModel):
|
|
|
1151
1371
|
|
|
1152
1372
|
@property
|
|
1153
1373
|
def AllOption(self):
|
|
1374
|
+
"""Specifies whether all applications are included. The value 0 indicates no and 1 indicates yes.
|
|
1375
|
+
:rtype: int
|
|
1376
|
+
"""
|
|
1154
1377
|
return self._AllOption
|
|
1155
1378
|
|
|
1156
1379
|
@AllOption.setter
|
|
@@ -1159,6 +1382,9 @@ class DescribeApplicationInfosResponse(AbstractModel):
|
|
|
1159
1382
|
|
|
1160
1383
|
@property
|
|
1161
1384
|
def RequestId(self):
|
|
1385
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1386
|
+
:rtype: str
|
|
1387
|
+
"""
|
|
1162
1388
|
return self._RequestId
|
|
1163
1389
|
|
|
1164
1390
|
@RequestId.setter
|
|
@@ -1210,6 +1436,9 @@ false: Returns the raw usage data.
|
|
|
1210
1436
|
|
|
1211
1437
|
@property
|
|
1212
1438
|
def BeginTime(self):
|
|
1439
|
+
"""Start time of the query period. The start time point is included in the query period.
|
|
1440
|
+
:rtype: str
|
|
1441
|
+
"""
|
|
1213
1442
|
return self._BeginTime
|
|
1214
1443
|
|
|
1215
1444
|
@BeginTime.setter
|
|
@@ -1218,6 +1447,9 @@ false: Returns the raw usage data.
|
|
|
1218
1447
|
|
|
1219
1448
|
@property
|
|
1220
1449
|
def EndTime(self):
|
|
1450
|
+
"""End time of the query period. The end time point is not included in the query period.
|
|
1451
|
+
:rtype: str
|
|
1452
|
+
"""
|
|
1221
1453
|
return self._EndTime
|
|
1222
1454
|
|
|
1223
1455
|
@EndTime.setter
|
|
@@ -1226,6 +1458,9 @@ false: Returns the raw usage data.
|
|
|
1226
1458
|
|
|
1227
1459
|
@property
|
|
1228
1460
|
def SubProduct(self):
|
|
1461
|
+
"""Subproduct name.
|
|
1462
|
+
:rtype: str
|
|
1463
|
+
"""
|
|
1229
1464
|
return self._SubProduct
|
|
1230
1465
|
|
|
1231
1466
|
@SubProduct.setter
|
|
@@ -1234,6 +1469,12 @@ false: Returns the raw usage data.
|
|
|
1234
1469
|
|
|
1235
1470
|
@property
|
|
1236
1471
|
def TimeLevel(self):
|
|
1472
|
+
"""Unit of time increment.
|
|
1473
|
+
- MONTHLY: month
|
|
1474
|
+
- DAILY: day
|
|
1475
|
+
- MINUTELY: minute
|
|
1476
|
+
:rtype: str
|
|
1477
|
+
"""
|
|
1237
1478
|
return self._TimeLevel
|
|
1238
1479
|
|
|
1239
1480
|
@TimeLevel.setter
|
|
@@ -1242,6 +1483,9 @@ false: Returns the raw usage data.
|
|
|
1242
1483
|
|
|
1243
1484
|
@property
|
|
1244
1485
|
def SdkAppId(self):
|
|
1486
|
+
"""SdkAppId of the whiteboard application.
|
|
1487
|
+
:rtype: int
|
|
1488
|
+
"""
|
|
1245
1489
|
return self._SdkAppId
|
|
1246
1490
|
|
|
1247
1491
|
@SdkAppId.setter
|
|
@@ -1250,6 +1494,10 @@ false: Returns the raw usage data.
|
|
|
1250
1494
|
|
|
1251
1495
|
@property
|
|
1252
1496
|
def IsWeighted(self):
|
|
1497
|
+
"""true: Returns the weighted sum of raw usage data.
|
|
1498
|
+
false: Returns the raw usage data.
|
|
1499
|
+
:rtype: bool
|
|
1500
|
+
"""
|
|
1253
1501
|
return self._IsWeighted
|
|
1254
1502
|
|
|
1255
1503
|
@IsWeighted.setter
|
|
@@ -1291,6 +1539,9 @@ class DescribeApplicationUsageResponse(AbstractModel):
|
|
|
1291
1539
|
|
|
1292
1540
|
@property
|
|
1293
1541
|
def Data(self):
|
|
1542
|
+
"""Usage data required for drawing charts.
|
|
1543
|
+
:rtype: list of DataItem
|
|
1544
|
+
"""
|
|
1294
1545
|
return self._Data
|
|
1295
1546
|
|
|
1296
1547
|
@Data.setter
|
|
@@ -1299,6 +1550,9 @@ class DescribeApplicationUsageResponse(AbstractModel):
|
|
|
1299
1550
|
|
|
1300
1551
|
@property
|
|
1301
1552
|
def RequestId(self):
|
|
1553
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1554
|
+
:rtype: str
|
|
1555
|
+
"""
|
|
1302
1556
|
return self._RequestId
|
|
1303
1557
|
|
|
1304
1558
|
@RequestId.setter
|
|
@@ -1351,6 +1605,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1351
1605
|
|
|
1352
1606
|
@property
|
|
1353
1607
|
def SdkAppId(self):
|
|
1608
|
+
"""SdkAppId of the whiteboard application.
|
|
1609
|
+
:rtype: int
|
|
1610
|
+
"""
|
|
1354
1611
|
return self._SdkAppId
|
|
1355
1612
|
|
|
1356
1613
|
@SdkAppId.setter
|
|
@@ -1359,6 +1616,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1359
1616
|
|
|
1360
1617
|
@property
|
|
1361
1618
|
def RoomId(self):
|
|
1619
|
+
"""Room ID to be used to query logs.
|
|
1620
|
+
:rtype: str
|
|
1621
|
+
"""
|
|
1362
1622
|
return self._RoomId
|
|
1363
1623
|
|
|
1364
1624
|
@RoomId.setter
|
|
@@ -1367,6 +1627,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1367
1627
|
|
|
1368
1628
|
@property
|
|
1369
1629
|
def UserId(self):
|
|
1630
|
+
"""User ID to be used to query logs.
|
|
1631
|
+
:rtype: str
|
|
1632
|
+
"""
|
|
1370
1633
|
return self._UserId
|
|
1371
1634
|
|
|
1372
1635
|
@UserId.setter
|
|
@@ -1375,6 +1638,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1375
1638
|
|
|
1376
1639
|
@property
|
|
1377
1640
|
def TimeRange(self):
|
|
1641
|
+
"""Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
|
|
1642
|
+
:rtype: list of int
|
|
1643
|
+
"""
|
|
1378
1644
|
return self._TimeRange
|
|
1379
1645
|
|
|
1380
1646
|
@TimeRange.setter
|
|
@@ -1383,6 +1649,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1383
1649
|
|
|
1384
1650
|
@property
|
|
1385
1651
|
def AggregationInterval(self):
|
|
1652
|
+
"""Interval for aggregating log number queries. Example values: `5m`, `1h`, `4h`
|
|
1653
|
+
:rtype: str
|
|
1654
|
+
"""
|
|
1386
1655
|
return self._AggregationInterval
|
|
1387
1656
|
|
|
1388
1657
|
@AggregationInterval.setter
|
|
@@ -1391,6 +1660,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1391
1660
|
|
|
1392
1661
|
@property
|
|
1393
1662
|
def Query(self):
|
|
1663
|
+
"""Extra query conditions.
|
|
1664
|
+
:rtype: str
|
|
1665
|
+
"""
|
|
1394
1666
|
return self._Query
|
|
1395
1667
|
|
|
1396
1668
|
@Query.setter
|
|
@@ -1399,6 +1671,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1399
1671
|
|
|
1400
1672
|
@property
|
|
1401
1673
|
def Ascending(self):
|
|
1674
|
+
"""Specifies whether to sort results in ascending order of time.
|
|
1675
|
+
:rtype: bool
|
|
1676
|
+
"""
|
|
1402
1677
|
return self._Ascending
|
|
1403
1678
|
|
|
1404
1679
|
@Ascending.setter
|
|
@@ -1407,6 +1682,9 @@ class DescribeBoardSDKLogRequest(AbstractModel):
|
|
|
1407
1682
|
|
|
1408
1683
|
@property
|
|
1409
1684
|
def Context(self):
|
|
1685
|
+
"""Context key used for recursive extraction. Obtain this parameter in the response to the last request.
|
|
1686
|
+
:rtype: str
|
|
1687
|
+
"""
|
|
1410
1688
|
return self._Context
|
|
1411
1689
|
|
|
1412
1690
|
@Context.setter
|
|
@@ -1459,6 +1737,9 @@ class DescribeBoardSDKLogResponse(AbstractModel):
|
|
|
1459
1737
|
|
|
1460
1738
|
@property
|
|
1461
1739
|
def Total(self):
|
|
1740
|
+
"""Number of logs queried.
|
|
1741
|
+
:rtype: int
|
|
1742
|
+
"""
|
|
1462
1743
|
return self._Total
|
|
1463
1744
|
|
|
1464
1745
|
@Total.setter
|
|
@@ -1467,6 +1748,9 @@ class DescribeBoardSDKLogResponse(AbstractModel):
|
|
|
1467
1748
|
|
|
1468
1749
|
@property
|
|
1469
1750
|
def Sources(self):
|
|
1751
|
+
"""Log details.
|
|
1752
|
+
:rtype: list of str
|
|
1753
|
+
"""
|
|
1470
1754
|
return self._Sources
|
|
1471
1755
|
|
|
1472
1756
|
@Sources.setter
|
|
@@ -1475,6 +1759,9 @@ class DescribeBoardSDKLogResponse(AbstractModel):
|
|
|
1475
1759
|
|
|
1476
1760
|
@property
|
|
1477
1761
|
def Buckets(self):
|
|
1762
|
+
"""Number of logs queried within each time range after aggregation based on the time range.
|
|
1763
|
+
:rtype: list of str
|
|
1764
|
+
"""
|
|
1478
1765
|
return self._Buckets
|
|
1479
1766
|
|
|
1480
1767
|
@Buckets.setter
|
|
@@ -1483,6 +1770,9 @@ class DescribeBoardSDKLogResponse(AbstractModel):
|
|
|
1483
1770
|
|
|
1484
1771
|
@property
|
|
1485
1772
|
def Context(self):
|
|
1773
|
+
"""Context key used for recursive extraction. This parameter can be used in the next request.
|
|
1774
|
+
:rtype: str
|
|
1775
|
+
"""
|
|
1486
1776
|
return self._Context
|
|
1487
1777
|
|
|
1488
1778
|
@Context.setter
|
|
@@ -1491,6 +1781,9 @@ class DescribeBoardSDKLogResponse(AbstractModel):
|
|
|
1491
1781
|
|
|
1492
1782
|
@property
|
|
1493
1783
|
def RequestId(self):
|
|
1784
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1785
|
+
:rtype: str
|
|
1786
|
+
"""
|
|
1494
1787
|
return self._RequestId
|
|
1495
1788
|
|
|
1496
1789
|
@RequestId.setter
|
|
@@ -1526,6 +1819,9 @@ class DescribeIMApplicationsResponse(AbstractModel):
|
|
|
1526
1819
|
|
|
1527
1820
|
@property
|
|
1528
1821
|
def RequestId(self):
|
|
1822
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1823
|
+
:rtype: str
|
|
1824
|
+
"""
|
|
1529
1825
|
return self._RequestId
|
|
1530
1826
|
|
|
1531
1827
|
@RequestId.setter
|
|
@@ -1551,6 +1847,9 @@ class DescribeOnlineRecordCallbackRequest(AbstractModel):
|
|
|
1551
1847
|
|
|
1552
1848
|
@property
|
|
1553
1849
|
def SdkAppId(self):
|
|
1850
|
+
"""SdkAppId of the application
|
|
1851
|
+
:rtype: int
|
|
1852
|
+
"""
|
|
1554
1853
|
return self._SdkAppId
|
|
1555
1854
|
|
|
1556
1855
|
@SdkAppId.setter
|
|
@@ -1590,6 +1889,9 @@ class DescribeOnlineRecordCallbackResponse(AbstractModel):
|
|
|
1590
1889
|
|
|
1591
1890
|
@property
|
|
1592
1891
|
def Callback(self):
|
|
1892
|
+
"""Callback address of the real-time recording event. If no callback address is set, this field is null.
|
|
1893
|
+
:rtype: str
|
|
1894
|
+
"""
|
|
1593
1895
|
return self._Callback
|
|
1594
1896
|
|
|
1595
1897
|
@Callback.setter
|
|
@@ -1598,6 +1900,9 @@ class DescribeOnlineRecordCallbackResponse(AbstractModel):
|
|
|
1598
1900
|
|
|
1599
1901
|
@property
|
|
1600
1902
|
def CallbackKey(self):
|
|
1903
|
+
"""Authentication key of the real-time recording callback
|
|
1904
|
+
:rtype: str
|
|
1905
|
+
"""
|
|
1601
1906
|
return self._CallbackKey
|
|
1602
1907
|
|
|
1603
1908
|
@CallbackKey.setter
|
|
@@ -1606,6 +1911,9 @@ class DescribeOnlineRecordCallbackResponse(AbstractModel):
|
|
|
1606
1911
|
|
|
1607
1912
|
@property
|
|
1608
1913
|
def RequestId(self):
|
|
1914
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1915
|
+
:rtype: str
|
|
1916
|
+
"""
|
|
1609
1917
|
return self._RequestId
|
|
1610
1918
|
|
|
1611
1919
|
@RequestId.setter
|
|
@@ -1636,6 +1944,9 @@ class DescribeOnlineRecordRequest(AbstractModel):
|
|
|
1636
1944
|
|
|
1637
1945
|
@property
|
|
1638
1946
|
def SdkAppId(self):
|
|
1947
|
+
"""SdkAppId of the customer
|
|
1948
|
+
:rtype: int
|
|
1949
|
+
"""
|
|
1639
1950
|
return self._SdkAppId
|
|
1640
1951
|
|
|
1641
1952
|
@SdkAppId.setter
|
|
@@ -1644,6 +1955,9 @@ class DescribeOnlineRecordRequest(AbstractModel):
|
|
|
1644
1955
|
|
|
1645
1956
|
@property
|
|
1646
1957
|
def TaskId(self):
|
|
1958
|
+
"""ID of the real-time recording task
|
|
1959
|
+
:rtype: str
|
|
1960
|
+
"""
|
|
1647
1961
|
return self._TaskId
|
|
1648
1962
|
|
|
1649
1963
|
@TaskId.setter
|
|
@@ -1730,6 +2044,13 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1730
2044
|
|
|
1731
2045
|
@property
|
|
1732
2046
|
def FinishReason(self):
|
|
2047
|
+
"""Recording stop reason
|
|
2048
|
+
- AUTO: Recording automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time.
|
|
2049
|
+
- USER_CALL: The API for stopping recording is called.
|
|
2050
|
+
- EXCEPTION: An exception occurred.
|
|
2051
|
+
- FORCE_STOP: Recording is forcibly stopped, which is usually because the recording has been paused for more than 90 minutes or has lasted for more than 24 hours.
|
|
2052
|
+
:rtype: str
|
|
2053
|
+
"""
|
|
1733
2054
|
return self._FinishReason
|
|
1734
2055
|
|
|
1735
2056
|
@FinishReason.setter
|
|
@@ -1738,6 +2059,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1738
2059
|
|
|
1739
2060
|
@property
|
|
1740
2061
|
def TaskId(self):
|
|
2062
|
+
"""ID of the recording task to be queried.
|
|
2063
|
+
:rtype: str
|
|
2064
|
+
"""
|
|
1741
2065
|
return self._TaskId
|
|
1742
2066
|
|
|
1743
2067
|
@TaskId.setter
|
|
@@ -1746,6 +2070,14 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1746
2070
|
|
|
1747
2071
|
@property
|
|
1748
2072
|
def Status(self):
|
|
2073
|
+
"""Recording task status
|
|
2074
|
+
- PREPARED: preparing
|
|
2075
|
+
- RECORDING: recording
|
|
2076
|
+
- PAUSED: recording is paused.
|
|
2077
|
+
- STOPPED: recording is stopped, and the recorded video is being processed and uploaded.
|
|
2078
|
+
- FINISHED: the recorded video has been processed and uploaded, and the recording result is generated.
|
|
2079
|
+
:rtype: str
|
|
2080
|
+
"""
|
|
1749
2081
|
return self._Status
|
|
1750
2082
|
|
|
1751
2083
|
@Status.setter
|
|
@@ -1754,6 +2086,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1754
2086
|
|
|
1755
2087
|
@property
|
|
1756
2088
|
def RoomId(self):
|
|
2089
|
+
"""Room ID
|
|
2090
|
+
:rtype: int
|
|
2091
|
+
"""
|
|
1757
2092
|
return self._RoomId
|
|
1758
2093
|
|
|
1759
2094
|
@RoomId.setter
|
|
@@ -1762,6 +2097,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1762
2097
|
|
|
1763
2098
|
@property
|
|
1764
2099
|
def GroupId(self):
|
|
2100
|
+
"""Group ID of the whiteboard
|
|
2101
|
+
:rtype: str
|
|
2102
|
+
"""
|
|
1765
2103
|
return self._GroupId
|
|
1766
2104
|
|
|
1767
2105
|
@GroupId.setter
|
|
@@ -1770,6 +2108,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1770
2108
|
|
|
1771
2109
|
@property
|
|
1772
2110
|
def RecordUserId(self):
|
|
2111
|
+
"""ID of the recording user
|
|
2112
|
+
:rtype: str
|
|
2113
|
+
"""
|
|
1773
2114
|
return self._RecordUserId
|
|
1774
2115
|
|
|
1775
2116
|
@RecordUserId.setter
|
|
@@ -1778,6 +2119,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1778
2119
|
|
|
1779
2120
|
@property
|
|
1780
2121
|
def RecordStartTime(self):
|
|
2122
|
+
"""Actual recording start time, which is a UNIX timestamp in seconds
|
|
2123
|
+
:rtype: int
|
|
2124
|
+
"""
|
|
1781
2125
|
return self._RecordStartTime
|
|
1782
2126
|
|
|
1783
2127
|
@RecordStartTime.setter
|
|
@@ -1786,6 +2130,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1786
2130
|
|
|
1787
2131
|
@property
|
|
1788
2132
|
def RecordStopTime(self):
|
|
2133
|
+
"""Actual recording stop time, which is a UNIX timestamp in seconds
|
|
2134
|
+
:rtype: int
|
|
2135
|
+
"""
|
|
1789
2136
|
return self._RecordStopTime
|
|
1790
2137
|
|
|
1791
2138
|
@RecordStopTime.setter
|
|
@@ -1794,6 +2141,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1794
2141
|
|
|
1795
2142
|
@property
|
|
1796
2143
|
def TotalTime(self):
|
|
2144
|
+
"""Total video playback duration, in milliseconds
|
|
2145
|
+
:rtype: int
|
|
2146
|
+
"""
|
|
1797
2147
|
return self._TotalTime
|
|
1798
2148
|
|
|
1799
2149
|
@TotalTime.setter
|
|
@@ -1802,6 +2152,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1802
2152
|
|
|
1803
2153
|
@property
|
|
1804
2154
|
def ExceptionCnt(self):
|
|
2155
|
+
"""Number of exceptions during recording
|
|
2156
|
+
:rtype: int
|
|
2157
|
+
"""
|
|
1805
2158
|
return self._ExceptionCnt
|
|
1806
2159
|
|
|
1807
2160
|
@ExceptionCnt.setter
|
|
@@ -1810,6 +2163,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1810
2163
|
|
|
1811
2164
|
@property
|
|
1812
2165
|
def OmittedDurations(self):
|
|
2166
|
+
"""Duration to be deleted in the spliced video. This parameter is valid only when the video splicing feature is enabled.
|
|
2167
|
+
:rtype: list of OmittedDuration
|
|
2168
|
+
"""
|
|
1813
2169
|
return self._OmittedDurations
|
|
1814
2170
|
|
|
1815
2171
|
@OmittedDurations.setter
|
|
@@ -1818,6 +2174,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1818
2174
|
|
|
1819
2175
|
@property
|
|
1820
2176
|
def VideoInfos(self):
|
|
2177
|
+
"""List of recorded videos
|
|
2178
|
+
:rtype: list of VideoInfo
|
|
2179
|
+
"""
|
|
1821
2180
|
return self._VideoInfos
|
|
1822
2181
|
|
|
1823
2182
|
@VideoInfos.setter
|
|
@@ -1826,6 +2185,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1826
2185
|
|
|
1827
2186
|
@property
|
|
1828
2187
|
def ReplayUrl(self):
|
|
2188
|
+
"""
|
|
2189
|
+
:rtype: str
|
|
2190
|
+
"""
|
|
1829
2191
|
return self._ReplayUrl
|
|
1830
2192
|
|
|
1831
2193
|
@ReplayUrl.setter
|
|
@@ -1834,6 +2196,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1834
2196
|
|
|
1835
2197
|
@property
|
|
1836
2198
|
def Interrupts(self):
|
|
2199
|
+
"""Number of video stream interruptions during recording.
|
|
2200
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
2201
|
+
:rtype: list of Interrupt
|
|
2202
|
+
"""
|
|
1837
2203
|
return self._Interrupts
|
|
1838
2204
|
|
|
1839
2205
|
@Interrupts.setter
|
|
@@ -1842,6 +2208,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
1842
2208
|
|
|
1843
2209
|
@property
|
|
1844
2210
|
def RequestId(self):
|
|
2211
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2212
|
+
:rtype: str
|
|
2213
|
+
"""
|
|
1845
2214
|
return self._RequestId
|
|
1846
2215
|
|
|
1847
2216
|
@RequestId.setter
|
|
@@ -1899,6 +2268,9 @@ class DescribePostpaidUsageRequest(AbstractModel):
|
|
|
1899
2268
|
|
|
1900
2269
|
@property
|
|
1901
2270
|
def BeginTime(self):
|
|
2271
|
+
"""Start time of the query period.
|
|
2272
|
+
:rtype: str
|
|
2273
|
+
"""
|
|
1902
2274
|
return self._BeginTime
|
|
1903
2275
|
|
|
1904
2276
|
@BeginTime.setter
|
|
@@ -1907,6 +2279,9 @@ class DescribePostpaidUsageRequest(AbstractModel):
|
|
|
1907
2279
|
|
|
1908
2280
|
@property
|
|
1909
2281
|
def EndTime(self):
|
|
2282
|
+
"""End time of the query period.
|
|
2283
|
+
:rtype: str
|
|
2284
|
+
"""
|
|
1910
2285
|
return self._EndTime
|
|
1911
2286
|
|
|
1912
2287
|
@EndTime.setter
|
|
@@ -1941,6 +2316,9 @@ class DescribePostpaidUsageResponse(AbstractModel):
|
|
|
1941
2316
|
|
|
1942
2317
|
@property
|
|
1943
2318
|
def RequestId(self):
|
|
2319
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2320
|
+
:rtype: str
|
|
2321
|
+
"""
|
|
1944
2322
|
return self._RequestId
|
|
1945
2323
|
|
|
1946
2324
|
@RequestId.setter
|
|
@@ -1989,6 +2367,9 @@ class DescribeQualityMetricsRequest(AbstractModel):
|
|
|
1989
2367
|
|
|
1990
2368
|
@property
|
|
1991
2369
|
def SdkAppId(self):
|
|
2370
|
+
"""SdkAppId of the whiteboard application.
|
|
2371
|
+
:rtype: int
|
|
2372
|
+
"""
|
|
1992
2373
|
return self._SdkAppId
|
|
1993
2374
|
|
|
1994
2375
|
@SdkAppId.setter
|
|
@@ -1997,6 +2378,9 @@ class DescribeQualityMetricsRequest(AbstractModel):
|
|
|
1997
2378
|
|
|
1998
2379
|
@property
|
|
1999
2380
|
def StartTime(self):
|
|
2381
|
+
"""Start time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
|
|
2382
|
+
:rtype: int
|
|
2383
|
+
"""
|
|
2000
2384
|
return self._StartTime
|
|
2001
2385
|
|
|
2002
2386
|
@StartTime.setter
|
|
@@ -2005,6 +2389,9 @@ class DescribeQualityMetricsRequest(AbstractModel):
|
|
|
2005
2389
|
|
|
2006
2390
|
@property
|
|
2007
2391
|
def EndTime(self):
|
|
2392
|
+
"""End time, which is a Unix timestamp in seconds. The time length cannot exceed seven days.
|
|
2393
|
+
:rtype: int
|
|
2394
|
+
"""
|
|
2008
2395
|
return self._EndTime
|
|
2009
2396
|
|
|
2010
2397
|
@EndTime.setter
|
|
@@ -2013,6 +2400,20 @@ class DescribeQualityMetricsRequest(AbstractModel):
|
|
|
2013
2400
|
|
|
2014
2401
|
@property
|
|
2015
2402
|
def Metric(self):
|
|
2403
|
+
"""Metrics to be queried. Valid values:
|
|
2404
|
+
- image_load_total_count: The number of image loads.
|
|
2405
|
+
- image_load_fail_count: The number of image load failures.
|
|
2406
|
+
- image_load_success_rate: The success rate of image loading, in percentage.
|
|
2407
|
+
- ppt_load_total_count: The number of PowerPoint file loads.
|
|
2408
|
+
- ppt_load_fail_count: The number of PowerPoint file load failures.
|
|
2409
|
+
- ppt_load_success_rate: The success rate of PowerPoint file loading, in percentage.
|
|
2410
|
+
- verify_sdk_total_count: The number of SDK verifications.
|
|
2411
|
+
- verify_sdk_fail_count: The number of SDK verification failures.
|
|
2412
|
+
- verify_sdk_success_rate: The success rate of SDK verification, in percentage.
|
|
2413
|
+
- verify_sdk_in_one_second_rate: The rate of SDK verification completed within one second, in percentage.
|
|
2414
|
+
- verify_sdk_cost_avg: The average time taken by each SDK verification, in milliseconds.
|
|
2415
|
+
:rtype: str
|
|
2416
|
+
"""
|
|
2016
2417
|
return self._Metric
|
|
2017
2418
|
|
|
2018
2419
|
@Metric.setter
|
|
@@ -2021,6 +2422,9 @@ class DescribeQualityMetricsRequest(AbstractModel):
|
|
|
2021
2422
|
|
|
2022
2423
|
@property
|
|
2023
2424
|
def Interval(self):
|
|
2425
|
+
"""Aggregation interval. Valid value: `1h`.
|
|
2426
|
+
:rtype: str
|
|
2427
|
+
"""
|
|
2024
2428
|
return self._Interval
|
|
2025
2429
|
|
|
2026
2430
|
@Interval.setter
|
|
@@ -2064,6 +2468,9 @@ class DescribeQualityMetricsResponse(AbstractModel):
|
|
|
2064
2468
|
|
|
2065
2469
|
@property
|
|
2066
2470
|
def Metric(self):
|
|
2471
|
+
"""Query metrics.
|
|
2472
|
+
:rtype: str
|
|
2473
|
+
"""
|
|
2067
2474
|
return self._Metric
|
|
2068
2475
|
|
|
2069
2476
|
@Metric.setter
|
|
@@ -2072,6 +2479,9 @@ class DescribeQualityMetricsResponse(AbstractModel):
|
|
|
2072
2479
|
|
|
2073
2480
|
@property
|
|
2074
2481
|
def Content(self):
|
|
2482
|
+
"""Time series.
|
|
2483
|
+
:rtype: list of TimeValue
|
|
2484
|
+
"""
|
|
2075
2485
|
return self._Content
|
|
2076
2486
|
|
|
2077
2487
|
@Content.setter
|
|
@@ -2080,6 +2490,9 @@ class DescribeQualityMetricsResponse(AbstractModel):
|
|
|
2080
2490
|
|
|
2081
2491
|
@property
|
|
2082
2492
|
def RequestId(self):
|
|
2493
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2494
|
+
:rtype: str
|
|
2495
|
+
"""
|
|
2083
2496
|
return self._RequestId
|
|
2084
2497
|
|
|
2085
2498
|
@RequestId.setter
|
|
@@ -2124,6 +2537,9 @@ class DescribeRecordSearchResponse(AbstractModel):
|
|
|
2124
2537
|
|
|
2125
2538
|
@property
|
|
2126
2539
|
def RecordTaskSet(self):
|
|
2540
|
+
"""The set of queried recording tasks.
|
|
2541
|
+
:rtype: list of RecordTaskSearchResult
|
|
2542
|
+
"""
|
|
2127
2543
|
return self._RecordTaskSet
|
|
2128
2544
|
|
|
2129
2545
|
@RecordTaskSet.setter
|
|
@@ -2132,6 +2548,9 @@ class DescribeRecordSearchResponse(AbstractModel):
|
|
|
2132
2548
|
|
|
2133
2549
|
@property
|
|
2134
2550
|
def TotalCount(self):
|
|
2551
|
+
"""Number of recording tasks.
|
|
2552
|
+
:rtype: int
|
|
2553
|
+
"""
|
|
2135
2554
|
return self._TotalCount
|
|
2136
2555
|
|
|
2137
2556
|
@TotalCount.setter
|
|
@@ -2140,6 +2559,9 @@ class DescribeRecordSearchResponse(AbstractModel):
|
|
|
2140
2559
|
|
|
2141
2560
|
@property
|
|
2142
2561
|
def RequestId(self):
|
|
2562
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2563
|
+
:rtype: str
|
|
2564
|
+
"""
|
|
2143
2565
|
return self._RequestId
|
|
2144
2566
|
|
|
2145
2567
|
@RequestId.setter
|
|
@@ -2181,6 +2603,9 @@ class DescribeRoomListRequest(AbstractModel):
|
|
|
2181
2603
|
|
|
2182
2604
|
@property
|
|
2183
2605
|
def SdkAppId(self):
|
|
2606
|
+
"""SdkAppId of the whiteboard application.
|
|
2607
|
+
:rtype: int
|
|
2608
|
+
"""
|
|
2184
2609
|
return self._SdkAppId
|
|
2185
2610
|
|
|
2186
2611
|
@SdkAppId.setter
|
|
@@ -2189,6 +2614,9 @@ class DescribeRoomListRequest(AbstractModel):
|
|
|
2189
2614
|
|
|
2190
2615
|
@property
|
|
2191
2616
|
def TimeRange(self):
|
|
2617
|
+
"""Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
|
|
2618
|
+
:rtype: list of int
|
|
2619
|
+
"""
|
|
2192
2620
|
return self._TimeRange
|
|
2193
2621
|
|
|
2194
2622
|
@TimeRange.setter
|
|
@@ -2197,6 +2625,9 @@ class DescribeRoomListRequest(AbstractModel):
|
|
|
2197
2625
|
|
|
2198
2626
|
@property
|
|
2199
2627
|
def Query(self):
|
|
2628
|
+
"""Extra query conditions.
|
|
2629
|
+
:rtype: str
|
|
2630
|
+
"""
|
|
2200
2631
|
return self._Query
|
|
2201
2632
|
|
|
2202
2633
|
@Query.setter
|
|
@@ -2205,6 +2636,9 @@ class DescribeRoomListRequest(AbstractModel):
|
|
|
2205
2636
|
|
|
2206
2637
|
@property
|
|
2207
2638
|
def MaxSize(self):
|
|
2639
|
+
"""Maximum number of data entries to be returned. Default value: 1000.
|
|
2640
|
+
:rtype: int
|
|
2641
|
+
"""
|
|
2208
2642
|
return self._MaxSize
|
|
2209
2643
|
|
|
2210
2644
|
@MaxSize.setter
|
|
@@ -2244,6 +2678,9 @@ class DescribeRoomListResponse(AbstractModel):
|
|
|
2244
2678
|
|
|
2245
2679
|
@property
|
|
2246
2680
|
def RoomList(self):
|
|
2681
|
+
"""List of rooms of the whiteboard.
|
|
2682
|
+
:rtype: list of RoomListItem
|
|
2683
|
+
"""
|
|
2247
2684
|
return self._RoomList
|
|
2248
2685
|
|
|
2249
2686
|
@RoomList.setter
|
|
@@ -2252,6 +2689,9 @@ class DescribeRoomListResponse(AbstractModel):
|
|
|
2252
2689
|
|
|
2253
2690
|
@property
|
|
2254
2691
|
def RequestId(self):
|
|
2692
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2693
|
+
:rtype: str
|
|
2694
|
+
"""
|
|
2255
2695
|
return self._RequestId
|
|
2256
2696
|
|
|
2257
2697
|
@RequestId.setter
|
|
@@ -2286,6 +2726,9 @@ class DescribeSnapshotTaskRequest(AbstractModel):
|
|
|
2286
2726
|
|
|
2287
2727
|
@property
|
|
2288
2728
|
def TaskID(self):
|
|
2729
|
+
"""ID of the query task.
|
|
2730
|
+
:rtype: str
|
|
2731
|
+
"""
|
|
2289
2732
|
return self._TaskID
|
|
2290
2733
|
|
|
2291
2734
|
@TaskID.setter
|
|
@@ -2294,6 +2737,9 @@ class DescribeSnapshotTaskRequest(AbstractModel):
|
|
|
2294
2737
|
|
|
2295
2738
|
@property
|
|
2296
2739
|
def SdkAppId(self):
|
|
2740
|
+
"""SdkAppId of the task.
|
|
2741
|
+
:rtype: int
|
|
2742
|
+
"""
|
|
2297
2743
|
return self._SdkAppId
|
|
2298
2744
|
|
|
2299
2745
|
@SdkAppId.setter
|
|
@@ -2350,6 +2796,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2350
2796
|
|
|
2351
2797
|
@property
|
|
2352
2798
|
def TaskID(self):
|
|
2799
|
+
"""Task ID.
|
|
2800
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
2801
|
+
:rtype: str
|
|
2802
|
+
"""
|
|
2353
2803
|
return self._TaskID
|
|
2354
2804
|
|
|
2355
2805
|
@TaskID.setter
|
|
@@ -2358,6 +2808,12 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2358
2808
|
|
|
2359
2809
|
@property
|
|
2360
2810
|
def Status(self):
|
|
2811
|
+
"""Task status.
|
|
2812
|
+
Running: The task is running.
|
|
2813
|
+
Finished: The task is finished.
|
|
2814
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
2815
|
+
:rtype: str
|
|
2816
|
+
"""
|
|
2361
2817
|
return self._Status
|
|
2362
2818
|
|
|
2363
2819
|
@Status.setter
|
|
@@ -2366,6 +2822,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2366
2822
|
|
|
2367
2823
|
@property
|
|
2368
2824
|
def CreateTime(self):
|
|
2825
|
+
"""Creation time of the task. Unit: seconds.
|
|
2826
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
2827
|
+
:rtype: int
|
|
2828
|
+
"""
|
|
2369
2829
|
return self._CreateTime
|
|
2370
2830
|
|
|
2371
2831
|
@CreateTime.setter
|
|
@@ -2374,6 +2834,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2374
2834
|
|
|
2375
2835
|
@property
|
|
2376
2836
|
def FinishTime(self):
|
|
2837
|
+
"""Completion time of the task. Unit: seconds.
|
|
2838
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
2839
|
+
:rtype: int
|
|
2840
|
+
"""
|
|
2377
2841
|
return self._FinishTime
|
|
2378
2842
|
|
|
2379
2843
|
@FinishTime.setter
|
|
@@ -2382,6 +2846,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2382
2846
|
|
|
2383
2847
|
@property
|
|
2384
2848
|
def Result(self):
|
|
2849
|
+
"""Task result information.
|
|
2850
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
2851
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.SnapshotResult`
|
|
2852
|
+
"""
|
|
2385
2853
|
return self._Result
|
|
2386
2854
|
|
|
2387
2855
|
@Result.setter
|
|
@@ -2390,6 +2858,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2390
2858
|
|
|
2391
2859
|
@property
|
|
2392
2860
|
def RequestId(self):
|
|
2861
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2862
|
+
:rtype: str
|
|
2863
|
+
"""
|
|
2393
2864
|
return self._RequestId
|
|
2394
2865
|
|
|
2395
2866
|
@RequestId.setter
|
|
@@ -2437,6 +2908,9 @@ Note: Dynamic transcoding multiplies the number of pages of a document by eight
|
|
|
2437
2908
|
|
|
2438
2909
|
@property
|
|
2439
2910
|
def SdkAppId(self):
|
|
2911
|
+
"""SdkAppId of the whiteboard application.
|
|
2912
|
+
:rtype: int
|
|
2913
|
+
"""
|
|
2440
2914
|
return self._SdkAppId
|
|
2441
2915
|
|
|
2442
2916
|
@SdkAppId.setter
|
|
@@ -2445,6 +2919,15 @@ Note: Dynamic transcoding multiplies the number of pages of a document by eight
|
|
|
2445
2919
|
|
|
2446
2920
|
@property
|
|
2447
2921
|
def SubProduct(self):
|
|
2922
|
+
"""Subproduct usage to be queried. The following parameters are supported:
|
|
2923
|
+
- sp_tiw_board: The duration of use of whiteboards, in minutes.
|
|
2924
|
+
- sp_tiw_dt: The number of pages dynamically transcoded.
|
|
2925
|
+
- sp_tiw_st: The number of pages statically transcoded.
|
|
2926
|
+
- sp_tiw_ric: The duration of real-time recording, in minutes.
|
|
2927
|
+
|
|
2928
|
+
Note: Dynamic transcoding multiplies the number of pages of a document by eight times. Static transcoding does not change the number of pages of a document.
|
|
2929
|
+
:rtype: str
|
|
2930
|
+
"""
|
|
2448
2931
|
return self._SubProduct
|
|
2449
2932
|
|
|
2450
2933
|
@SubProduct.setter
|
|
@@ -2453,6 +2936,9 @@ Note: Dynamic transcoding multiplies the number of pages of a document by eight
|
|
|
2453
2936
|
|
|
2454
2937
|
@property
|
|
2455
2938
|
def StartTime(self):
|
|
2939
|
+
"""Start date in the format of YYYY-MM-DD. The start date is included in the query period.
|
|
2940
|
+
:rtype: str
|
|
2941
|
+
"""
|
|
2456
2942
|
return self._StartTime
|
|
2457
2943
|
|
|
2458
2944
|
@StartTime.setter
|
|
@@ -2461,6 +2947,9 @@ Note: Dynamic transcoding multiplies the number of pages of a document by eight
|
|
|
2461
2947
|
|
|
2462
2948
|
@property
|
|
2463
2949
|
def EndTime(self):
|
|
2950
|
+
"""End date in the format of YYYY-MM-DD. The end date is included in the query period. The period queried per request cannot be longer than 31 days.
|
|
2951
|
+
:rtype: str
|
|
2952
|
+
"""
|
|
2464
2953
|
return self._EndTime
|
|
2465
2954
|
|
|
2466
2955
|
@EndTime.setter
|
|
@@ -2500,6 +2989,9 @@ class DescribeTIWDailyUsageResponse(AbstractModel):
|
|
|
2500
2989
|
|
|
2501
2990
|
@property
|
|
2502
2991
|
def Usages(self):
|
|
2992
|
+
"""Usage summary of a specified product during a specified query period.
|
|
2993
|
+
:rtype: list of UsageDataItem
|
|
2994
|
+
"""
|
|
2503
2995
|
return self._Usages
|
|
2504
2996
|
|
|
2505
2997
|
@Usages.setter
|
|
@@ -2508,6 +3000,9 @@ class DescribeTIWDailyUsageResponse(AbstractModel):
|
|
|
2508
3000
|
|
|
2509
3001
|
@property
|
|
2510
3002
|
def RequestId(self):
|
|
3003
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3004
|
+
:rtype: str
|
|
3005
|
+
"""
|
|
2511
3006
|
return self._RequestId
|
|
2512
3007
|
|
|
2513
3008
|
@RequestId.setter
|
|
@@ -2559,6 +3054,9 @@ class DescribeTIWRoomDailyUsageRequest(AbstractModel):
|
|
|
2559
3054
|
|
|
2560
3055
|
@property
|
|
2561
3056
|
def SdkAppId(self):
|
|
3057
|
+
"""SdkAppId of the whiteboard application.
|
|
3058
|
+
:rtype: int
|
|
3059
|
+
"""
|
|
2562
3060
|
return self._SdkAppId
|
|
2563
3061
|
|
|
2564
3062
|
@SdkAppId.setter
|
|
@@ -2567,6 +3065,11 @@ class DescribeTIWRoomDailyUsageRequest(AbstractModel):
|
|
|
2567
3065
|
|
|
2568
3066
|
@property
|
|
2569
3067
|
def SubProduct(self):
|
|
3068
|
+
"""Subproduct usage to be queried. The following parameters are supported:
|
|
3069
|
+
- sp_tiw_board: The duration of use of whiteboards, in minutes.
|
|
3070
|
+
- sp_tiw_ric: The duration of real-time recording, in minutes.
|
|
3071
|
+
:rtype: str
|
|
3072
|
+
"""
|
|
2570
3073
|
return self._SubProduct
|
|
2571
3074
|
|
|
2572
3075
|
@SubProduct.setter
|
|
@@ -2575,6 +3078,9 @@ class DescribeTIWRoomDailyUsageRequest(AbstractModel):
|
|
|
2575
3078
|
|
|
2576
3079
|
@property
|
|
2577
3080
|
def StartTime(self):
|
|
3081
|
+
"""Start date in the format of YYYY-MM-DD. The start date is included in the query period.
|
|
3082
|
+
:rtype: str
|
|
3083
|
+
"""
|
|
2578
3084
|
return self._StartTime
|
|
2579
3085
|
|
|
2580
3086
|
@StartTime.setter
|
|
@@ -2583,6 +3089,9 @@ class DescribeTIWRoomDailyUsageRequest(AbstractModel):
|
|
|
2583
3089
|
|
|
2584
3090
|
@property
|
|
2585
3091
|
def EndTime(self):
|
|
3092
|
+
"""End date in the format of YYYY-MM-DD. The end date is included in the query period. The period queried per request cannot be longer than 31 days.
|
|
3093
|
+
:rtype: str
|
|
3094
|
+
"""
|
|
2586
3095
|
return self._EndTime
|
|
2587
3096
|
|
|
2588
3097
|
@EndTime.setter
|
|
@@ -2591,6 +3100,9 @@ class DescribeTIWRoomDailyUsageRequest(AbstractModel):
|
|
|
2591
3100
|
|
|
2592
3101
|
@property
|
|
2593
3102
|
def RoomIDs(self):
|
|
3103
|
+
"""Room IDs to be queried. If you leave this parameter empty, all room IDs are queried.
|
|
3104
|
+
:rtype: list of int non-negative
|
|
3105
|
+
"""
|
|
2594
3106
|
return self._RoomIDs
|
|
2595
3107
|
|
|
2596
3108
|
@RoomIDs.setter
|
|
@@ -2599,6 +3111,9 @@ class DescribeTIWRoomDailyUsageRequest(AbstractModel):
|
|
|
2599
3111
|
|
|
2600
3112
|
@property
|
|
2601
3113
|
def Offset(self):
|
|
3114
|
+
"""Offset for query. Default value: `0`.
|
|
3115
|
+
:rtype: int
|
|
3116
|
+
"""
|
|
2602
3117
|
return self._Offset
|
|
2603
3118
|
|
|
2604
3119
|
@Offset.setter
|
|
@@ -2607,6 +3122,9 @@ class DescribeTIWRoomDailyUsageRequest(AbstractModel):
|
|
|
2607
3122
|
|
|
2608
3123
|
@property
|
|
2609
3124
|
def Limit(self):
|
|
3125
|
+
"""Maximum number of entries returned per query. Default value: `20`.
|
|
3126
|
+
:rtype: int
|
|
3127
|
+
"""
|
|
2610
3128
|
return self._Limit
|
|
2611
3129
|
|
|
2612
3130
|
@Limit.setter
|
|
@@ -2652,6 +3170,9 @@ class DescribeTIWRoomDailyUsageResponse(AbstractModel):
|
|
|
2652
3170
|
|
|
2653
3171
|
@property
|
|
2654
3172
|
def Usages(self):
|
|
3173
|
+
"""Usage of the specified product per room during the specified query period.
|
|
3174
|
+
:rtype: list of RoomUsageDataItem
|
|
3175
|
+
"""
|
|
2655
3176
|
return self._Usages
|
|
2656
3177
|
|
|
2657
3178
|
@Usages.setter
|
|
@@ -2660,6 +3181,9 @@ class DescribeTIWRoomDailyUsageResponse(AbstractModel):
|
|
|
2660
3181
|
|
|
2661
3182
|
@property
|
|
2662
3183
|
def Total(self):
|
|
3184
|
+
"""Number of usage data entries.
|
|
3185
|
+
:rtype: int
|
|
3186
|
+
"""
|
|
2663
3187
|
return self._Total
|
|
2664
3188
|
|
|
2665
3189
|
@Total.setter
|
|
@@ -2668,6 +3192,9 @@ class DescribeTIWRoomDailyUsageResponse(AbstractModel):
|
|
|
2668
3192
|
|
|
2669
3193
|
@property
|
|
2670
3194
|
def RequestId(self):
|
|
3195
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3196
|
+
:rtype: str
|
|
3197
|
+
"""
|
|
2671
3198
|
return self._RequestId
|
|
2672
3199
|
|
|
2673
3200
|
@RequestId.setter
|
|
@@ -2700,6 +3227,9 @@ class DescribeTranscodeCallbackRequest(AbstractModel):
|
|
|
2700
3227
|
|
|
2701
3228
|
@property
|
|
2702
3229
|
def SdkAppId(self):
|
|
3230
|
+
"""SdkAppId of the application
|
|
3231
|
+
:rtype: int
|
|
3232
|
+
"""
|
|
2703
3233
|
return self._SdkAppId
|
|
2704
3234
|
|
|
2705
3235
|
@SdkAppId.setter
|
|
@@ -2739,6 +3269,9 @@ class DescribeTranscodeCallbackResponse(AbstractModel):
|
|
|
2739
3269
|
|
|
2740
3270
|
@property
|
|
2741
3271
|
def Callback(self):
|
|
3272
|
+
"""Document transcoding callback address
|
|
3273
|
+
:rtype: str
|
|
3274
|
+
"""
|
|
2742
3275
|
return self._Callback
|
|
2743
3276
|
|
|
2744
3277
|
@Callback.setter
|
|
@@ -2747,6 +3280,9 @@ class DescribeTranscodeCallbackResponse(AbstractModel):
|
|
|
2747
3280
|
|
|
2748
3281
|
@property
|
|
2749
3282
|
def CallbackKey(self):
|
|
3283
|
+
"""Authentication key of the document transcoding callback
|
|
3284
|
+
:rtype: str
|
|
3285
|
+
"""
|
|
2750
3286
|
return self._CallbackKey
|
|
2751
3287
|
|
|
2752
3288
|
@CallbackKey.setter
|
|
@@ -2755,6 +3291,9 @@ class DescribeTranscodeCallbackResponse(AbstractModel):
|
|
|
2755
3291
|
|
|
2756
3292
|
@property
|
|
2757
3293
|
def RequestId(self):
|
|
3294
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3295
|
+
:rtype: str
|
|
3296
|
+
"""
|
|
2758
3297
|
return self._RequestId
|
|
2759
3298
|
|
|
2760
3299
|
@RequestId.setter
|
|
@@ -2785,6 +3324,9 @@ class DescribeTranscodeRequest(AbstractModel):
|
|
|
2785
3324
|
|
|
2786
3325
|
@property
|
|
2787
3326
|
def SdkAppId(self):
|
|
3327
|
+
"""SdkAppId of the customer
|
|
3328
|
+
:rtype: int
|
|
3329
|
+
"""
|
|
2788
3330
|
return self._SdkAppId
|
|
2789
3331
|
|
|
2790
3332
|
@SdkAppId.setter
|
|
@@ -2793,6 +3335,9 @@ class DescribeTranscodeRequest(AbstractModel):
|
|
|
2793
3335
|
|
|
2794
3336
|
@property
|
|
2795
3337
|
def TaskId(self):
|
|
3338
|
+
"""Unique ID of the document transcoding task
|
|
3339
|
+
:rtype: str
|
|
3340
|
+
"""
|
|
2796
3341
|
return self._TaskId
|
|
2797
3342
|
|
|
2798
3343
|
@TaskId.setter
|
|
@@ -2886,6 +3431,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2886
3431
|
|
|
2887
3432
|
@property
|
|
2888
3433
|
def Pages(self):
|
|
3434
|
+
"""Total number of document pages
|
|
3435
|
+
:rtype: int
|
|
3436
|
+
"""
|
|
2889
3437
|
return self._Pages
|
|
2890
3438
|
|
|
2891
3439
|
@Pages.setter
|
|
@@ -2894,6 +3442,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2894
3442
|
|
|
2895
3443
|
@property
|
|
2896
3444
|
def Progress(self):
|
|
3445
|
+
"""Transcoding progress. Value range: 0 to 100
|
|
3446
|
+
:rtype: int
|
|
3447
|
+
"""
|
|
2897
3448
|
return self._Progress
|
|
2898
3449
|
|
|
2899
3450
|
@Progress.setter
|
|
@@ -2902,6 +3453,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2902
3453
|
|
|
2903
3454
|
@property
|
|
2904
3455
|
def Resolution(self):
|
|
3456
|
+
"""Document resolution
|
|
3457
|
+
:rtype: str
|
|
3458
|
+
"""
|
|
2905
3459
|
return self._Resolution
|
|
2906
3460
|
|
|
2907
3461
|
@Resolution.setter
|
|
@@ -2910,6 +3464,12 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2910
3464
|
|
|
2911
3465
|
@property
|
|
2912
3466
|
def ResultUrl(self):
|
|
3467
|
+
"""URL of the transcoding result
|
|
3468
|
+
Dynamic transcoding: link of the HTML5 page transcoded from a PowerPoint file
|
|
3469
|
+
Static transcoding: URL prefix of the image transcoded for each document page. For example, if the URL prefix is `http://example.com/g0jb42ps49vtebjshilb/`, the image URL of the first page is
|
|
3470
|
+
`http://example.com/g0jb42ps49vtebjshilb/1.jpg`, and so on.
|
|
3471
|
+
:rtype: str
|
|
3472
|
+
"""
|
|
2913
3473
|
return self._ResultUrl
|
|
2914
3474
|
|
|
2915
3475
|
@ResultUrl.setter
|
|
@@ -2918,6 +3478,12 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2918
3478
|
|
|
2919
3479
|
@property
|
|
2920
3480
|
def Status(self):
|
|
3481
|
+
"""Current task state
|
|
3482
|
+
- QUEUED: queuing for transcoding
|
|
3483
|
+
- PROCESSING: transcoding is in progress
|
|
3484
|
+
- FINISHED: transcoded
|
|
3485
|
+
:rtype: str
|
|
3486
|
+
"""
|
|
2921
3487
|
return self._Status
|
|
2922
3488
|
|
|
2923
3489
|
@Status.setter
|
|
@@ -2926,6 +3492,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2926
3492
|
|
|
2927
3493
|
@property
|
|
2928
3494
|
def TaskId(self):
|
|
3495
|
+
"""Unique ID of the transcoding task
|
|
3496
|
+
:rtype: str
|
|
3497
|
+
"""
|
|
2929
3498
|
return self._TaskId
|
|
2930
3499
|
|
|
2931
3500
|
@TaskId.setter
|
|
@@ -2934,6 +3503,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2934
3503
|
|
|
2935
3504
|
@property
|
|
2936
3505
|
def Title(self):
|
|
3506
|
+
"""Document name
|
|
3507
|
+
:rtype: str
|
|
3508
|
+
"""
|
|
2937
3509
|
return self._Title
|
|
2938
3510
|
|
|
2939
3511
|
@Title.setter
|
|
@@ -2942,6 +3514,12 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2942
3514
|
|
|
2943
3515
|
@property
|
|
2944
3516
|
def ThumbnailUrl(self):
|
|
3517
|
+
"""URL prefix of the thumbnail. If the URL prefix is `http://example.com/g0jb42ps49vtebjshilb/ `, the thumbnail URL for the first page of the dynamically transcoded PowerPoint file is
|
|
3518
|
+
`http://example.com/g0jb42ps49vtebjshilb/1.jpg`, and so on.
|
|
3519
|
+
|
|
3520
|
+
If the document transcoding request carries the ThumbnailResolution parameter and the transcoding type is dynamic transcoding, this parameter is not null. In other cases, this parameter is null.
|
|
3521
|
+
:rtype: str
|
|
3522
|
+
"""
|
|
2945
3523
|
return self._ThumbnailUrl
|
|
2946
3524
|
|
|
2947
3525
|
@ThumbnailUrl.setter
|
|
@@ -2950,6 +3528,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2950
3528
|
|
|
2951
3529
|
@property
|
|
2952
3530
|
def ThumbnailResolution(self):
|
|
3531
|
+
"""Resolution of the thumbnail generated for dynamic transcoding
|
|
3532
|
+
:rtype: str
|
|
3533
|
+
"""
|
|
2953
3534
|
return self._ThumbnailResolution
|
|
2954
3535
|
|
|
2955
3536
|
@ThumbnailResolution.setter
|
|
@@ -2958,6 +3539,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2958
3539
|
|
|
2959
3540
|
@property
|
|
2960
3541
|
def CompressFileUrl(self):
|
|
3542
|
+
"""URL for downloading the transcoded and compressed file. If `CompressFileType` carried in the document transcoding request is null or is not a supported compression format, this parameter is null.
|
|
3543
|
+
:rtype: str
|
|
3544
|
+
"""
|
|
2961
3545
|
return self._CompressFileUrl
|
|
2962
3546
|
|
|
2963
3547
|
@CompressFileUrl.setter
|
|
@@ -2966,7 +3550,11 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2966
3550
|
|
|
2967
3551
|
@property
|
|
2968
3552
|
def ResourceListUrl(self):
|
|
2969
|
-
|
|
3553
|
+
"""Download URL (for trial) of the resource list.
|
|
3554
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
3555
|
+
:rtype: str
|
|
3556
|
+
"""
|
|
3557
|
+
return self._ResourceListUrl
|
|
2970
3558
|
|
|
2971
3559
|
@ResourceListUrl.setter
|
|
2972
3560
|
def ResourceListUrl(self, ResourceListUrl):
|
|
@@ -2974,6 +3562,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2974
3562
|
|
|
2975
3563
|
@property
|
|
2976
3564
|
def Ext(self):
|
|
3565
|
+
"""Document generation mode (for trial).
|
|
3566
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
3567
|
+
:rtype: str
|
|
3568
|
+
"""
|
|
2977
3569
|
return self._Ext
|
|
2978
3570
|
|
|
2979
3571
|
@Ext.setter
|
|
@@ -2982,6 +3574,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2982
3574
|
|
|
2983
3575
|
@property
|
|
2984
3576
|
def CreateTime(self):
|
|
3577
|
+
"""Document transcoding task creation time, unit: seconds.
|
|
3578
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
3579
|
+
:rtype: int
|
|
3580
|
+
"""
|
|
2985
3581
|
return self._CreateTime
|
|
2986
3582
|
|
|
2987
3583
|
@CreateTime.setter
|
|
@@ -2990,6 +3586,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2990
3586
|
|
|
2991
3587
|
@property
|
|
2992
3588
|
def AssignTime(self):
|
|
3589
|
+
"""Document transcoding task assignment time, unit: seconds.
|
|
3590
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
3591
|
+
:rtype: int
|
|
3592
|
+
"""
|
|
2993
3593
|
return self._AssignTime
|
|
2994
3594
|
|
|
2995
3595
|
@AssignTime.setter
|
|
@@ -2998,6 +3598,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
2998
3598
|
|
|
2999
3599
|
@property
|
|
3000
3600
|
def FinishedTime(self):
|
|
3601
|
+
"""Document transcoding task finished time, unit: seconds.
|
|
3602
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
3603
|
+
:rtype: int
|
|
3604
|
+
"""
|
|
3001
3605
|
return self._FinishedTime
|
|
3002
3606
|
|
|
3003
3607
|
@FinishedTime.setter
|
|
@@ -3006,6 +3610,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
3006
3610
|
|
|
3007
3611
|
@property
|
|
3008
3612
|
def RequestId(self):
|
|
3613
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3614
|
+
:rtype: str
|
|
3615
|
+
"""
|
|
3009
3616
|
return self._RequestId
|
|
3010
3617
|
|
|
3011
3618
|
@RequestId.setter
|
|
@@ -3058,6 +3665,9 @@ class DescribeTranscodeSearchResponse(AbstractModel):
|
|
|
3058
3665
|
|
|
3059
3666
|
@property
|
|
3060
3667
|
def TranscodeTaskSet(self):
|
|
3668
|
+
"""The set of queried transcoding tasks.
|
|
3669
|
+
:rtype: list of TranscodeTaskSearchResult
|
|
3670
|
+
"""
|
|
3061
3671
|
return self._TranscodeTaskSet
|
|
3062
3672
|
|
|
3063
3673
|
@TranscodeTaskSet.setter
|
|
@@ -3066,6 +3676,9 @@ class DescribeTranscodeSearchResponse(AbstractModel):
|
|
|
3066
3676
|
|
|
3067
3677
|
@property
|
|
3068
3678
|
def TotalCount(self):
|
|
3679
|
+
"""Number of transcoding tasks.
|
|
3680
|
+
:rtype: int
|
|
3681
|
+
"""
|
|
3069
3682
|
return self._TotalCount
|
|
3070
3683
|
|
|
3071
3684
|
@TotalCount.setter
|
|
@@ -3074,6 +3687,9 @@ class DescribeTranscodeSearchResponse(AbstractModel):
|
|
|
3074
3687
|
|
|
3075
3688
|
@property
|
|
3076
3689
|
def RequestId(self):
|
|
3690
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3691
|
+
:rtype: str
|
|
3692
|
+
"""
|
|
3077
3693
|
return self._RequestId
|
|
3078
3694
|
|
|
3079
3695
|
@RequestId.setter
|
|
@@ -3116,6 +3732,9 @@ false: Returns raw data.
|
|
|
3116
3732
|
|
|
3117
3733
|
@property
|
|
3118
3734
|
def BeginTime(self):
|
|
3735
|
+
"""Start time of the query period.
|
|
3736
|
+
:rtype: str
|
|
3737
|
+
"""
|
|
3119
3738
|
return self._BeginTime
|
|
3120
3739
|
|
|
3121
3740
|
@BeginTime.setter
|
|
@@ -3124,6 +3743,9 @@ false: Returns raw data.
|
|
|
3124
3743
|
|
|
3125
3744
|
@property
|
|
3126
3745
|
def EndTime(self):
|
|
3746
|
+
"""End time of the query period.
|
|
3747
|
+
:rtype: str
|
|
3748
|
+
"""
|
|
3127
3749
|
return self._EndTime
|
|
3128
3750
|
|
|
3129
3751
|
@EndTime.setter
|
|
@@ -3132,6 +3754,9 @@ false: Returns raw data.
|
|
|
3132
3754
|
|
|
3133
3755
|
@property
|
|
3134
3756
|
def SubProducts(self):
|
|
3757
|
+
"""Subproducts whose usage you want to query.
|
|
3758
|
+
:rtype: list of str
|
|
3759
|
+
"""
|
|
3135
3760
|
return self._SubProducts
|
|
3136
3761
|
|
|
3137
3762
|
@SubProducts.setter
|
|
@@ -3140,6 +3765,10 @@ false: Returns raw data.
|
|
|
3140
3765
|
|
|
3141
3766
|
@property
|
|
3142
3767
|
def IsWeighted(self):
|
|
3768
|
+
"""true: Returns weighted data.
|
|
3769
|
+
false: Returns raw data.
|
|
3770
|
+
:rtype: bool
|
|
3771
|
+
"""
|
|
3143
3772
|
return self._IsWeighted
|
|
3144
3773
|
|
|
3145
3774
|
@IsWeighted.setter
|
|
@@ -3176,6 +3805,9 @@ class DescribeUsageSummaryResponse(AbstractModel):
|
|
|
3176
3805
|
|
|
3177
3806
|
@property
|
|
3178
3807
|
def RequestId(self):
|
|
3808
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3809
|
+
:rtype: str
|
|
3810
|
+
"""
|
|
3179
3811
|
return self._RequestId
|
|
3180
3812
|
|
|
3181
3813
|
@RequestId.setter
|
|
@@ -3213,6 +3845,9 @@ class DescribeUserListRequest(AbstractModel):
|
|
|
3213
3845
|
|
|
3214
3846
|
@property
|
|
3215
3847
|
def SdkAppId(self):
|
|
3848
|
+
"""SdkAppId of the whiteboard application.
|
|
3849
|
+
:rtype: int
|
|
3850
|
+
"""
|
|
3216
3851
|
return self._SdkAppId
|
|
3217
3852
|
|
|
3218
3853
|
@SdkAppId.setter
|
|
@@ -3221,6 +3856,9 @@ class DescribeUserListRequest(AbstractModel):
|
|
|
3221
3856
|
|
|
3222
3857
|
@property
|
|
3223
3858
|
def RoomId(self):
|
|
3859
|
+
"""Room ID to be used to query users.
|
|
3860
|
+
:rtype: str
|
|
3861
|
+
"""
|
|
3224
3862
|
return self._RoomId
|
|
3225
3863
|
|
|
3226
3864
|
@RoomId.setter
|
|
@@ -3229,6 +3867,9 @@ class DescribeUserListRequest(AbstractModel):
|
|
|
3229
3867
|
|
|
3230
3868
|
@property
|
|
3231
3869
|
def TimeRange(self):
|
|
3870
|
+
"""Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time.
|
|
3871
|
+
:rtype: list of int
|
|
3872
|
+
"""
|
|
3232
3873
|
return self._TimeRange
|
|
3233
3874
|
|
|
3234
3875
|
@TimeRange.setter
|
|
@@ -3237,6 +3878,9 @@ class DescribeUserListRequest(AbstractModel):
|
|
|
3237
3878
|
|
|
3238
3879
|
@property
|
|
3239
3880
|
def Query(self):
|
|
3881
|
+
"""Extra query conditions.
|
|
3882
|
+
:rtype: str
|
|
3883
|
+
"""
|
|
3240
3884
|
return self._Query
|
|
3241
3885
|
|
|
3242
3886
|
@Query.setter
|
|
@@ -3245,6 +3889,9 @@ class DescribeUserListRequest(AbstractModel):
|
|
|
3245
3889
|
|
|
3246
3890
|
@property
|
|
3247
3891
|
def MaxSize(self):
|
|
3892
|
+
"""Maximum number of data entries to be returned. Default value: `1000`.
|
|
3893
|
+
:rtype: int
|
|
3894
|
+
"""
|
|
3248
3895
|
return self._MaxSize
|
|
3249
3896
|
|
|
3250
3897
|
@MaxSize.setter
|
|
@@ -3285,6 +3932,9 @@ class DescribeUserListResponse(AbstractModel):
|
|
|
3285
3932
|
|
|
3286
3933
|
@property
|
|
3287
3934
|
def UserList(self):
|
|
3935
|
+
"""User list of the room.
|
|
3936
|
+
:rtype: list of UserListItem
|
|
3937
|
+
"""
|
|
3288
3938
|
return self._UserList
|
|
3289
3939
|
|
|
3290
3940
|
@UserList.setter
|
|
@@ -3293,6 +3943,9 @@ class DescribeUserListResponse(AbstractModel):
|
|
|
3293
3943
|
|
|
3294
3944
|
@property
|
|
3295
3945
|
def RequestId(self):
|
|
3946
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3947
|
+
:rtype: str
|
|
3948
|
+
"""
|
|
3296
3949
|
return self._RequestId
|
|
3297
3950
|
|
|
3298
3951
|
@RequestId.setter
|
|
@@ -3330,6 +3983,9 @@ class DescribeUserResourcesResponse(AbstractModel):
|
|
|
3330
3983
|
|
|
3331
3984
|
@property
|
|
3332
3985
|
def RequestId(self):
|
|
3986
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3987
|
+
:rtype: str
|
|
3988
|
+
"""
|
|
3333
3989
|
return self._RequestId
|
|
3334
3990
|
|
|
3335
3991
|
@RequestId.setter
|
|
@@ -3379,6 +4035,9 @@ class DescribeUserStatusResponse(AbstractModel):
|
|
|
3379
4035
|
|
|
3380
4036
|
@property
|
|
3381
4037
|
def AppId(self):
|
|
4038
|
+
"""AppId of the customer.
|
|
4039
|
+
:rtype: int
|
|
4040
|
+
"""
|
|
3382
4041
|
return self._AppId
|
|
3383
4042
|
|
|
3384
4043
|
@AppId.setter
|
|
@@ -3387,6 +4046,12 @@ class DescribeUserStatusResponse(AbstractModel):
|
|
|
3387
4046
|
|
|
3388
4047
|
@property
|
|
3389
4048
|
def IsTiwUser(self):
|
|
4049
|
+
"""Specifies whether the whiteboard service of the trial or official edition is activated before.
|
|
4050
|
+
|
|
4051
|
+
0: The whiteboard service is not activated.
|
|
4052
|
+
1: The whiteboard service is activated.
|
|
4053
|
+
:rtype: int
|
|
4054
|
+
"""
|
|
3390
4055
|
return self._IsTiwUser
|
|
3391
4056
|
|
|
3392
4057
|
@IsTiwUser.setter
|
|
@@ -3395,6 +4060,9 @@ class DescribeUserStatusResponse(AbstractModel):
|
|
|
3395
4060
|
|
|
3396
4061
|
@property
|
|
3397
4062
|
def IsSaaSUser(self):
|
|
4063
|
+
"""Specifies whether the interactive class feature of the trial or official edition is activated before.
|
|
4064
|
+
:rtype: int
|
|
4065
|
+
"""
|
|
3398
4066
|
return self._IsSaaSUser
|
|
3399
4067
|
|
|
3400
4068
|
@IsSaaSUser.setter
|
|
@@ -3403,6 +4071,9 @@ class DescribeUserStatusResponse(AbstractModel):
|
|
|
3403
4071
|
|
|
3404
4072
|
@property
|
|
3405
4073
|
def IsTiwOfflineRecordUser(self):
|
|
4074
|
+
"""Specifies whether the user uses the offline recording feature of the whiteboard service.
|
|
4075
|
+
:rtype: int
|
|
4076
|
+
"""
|
|
3406
4077
|
return self._IsTiwOfflineRecordUser
|
|
3407
4078
|
|
|
3408
4079
|
@IsTiwOfflineRecordUser.setter
|
|
@@ -3411,6 +4082,9 @@ class DescribeUserStatusResponse(AbstractModel):
|
|
|
3411
4082
|
|
|
3412
4083
|
@property
|
|
3413
4084
|
def IsAuthenticated(self):
|
|
4085
|
+
"""Specifies whether the user is authenticated.
|
|
4086
|
+
:rtype: int
|
|
4087
|
+
"""
|
|
3414
4088
|
return self._IsAuthenticated
|
|
3415
4089
|
|
|
3416
4090
|
@IsAuthenticated.setter
|
|
@@ -3419,6 +4093,9 @@ class DescribeUserStatusResponse(AbstractModel):
|
|
|
3419
4093
|
|
|
3420
4094
|
@property
|
|
3421
4095
|
def RequestId(self):
|
|
4096
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4097
|
+
:rtype: str
|
|
4098
|
+
"""
|
|
3422
4099
|
return self._RequestId
|
|
3423
4100
|
|
|
3424
4101
|
@RequestId.setter
|
|
@@ -3449,6 +4126,9 @@ class DescribeVideoGenerationTaskCallbackRequest(AbstractModel):
|
|
|
3449
4126
|
|
|
3450
4127
|
@property
|
|
3451
4128
|
def SdkAppId(self):
|
|
4129
|
+
"""SdkAppId of the whiteboard application.
|
|
4130
|
+
:rtype: int
|
|
4131
|
+
"""
|
|
3452
4132
|
return self._SdkAppId
|
|
3453
4133
|
|
|
3454
4134
|
@SdkAppId.setter
|
|
@@ -3488,6 +4168,9 @@ class DescribeVideoGenerationTaskCallbackResponse(AbstractModel):
|
|
|
3488
4168
|
|
|
3489
4169
|
@property
|
|
3490
4170
|
def Callback(self):
|
|
4171
|
+
"""Callback URL for recording video generation.
|
|
4172
|
+
:rtype: str
|
|
4173
|
+
"""
|
|
3491
4174
|
return self._Callback
|
|
3492
4175
|
|
|
3493
4176
|
@Callback.setter
|
|
@@ -3496,6 +4179,9 @@ class DescribeVideoGenerationTaskCallbackResponse(AbstractModel):
|
|
|
3496
4179
|
|
|
3497
4180
|
@property
|
|
3498
4181
|
def CallbackKey(self):
|
|
4182
|
+
"""Callback authentication key for recording video generation.
|
|
4183
|
+
:rtype: str
|
|
4184
|
+
"""
|
|
3499
4185
|
return self._CallbackKey
|
|
3500
4186
|
|
|
3501
4187
|
@CallbackKey.setter
|
|
@@ -3504,6 +4190,9 @@ class DescribeVideoGenerationTaskCallbackResponse(AbstractModel):
|
|
|
3504
4190
|
|
|
3505
4191
|
@property
|
|
3506
4192
|
def RequestId(self):
|
|
4193
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4194
|
+
:rtype: str
|
|
4195
|
+
"""
|
|
3507
4196
|
return self._RequestId
|
|
3508
4197
|
|
|
3509
4198
|
@RequestId.setter
|
|
@@ -3534,6 +4223,9 @@ class DescribeVideoGenerationTaskRequest(AbstractModel):
|
|
|
3534
4223
|
|
|
3535
4224
|
@property
|
|
3536
4225
|
def SdkAppId(self):
|
|
4226
|
+
"""SdkAppId of the whiteboard application.
|
|
4227
|
+
:rtype: int
|
|
4228
|
+
"""
|
|
3537
4229
|
return self._SdkAppId
|
|
3538
4230
|
|
|
3539
4231
|
@SdkAppId.setter
|
|
@@ -3542,6 +4234,9 @@ class DescribeVideoGenerationTaskRequest(AbstractModel):
|
|
|
3542
4234
|
|
|
3543
4235
|
@property
|
|
3544
4236
|
def TaskId(self):
|
|
4237
|
+
"""ID of the recording video generation task.
|
|
4238
|
+
:rtype: str
|
|
4239
|
+
"""
|
|
3545
4240
|
return self._TaskId
|
|
3546
4241
|
|
|
3547
4242
|
@TaskId.setter
|
|
@@ -3603,6 +4298,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3603
4298
|
|
|
3604
4299
|
@property
|
|
3605
4300
|
def GroupId(self):
|
|
4301
|
+
"""Group ID corresponding to the task.
|
|
4302
|
+
:rtype: str
|
|
4303
|
+
"""
|
|
3606
4304
|
return self._GroupId
|
|
3607
4305
|
|
|
3608
4306
|
@GroupId.setter
|
|
@@ -3611,6 +4309,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3611
4309
|
|
|
3612
4310
|
@property
|
|
3613
4311
|
def RoomId(self):
|
|
4312
|
+
"""Room ID corresponding to the task.
|
|
4313
|
+
:rtype: int
|
|
4314
|
+
"""
|
|
3614
4315
|
return self._RoomId
|
|
3615
4316
|
|
|
3616
4317
|
@RoomId.setter
|
|
@@ -3619,6 +4320,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3619
4320
|
|
|
3620
4321
|
@property
|
|
3621
4322
|
def TaskId(self):
|
|
4323
|
+
"""Task ID.
|
|
4324
|
+
:rtype: str
|
|
4325
|
+
"""
|
|
3622
4326
|
return self._TaskId
|
|
3623
4327
|
|
|
3624
4328
|
@TaskId.setter
|
|
@@ -3627,6 +4331,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3627
4331
|
|
|
3628
4332
|
@property
|
|
3629
4333
|
def Progress(self):
|
|
4334
|
+
"""Disused.
|
|
4335
|
+
:rtype: int
|
|
4336
|
+
"""
|
|
3630
4337
|
return self._Progress
|
|
3631
4338
|
|
|
3632
4339
|
@Progress.setter
|
|
@@ -3635,6 +4342,12 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3635
4342
|
|
|
3636
4343
|
@property
|
|
3637
4344
|
def Status(self):
|
|
4345
|
+
"""Status of the recording video generation task. Valid values:
|
|
4346
|
+
- QUEUED: Queuing.
|
|
4347
|
+
- PROCESSING: Video generation in progress.
|
|
4348
|
+
- FINISHED: Video generation finished. (To determine whether the task succeeded or failed, check the error code and message.)
|
|
4349
|
+
:rtype: str
|
|
4350
|
+
"""
|
|
3638
4351
|
return self._Status
|
|
3639
4352
|
|
|
3640
4353
|
@Status.setter
|
|
@@ -3643,6 +4356,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3643
4356
|
|
|
3644
4357
|
@property
|
|
3645
4358
|
def TotalTime(self):
|
|
4359
|
+
"""Total video playback duration. Unit: milliseconds.
|
|
4360
|
+
:rtype: int
|
|
4361
|
+
"""
|
|
3646
4362
|
return self._TotalTime
|
|
3647
4363
|
|
|
3648
4364
|
@TotalTime.setter
|
|
@@ -3651,6 +4367,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3651
4367
|
|
|
3652
4368
|
@property
|
|
3653
4369
|
def VideoInfos(self):
|
|
4370
|
+
"""Disused. Use the `VideoInfoList` parameter.
|
|
4371
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.VideoInfo`
|
|
4372
|
+
"""
|
|
3654
4373
|
return self._VideoInfos
|
|
3655
4374
|
|
|
3656
4375
|
@VideoInfos.setter
|
|
@@ -3659,6 +4378,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3659
4378
|
|
|
3660
4379
|
@property
|
|
3661
4380
|
def VideoInfoList(self):
|
|
4381
|
+
"""List of videos generated by the recording video generation tasks.
|
|
4382
|
+
:rtype: list of VideoInfo
|
|
4383
|
+
"""
|
|
3662
4384
|
return self._VideoInfoList
|
|
3663
4385
|
|
|
3664
4386
|
@VideoInfoList.setter
|
|
@@ -3667,6 +4389,9 @@ class DescribeVideoGenerationTaskResponse(AbstractModel):
|
|
|
3667
4389
|
|
|
3668
4390
|
@property
|
|
3669
4391
|
def RequestId(self):
|
|
4392
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4393
|
+
:rtype: str
|
|
4394
|
+
"""
|
|
3670
4395
|
return self._RequestId
|
|
3671
4396
|
|
|
3672
4397
|
@RequestId.setter
|
|
@@ -3715,6 +4440,9 @@ transcode: Document transcoding.
|
|
|
3715
4440
|
|
|
3716
4441
|
@property
|
|
3717
4442
|
def SdkAppId(self):
|
|
4443
|
+
"""SdkAppId of the whiteboard application.
|
|
4444
|
+
:rtype: int
|
|
4445
|
+
"""
|
|
3718
4446
|
return self._SdkAppId
|
|
3719
4447
|
|
|
3720
4448
|
@SdkAppId.setter
|
|
@@ -3723,6 +4451,11 @@ transcode: Document transcoding.
|
|
|
3723
4451
|
|
|
3724
4452
|
@property
|
|
3725
4453
|
def TaskTypes(self):
|
|
4454
|
+
"""Task types to be queried.
|
|
4455
|
+
recording: Real-time recording.
|
|
4456
|
+
transcode: Document transcoding.
|
|
4457
|
+
:rtype: list of str
|
|
4458
|
+
"""
|
|
3726
4459
|
return self._TaskTypes
|
|
3727
4460
|
|
|
3728
4461
|
@TaskTypes.setter
|
|
@@ -3731,6 +4464,9 @@ transcode: Document transcoding.
|
|
|
3731
4464
|
|
|
3732
4465
|
@property
|
|
3733
4466
|
def SdkAppIds(self):
|
|
4467
|
+
"""SdkAppIds to be used to query configurations.
|
|
4468
|
+
:rtype: list of int
|
|
4469
|
+
"""
|
|
3734
4470
|
return self._SdkAppIds
|
|
3735
4471
|
|
|
3736
4472
|
@SdkAppIds.setter
|
|
@@ -3772,6 +4508,9 @@ class DescribeWhiteboardApplicationConfigResponse(AbstractModel):
|
|
|
3772
4508
|
|
|
3773
4509
|
@property
|
|
3774
4510
|
def SdkAppId(self):
|
|
4511
|
+
"""SdkAppId of the whiteboard application.
|
|
4512
|
+
:rtype: int
|
|
4513
|
+
"""
|
|
3775
4514
|
return self._SdkAppId
|
|
3776
4515
|
|
|
3777
4516
|
@SdkAppId.setter
|
|
@@ -3780,6 +4519,9 @@ class DescribeWhiteboardApplicationConfigResponse(AbstractModel):
|
|
|
3780
4519
|
|
|
3781
4520
|
@property
|
|
3782
4521
|
def Configs(self):
|
|
4522
|
+
"""Task-related configurations of the whiteboard application.
|
|
4523
|
+
:rtype: list of WhiteboardApplicationConfig
|
|
4524
|
+
"""
|
|
3783
4525
|
return self._Configs
|
|
3784
4526
|
|
|
3785
4527
|
@Configs.setter
|
|
@@ -3788,6 +4530,9 @@ class DescribeWhiteboardApplicationConfigResponse(AbstractModel):
|
|
|
3788
4530
|
|
|
3789
4531
|
@property
|
|
3790
4532
|
def RequestId(self):
|
|
4533
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4534
|
+
:rtype: str
|
|
4535
|
+
"""
|
|
3791
4536
|
return self._RequestId
|
|
3792
4537
|
|
|
3793
4538
|
@RequestId.setter
|
|
@@ -3825,6 +4570,9 @@ transcode: Document transcoding.
|
|
|
3825
4570
|
|
|
3826
4571
|
@property
|
|
3827
4572
|
def SdkAppId(self):
|
|
4573
|
+
"""SdkAppId of the whiteboard application.
|
|
4574
|
+
:rtype: int
|
|
4575
|
+
"""
|
|
3828
4576
|
return self._SdkAppId
|
|
3829
4577
|
|
|
3830
4578
|
@SdkAppId.setter
|
|
@@ -3833,6 +4581,11 @@ transcode: Document transcoding.
|
|
|
3833
4581
|
|
|
3834
4582
|
@property
|
|
3835
4583
|
def TaskType(self):
|
|
4584
|
+
"""Task type to be queried.
|
|
4585
|
+
recording: Real-time recording.
|
|
4586
|
+
transcode: Document transcoding.
|
|
4587
|
+
:rtype: str
|
|
4588
|
+
"""
|
|
3836
4589
|
return self._TaskType
|
|
3837
4590
|
|
|
3838
4591
|
@TaskType.setter
|
|
@@ -3867,6 +4620,9 @@ class DescribeWhiteboardBucketConfigResponse(AbstractModel):
|
|
|
3867
4620
|
|
|
3868
4621
|
@property
|
|
3869
4622
|
def RequestId(self):
|
|
4623
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4624
|
+
:rtype: str
|
|
4625
|
+
"""
|
|
3870
4626
|
return self._RequestId
|
|
3871
4627
|
|
|
3872
4628
|
@RequestId.setter
|
|
@@ -3892,6 +4648,9 @@ class DescribeWhiteboardPushCallbackRequest(AbstractModel):
|
|
|
3892
4648
|
|
|
3893
4649
|
@property
|
|
3894
4650
|
def SdkAppId(self):
|
|
4651
|
+
"""SdkAppId of the whiteboard application.
|
|
4652
|
+
:rtype: int
|
|
4653
|
+
"""
|
|
3895
4654
|
return self._SdkAppId
|
|
3896
4655
|
|
|
3897
4656
|
@SdkAppId.setter
|
|
@@ -3931,6 +4690,9 @@ class DescribeWhiteboardPushCallbackResponse(AbstractModel):
|
|
|
3931
4690
|
|
|
3932
4691
|
@property
|
|
3933
4692
|
def Callback(self):
|
|
4693
|
+
"""Callback URL of the whiteboard push event. If no callback URL is set, this parameter is null.
|
|
4694
|
+
:rtype: str
|
|
4695
|
+
"""
|
|
3934
4696
|
return self._Callback
|
|
3935
4697
|
|
|
3936
4698
|
@Callback.setter
|
|
@@ -3939,6 +4701,9 @@ class DescribeWhiteboardPushCallbackResponse(AbstractModel):
|
|
|
3939
4701
|
|
|
3940
4702
|
@property
|
|
3941
4703
|
def CallbackKey(self):
|
|
4704
|
+
"""Callback authentication key for whiteboard push.
|
|
4705
|
+
:rtype: str
|
|
4706
|
+
"""
|
|
3942
4707
|
return self._CallbackKey
|
|
3943
4708
|
|
|
3944
4709
|
@CallbackKey.setter
|
|
@@ -3947,6 +4712,9 @@ class DescribeWhiteboardPushCallbackResponse(AbstractModel):
|
|
|
3947
4712
|
|
|
3948
4713
|
@property
|
|
3949
4714
|
def RequestId(self):
|
|
4715
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4716
|
+
:rtype: str
|
|
4717
|
+
"""
|
|
3950
4718
|
return self._RequestId
|
|
3951
4719
|
|
|
3952
4720
|
@RequestId.setter
|
|
@@ -3977,6 +4745,9 @@ class DescribeWhiteboardPushRequest(AbstractModel):
|
|
|
3977
4745
|
|
|
3978
4746
|
@property
|
|
3979
4747
|
def SdkAppId(self):
|
|
4748
|
+
"""SdkAppId of the whiteboard application.
|
|
4749
|
+
:rtype: int
|
|
4750
|
+
"""
|
|
3980
4751
|
return self._SdkAppId
|
|
3981
4752
|
|
|
3982
4753
|
@SdkAppId.setter
|
|
@@ -3985,6 +4756,9 @@ class DescribeWhiteboardPushRequest(AbstractModel):
|
|
|
3985
4756
|
|
|
3986
4757
|
@property
|
|
3987
4758
|
def TaskId(self):
|
|
4759
|
+
"""ID of the whiteboard push task.
|
|
4760
|
+
:rtype: str
|
|
4761
|
+
"""
|
|
3988
4762
|
return self._TaskId
|
|
3989
4763
|
|
|
3990
4764
|
@TaskId.setter
|
|
@@ -4059,6 +4833,12 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4059
4833
|
|
|
4060
4834
|
@property
|
|
4061
4835
|
def FinishReason(self):
|
|
4836
|
+
"""Reason for push stop.
|
|
4837
|
+
- AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time.
|
|
4838
|
+
- USER_CALL: The API for stopping pushing is called.
|
|
4839
|
+
- EXCEPTION: An exception occurred.
|
|
4840
|
+
:rtype: str
|
|
4841
|
+
"""
|
|
4062
4842
|
return self._FinishReason
|
|
4063
4843
|
|
|
4064
4844
|
@FinishReason.setter
|
|
@@ -4067,6 +4847,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4067
4847
|
|
|
4068
4848
|
@property
|
|
4069
4849
|
def TaskId(self):
|
|
4850
|
+
"""ID of the whiteboard push task.
|
|
4851
|
+
:rtype: str
|
|
4852
|
+
"""
|
|
4070
4853
|
return self._TaskId
|
|
4071
4854
|
|
|
4072
4855
|
@TaskId.setter
|
|
@@ -4075,6 +4858,12 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4075
4858
|
|
|
4076
4859
|
@property
|
|
4077
4860
|
def Status(self):
|
|
4861
|
+
"""Status of the push task.
|
|
4862
|
+
- PREPARED: Push in preparation (including entering the room and starting the push service).
|
|
4863
|
+
- PUSHING: Pushing in progress.
|
|
4864
|
+
- STOPPED: Pushing stopped.
|
|
4865
|
+
:rtype: str
|
|
4866
|
+
"""
|
|
4078
4867
|
return self._Status
|
|
4079
4868
|
|
|
4080
4869
|
@Status.setter
|
|
@@ -4083,6 +4872,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4083
4872
|
|
|
4084
4873
|
@property
|
|
4085
4874
|
def RoomId(self):
|
|
4875
|
+
"""Room ID.
|
|
4876
|
+
:rtype: int
|
|
4877
|
+
"""
|
|
4086
4878
|
return self._RoomId
|
|
4087
4879
|
|
|
4088
4880
|
@RoomId.setter
|
|
@@ -4091,6 +4883,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4091
4883
|
|
|
4092
4884
|
@property
|
|
4093
4885
|
def GroupId(self):
|
|
4886
|
+
"""Group ID of the whiteboard.
|
|
4887
|
+
:rtype: str
|
|
4888
|
+
"""
|
|
4094
4889
|
return self._GroupId
|
|
4095
4890
|
|
|
4096
4891
|
@GroupId.setter
|
|
@@ -4099,6 +4894,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4099
4894
|
|
|
4100
4895
|
@property
|
|
4101
4896
|
def PushUserId(self):
|
|
4897
|
+
"""User ID of the push task.
|
|
4898
|
+
:rtype: str
|
|
4899
|
+
"""
|
|
4102
4900
|
return self._PushUserId
|
|
4103
4901
|
|
|
4104
4902
|
@PushUserId.setter
|
|
@@ -4107,6 +4905,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4107
4905
|
|
|
4108
4906
|
@property
|
|
4109
4907
|
def PushStartTime(self):
|
|
4908
|
+
"""Actual push start time, which is a Unix timestamp in seconds.
|
|
4909
|
+
:rtype: int
|
|
4910
|
+
"""
|
|
4110
4911
|
return self._PushStartTime
|
|
4111
4912
|
|
|
4112
4913
|
@PushStartTime.setter
|
|
@@ -4115,6 +4916,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4115
4916
|
|
|
4116
4917
|
@property
|
|
4117
4918
|
def PushStopTime(self):
|
|
4919
|
+
"""Actual push stop time, which is a Unix timestamp in seconds.
|
|
4920
|
+
:rtype: int
|
|
4921
|
+
"""
|
|
4118
4922
|
return self._PushStopTime
|
|
4119
4923
|
|
|
4120
4924
|
@PushStopTime.setter
|
|
@@ -4123,6 +4927,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4123
4927
|
|
|
4124
4928
|
@property
|
|
4125
4929
|
def ExceptionCnt(self):
|
|
4930
|
+
"""Number of exceptions during push.
|
|
4931
|
+
:rtype: int
|
|
4932
|
+
"""
|
|
4126
4933
|
return self._ExceptionCnt
|
|
4127
4934
|
|
|
4128
4935
|
@ExceptionCnt.setter
|
|
@@ -4131,6 +4938,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4131
4938
|
|
|
4132
4939
|
@property
|
|
4133
4940
|
def IMSyncTime(self):
|
|
4941
|
+
"""IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.
|
|
4942
|
+
:rtype: int
|
|
4943
|
+
"""
|
|
4134
4944
|
return self._IMSyncTime
|
|
4135
4945
|
|
|
4136
4946
|
@IMSyncTime.setter
|
|
@@ -4139,6 +4949,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4139
4949
|
|
|
4140
4950
|
@property
|
|
4141
4951
|
def Backup(self):
|
|
4952
|
+
"""Result information of the backup push task.
|
|
4953
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
4954
|
+
:rtype: str
|
|
4955
|
+
"""
|
|
4142
4956
|
return self._Backup
|
|
4143
4957
|
|
|
4144
4958
|
@Backup.setter
|
|
@@ -4147,6 +4961,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4147
4961
|
|
|
4148
4962
|
@property
|
|
4149
4963
|
def RequestId(self):
|
|
4964
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4965
|
+
:rtype: str
|
|
4966
|
+
"""
|
|
4150
4967
|
return self._RequestId
|
|
4151
4968
|
|
|
4152
4969
|
@RequestId.setter
|
|
@@ -4195,6 +5012,9 @@ class DescribeWhiteboardPushSearchResponse(AbstractModel):
|
|
|
4195
5012
|
|
|
4196
5013
|
@property
|
|
4197
5014
|
def WhiteboardPushTaskSet(self):
|
|
5015
|
+
"""The set of queried push tasks.
|
|
5016
|
+
:rtype: list of WhiteboardPushTaskSearchResult
|
|
5017
|
+
"""
|
|
4198
5018
|
return self._WhiteboardPushTaskSet
|
|
4199
5019
|
|
|
4200
5020
|
@WhiteboardPushTaskSet.setter
|
|
@@ -4203,6 +5023,9 @@ class DescribeWhiteboardPushSearchResponse(AbstractModel):
|
|
|
4203
5023
|
|
|
4204
5024
|
@property
|
|
4205
5025
|
def TotalCount(self):
|
|
5026
|
+
"""Number of push tasks.
|
|
5027
|
+
:rtype: int
|
|
5028
|
+
"""
|
|
4206
5029
|
return self._TotalCount
|
|
4207
5030
|
|
|
4208
5031
|
@TotalCount.setter
|
|
@@ -4211,6 +5034,9 @@ class DescribeWhiteboardPushSearchResponse(AbstractModel):
|
|
|
4211
5034
|
|
|
4212
5035
|
@property
|
|
4213
5036
|
def RequestId(self):
|
|
5037
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5038
|
+
:rtype: str
|
|
5039
|
+
"""
|
|
4214
5040
|
return self._RequestId
|
|
4215
5041
|
|
|
4216
5042
|
@RequestId.setter
|
|
@@ -4249,6 +5075,9 @@ class Detail(AbstractModel):
|
|
|
4249
5075
|
|
|
4250
5076
|
@property
|
|
4251
5077
|
def TagName(self):
|
|
5078
|
+
"""Usage metric.
|
|
5079
|
+
:rtype: str
|
|
5080
|
+
"""
|
|
4252
5081
|
return self._TagName
|
|
4253
5082
|
|
|
4254
5083
|
@TagName.setter
|
|
@@ -4257,6 +5086,9 @@ class Detail(AbstractModel):
|
|
|
4257
5086
|
|
|
4258
5087
|
@property
|
|
4259
5088
|
def Weight(self):
|
|
5089
|
+
"""Usage weight.
|
|
5090
|
+
:rtype: float
|
|
5091
|
+
"""
|
|
4260
5092
|
return self._Weight
|
|
4261
5093
|
|
|
4262
5094
|
@Weight.setter
|
|
@@ -4265,6 +5097,9 @@ class Detail(AbstractModel):
|
|
|
4265
5097
|
|
|
4266
5098
|
@property
|
|
4267
5099
|
def Value(self):
|
|
5100
|
+
"""Usage value.
|
|
5101
|
+
:rtype: float
|
|
5102
|
+
"""
|
|
4268
5103
|
return self._Value
|
|
4269
5104
|
|
|
4270
5105
|
@Value.setter
|
|
@@ -4305,6 +5140,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4305
5140
|
|
|
4306
5141
|
@property
|
|
4307
5142
|
def UserId(self):
|
|
5143
|
+
"""User ID.
|
|
5144
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
5145
|
+
:rtype: str
|
|
5146
|
+
"""
|
|
4308
5147
|
return self._UserId
|
|
4309
5148
|
|
|
4310
5149
|
@UserId.setter
|
|
@@ -4313,6 +5152,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
4313
5152
|
|
|
4314
5153
|
@property
|
|
4315
5154
|
def Count(self):
|
|
5155
|
+
"""Number of video stream interruptions.
|
|
5156
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
5157
|
+
:rtype: int
|
|
5158
|
+
"""
|
|
4316
5159
|
return self._Count
|
|
4317
5160
|
|
|
4318
5161
|
@Count.setter
|
|
@@ -4360,6 +5203,9 @@ The Z axis determines the overlap sequence of images. The image with the largest
|
|
|
4360
5203
|
|
|
4361
5204
|
@property
|
|
4362
5205
|
def Width(self):
|
|
5206
|
+
"""Stream image width. Value range: [2,3000]
|
|
5207
|
+
:rtype: int
|
|
5208
|
+
"""
|
|
4363
5209
|
return self._Width
|
|
4364
5210
|
|
|
4365
5211
|
@Width.setter
|
|
@@ -4368,6 +5214,9 @@ The Z axis determines the overlap sequence of images. The image with the largest
|
|
|
4368
5214
|
|
|
4369
5215
|
@property
|
|
4370
5216
|
def Height(self):
|
|
5217
|
+
"""Stream image height. Value range: [2,3000]
|
|
5218
|
+
:rtype: int
|
|
5219
|
+
"""
|
|
4371
5220
|
return self._Height
|
|
4372
5221
|
|
|
4373
5222
|
@Height.setter
|
|
@@ -4376,6 +5225,9 @@ The Z axis determines the overlap sequence of images. The image with the largest
|
|
|
4376
5225
|
|
|
4377
5226
|
@property
|
|
4378
5227
|
def X(self):
|
|
5228
|
+
"""Offset of the top point in the upper-left corner of the current image to the X axis of the top point in the upper-left corner of the canvas. Default value: 0. Value range: [0,3000].
|
|
5229
|
+
:rtype: int
|
|
5230
|
+
"""
|
|
4379
5231
|
return self._X
|
|
4380
5232
|
|
|
4381
5233
|
@X.setter
|
|
@@ -4384,6 +5236,9 @@ The Z axis determines the overlap sequence of images. The image with the largest
|
|
|
4384
5236
|
|
|
4385
5237
|
@property
|
|
4386
5238
|
def Y(self):
|
|
5239
|
+
"""Offset of the top point in the upper-left corner of the current image to the Y axis of the top point in the upper-left corner of the canvas. Default value: 0. Value range: [0,3000].
|
|
5240
|
+
:rtype: int
|
|
5241
|
+
"""
|
|
4387
5242
|
return self._Y
|
|
4388
5243
|
|
|
4389
5244
|
@Y.setter
|
|
@@ -4392,6 +5247,10 @@ The Z axis determines the overlap sequence of images. The image with the largest
|
|
|
4392
5247
|
|
|
4393
5248
|
@property
|
|
4394
5249
|
def ZOrder(self):
|
|
5250
|
+
"""Z-axis position of the image. The default value is 0.
|
|
5251
|
+
The Z axis determines the overlap sequence of images. The image with the largest z-axis value is at the top layer.
|
|
5252
|
+
:rtype: int
|
|
5253
|
+
"""
|
|
4395
5254
|
return self._ZOrder
|
|
4396
5255
|
|
|
4397
5256
|
@ZOrder.setter
|
|
@@ -4445,6 +5304,9 @@ If this parameter is available, the ModelId and TeacherId fields will be ignored
|
|
|
4445
5304
|
|
|
4446
5305
|
@property
|
|
4447
5306
|
def Enabled(self):
|
|
5307
|
+
"""Whether stream mixing is enabled
|
|
5308
|
+
:rtype: bool
|
|
5309
|
+
"""
|
|
4448
5310
|
return self._Enabled
|
|
4449
5311
|
|
|
4450
5312
|
@Enabled.setter
|
|
@@ -4453,6 +5315,9 @@ If this parameter is available, the ModelId and TeacherId fields will be ignored
|
|
|
4453
5315
|
|
|
4454
5316
|
@property
|
|
4455
5317
|
def DisableAudio(self):
|
|
5318
|
+
"""Whether audio stream mixing is disabled
|
|
5319
|
+
:rtype: bool
|
|
5320
|
+
"""
|
|
4456
5321
|
return self._DisableAudio
|
|
4457
5322
|
|
|
4458
5323
|
@DisableAudio.setter
|
|
@@ -4461,6 +5326,10 @@ If this parameter is available, the ModelId and TeacherId fields will be ignored
|
|
|
4461
5326
|
|
|
4462
5327
|
@property
|
|
4463
5328
|
def ModelId(self):
|
|
5329
|
+
"""ID of the embedded mixed stream layout template. Valid values: 1 and 2. For more information on the differences of both values, see the sample embedded mixed stream layout template.
|
|
5330
|
+
If the Custom field is not specified, ModelId is required.
|
|
5331
|
+
:rtype: int
|
|
5332
|
+
"""
|
|
4464
5333
|
return self._ModelId
|
|
4465
5334
|
|
|
4466
5335
|
@ModelId.setter
|
|
@@ -4469,6 +5338,11 @@ If this parameter is available, the ModelId and TeacherId fields will be ignored
|
|
|
4469
5338
|
|
|
4470
5339
|
@property
|
|
4471
5340
|
def TeacherId(self):
|
|
5341
|
+
"""ID of a teacher account
|
|
5342
|
+
This field is valid only when ModelId is specified.
|
|
5343
|
+
If you specify TeacherID for a user, the user's video stream will be displayed in the first image of the embedded template.
|
|
5344
|
+
:rtype: str
|
|
5345
|
+
"""
|
|
4472
5346
|
return self._TeacherId
|
|
4473
5347
|
|
|
4474
5348
|
@TeacherId.setter
|
|
@@ -4477,6 +5351,10 @@ If this parameter is available, the ModelId and TeacherId fields will be ignored
|
|
|
4477
5351
|
|
|
4478
5352
|
@property
|
|
4479
5353
|
def Custom(self):
|
|
5354
|
+
"""Custom mixed stream layout parameter
|
|
5355
|
+
If this parameter is available, the ModelId and TeacherId fields will be ignored.
|
|
5356
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.CustomLayout`
|
|
5357
|
+
"""
|
|
4480
5358
|
return self._Custom
|
|
4481
5359
|
|
|
4482
5360
|
@Custom.setter
|
|
@@ -4519,6 +5397,9 @@ class ModifyApplicationRequest(AbstractModel):
|
|
|
4519
5397
|
|
|
4520
5398
|
@property
|
|
4521
5399
|
def SdkAppId(self):
|
|
5400
|
+
"""SdkAppId of the whiteboard application.
|
|
5401
|
+
:rtype: int
|
|
5402
|
+
"""
|
|
4522
5403
|
return self._SdkAppId
|
|
4523
5404
|
|
|
4524
5405
|
@SdkAppId.setter
|
|
@@ -4527,6 +5408,9 @@ class ModifyApplicationRequest(AbstractModel):
|
|
|
4527
5408
|
|
|
4528
5409
|
@property
|
|
4529
5410
|
def AppName(self):
|
|
5411
|
+
"""Application name.
|
|
5412
|
+
:rtype: str
|
|
5413
|
+
"""
|
|
4530
5414
|
return self._AppName
|
|
4531
5415
|
|
|
4532
5416
|
@AppName.setter
|
|
@@ -4561,6 +5445,9 @@ class ModifyApplicationResponse(AbstractModel):
|
|
|
4561
5445
|
|
|
4562
5446
|
@property
|
|
4563
5447
|
def RequestId(self):
|
|
5448
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5449
|
+
:rtype: str
|
|
5450
|
+
"""
|
|
4564
5451
|
return self._RequestId
|
|
4565
5452
|
|
|
4566
5453
|
@RequestId.setter
|
|
@@ -4592,6 +5479,9 @@ class ModifyAutoRenewFlagRequest(AbstractModel):
|
|
|
4592
5479
|
|
|
4593
5480
|
@property
|
|
4594
5481
|
def SubProduct(self):
|
|
5482
|
+
"""Subproduct ID. To obtain this ID, call the `DescribeUserResources` API and find the subproduct ID of the monthly feature package with the level 1. Usually the value is `sp_tiw_package`.
|
|
5483
|
+
:rtype: str
|
|
5484
|
+
"""
|
|
4595
5485
|
return self._SubProduct
|
|
4596
5486
|
|
|
4597
5487
|
@SubProduct.setter
|
|
@@ -4600,6 +5490,9 @@ class ModifyAutoRenewFlagRequest(AbstractModel):
|
|
|
4600
5490
|
|
|
4601
5491
|
@property
|
|
4602
5492
|
def ResourceId(self):
|
|
5493
|
+
"""Resource ID. To obtain this ID, call the `DescribeUserResources` API and find the resource ID of the monthly feature package with the level 1.
|
|
5494
|
+
:rtype: str
|
|
5495
|
+
"""
|
|
4603
5496
|
return self._ResourceId
|
|
4604
5497
|
|
|
4605
5498
|
@ResourceId.setter
|
|
@@ -4608,6 +5501,9 @@ class ModifyAutoRenewFlagRequest(AbstractModel):
|
|
|
4608
5501
|
|
|
4609
5502
|
@property
|
|
4610
5503
|
def AutoRenewFlag(self):
|
|
5504
|
+
"""Renewal mode. Valid values: `0` (default mode, which is auto-renewal), `1` (auto-renewal), `2` (manual renewal, which is specified by users). If no renewal is required, set it to `0`.
|
|
5505
|
+
:rtype: int
|
|
5506
|
+
"""
|
|
4611
5507
|
return self._AutoRenewFlag
|
|
4612
5508
|
|
|
4613
5509
|
@AutoRenewFlag.setter
|
|
@@ -4643,6 +5539,9 @@ class ModifyAutoRenewFlagResponse(AbstractModel):
|
|
|
4643
5539
|
|
|
4644
5540
|
@property
|
|
4645
5541
|
def RequestId(self):
|
|
5542
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5543
|
+
:rtype: str
|
|
5544
|
+
"""
|
|
4646
5545
|
return self._RequestId
|
|
4647
5546
|
|
|
4648
5547
|
@RequestId.setter
|
|
@@ -4671,6 +5570,9 @@ class ModifyWhiteboardApplicationConfigRequest(AbstractModel):
|
|
|
4671
5570
|
|
|
4672
5571
|
@property
|
|
4673
5572
|
def SdkAppId(self):
|
|
5573
|
+
"""SdkAppId of the whiteboard application.
|
|
5574
|
+
:rtype: int
|
|
5575
|
+
"""
|
|
4674
5576
|
return self._SdkAppId
|
|
4675
5577
|
|
|
4676
5578
|
@SdkAppId.setter
|
|
@@ -4679,6 +5581,9 @@ class ModifyWhiteboardApplicationConfigRequest(AbstractModel):
|
|
|
4679
5581
|
|
|
4680
5582
|
@property
|
|
4681
5583
|
def Configs(self):
|
|
5584
|
+
"""Task-related configurations of the whiteboard application.
|
|
5585
|
+
:rtype: list of WhiteboardApplicationConfig
|
|
5586
|
+
"""
|
|
4682
5587
|
return self._Configs
|
|
4683
5588
|
|
|
4684
5589
|
@Configs.setter
|
|
@@ -4718,6 +5623,9 @@ class ModifyWhiteboardApplicationConfigResponse(AbstractModel):
|
|
|
4718
5623
|
|
|
4719
5624
|
@property
|
|
4720
5625
|
def RequestId(self):
|
|
5626
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5627
|
+
:rtype: str
|
|
5628
|
+
"""
|
|
4721
5629
|
return self._RequestId
|
|
4722
5630
|
|
|
4723
5631
|
@RequestId.setter
|
|
@@ -4760,6 +5668,9 @@ transcode: Document transcoding.
|
|
|
4760
5668
|
|
|
4761
5669
|
@property
|
|
4762
5670
|
def SdkAppId(self):
|
|
5671
|
+
"""SdkAppId of the whiteboard application.
|
|
5672
|
+
:rtype: int
|
|
5673
|
+
"""
|
|
4763
5674
|
return self._SdkAppId
|
|
4764
5675
|
|
|
4765
5676
|
@SdkAppId.setter
|
|
@@ -4768,6 +5679,11 @@ transcode: Document transcoding.
|
|
|
4768
5679
|
|
|
4769
5680
|
@property
|
|
4770
5681
|
def TaskType(self):
|
|
5682
|
+
"""Task type to be queried.
|
|
5683
|
+
recording: Real-time recording.
|
|
5684
|
+
transcode: Document transcoding.
|
|
5685
|
+
:rtype: str
|
|
5686
|
+
"""
|
|
4771
5687
|
return self._TaskType
|
|
4772
5688
|
|
|
4773
5689
|
@TaskType.setter
|
|
@@ -4776,6 +5692,9 @@ transcode: Document transcoding.
|
|
|
4776
5692
|
|
|
4777
5693
|
@property
|
|
4778
5694
|
def BucketName(self):
|
|
5695
|
+
"""Name of the COS bucket.
|
|
5696
|
+
:rtype: str
|
|
5697
|
+
"""
|
|
4779
5698
|
return self._BucketName
|
|
4780
5699
|
|
|
4781
5700
|
@BucketName.setter
|
|
@@ -4784,6 +5703,9 @@ transcode: Document transcoding.
|
|
|
4784
5703
|
|
|
4785
5704
|
@property
|
|
4786
5705
|
def BucketLocation(self):
|
|
5706
|
+
"""Region of the COS bucket.
|
|
5707
|
+
:rtype: str
|
|
5708
|
+
"""
|
|
4787
5709
|
return self._BucketLocation
|
|
4788
5710
|
|
|
4789
5711
|
@BucketLocation.setter
|
|
@@ -4792,6 +5714,9 @@ transcode: Document transcoding.
|
|
|
4792
5714
|
|
|
4793
5715
|
@property
|
|
4794
5716
|
def BucketPrefix(self):
|
|
5717
|
+
"""Resource prefix of the bucket.
|
|
5718
|
+
:rtype: str
|
|
5719
|
+
"""
|
|
4795
5720
|
return self._BucketPrefix
|
|
4796
5721
|
|
|
4797
5722
|
@BucketPrefix.setter
|
|
@@ -4800,6 +5725,9 @@ transcode: Document transcoding.
|
|
|
4800
5725
|
|
|
4801
5726
|
@property
|
|
4802
5727
|
def ResultDomain(self):
|
|
5728
|
+
"""Domain name of the URL of the bucket.
|
|
5729
|
+
:rtype: str
|
|
5730
|
+
"""
|
|
4803
5731
|
return self._ResultDomain
|
|
4804
5732
|
|
|
4805
5733
|
@ResultDomain.setter
|
|
@@ -4838,6 +5766,9 @@ class ModifyWhiteboardBucketConfigResponse(AbstractModel):
|
|
|
4838
5766
|
|
|
4839
5767
|
@property
|
|
4840
5768
|
def RequestId(self):
|
|
5769
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5770
|
+
:rtype: str
|
|
5771
|
+
"""
|
|
4841
5772
|
return self._RequestId
|
|
4842
5773
|
|
|
4843
5774
|
@RequestId.setter
|
|
@@ -4869,6 +5800,9 @@ class OmittedDuration(AbstractModel):
|
|
|
4869
5800
|
|
|
4870
5801
|
@property
|
|
4871
5802
|
def VideoTime(self):
|
|
5803
|
+
"""Offset of the paused time in the spliced video, in milliseconds
|
|
5804
|
+
:rtype: int
|
|
5805
|
+
"""
|
|
4872
5806
|
return self._VideoTime
|
|
4873
5807
|
|
|
4874
5808
|
@VideoTime.setter
|
|
@@ -4877,6 +5811,9 @@ class OmittedDuration(AbstractModel):
|
|
|
4877
5811
|
|
|
4878
5812
|
@property
|
|
4879
5813
|
def PauseTime(self):
|
|
5814
|
+
"""Recording pause timestamp, in milliseconds
|
|
5815
|
+
:rtype: int
|
|
5816
|
+
"""
|
|
4880
5817
|
return self._PauseTime
|
|
4881
5818
|
|
|
4882
5819
|
@PauseTime.setter
|
|
@@ -4885,6 +5822,9 @@ class OmittedDuration(AbstractModel):
|
|
|
4885
5822
|
|
|
4886
5823
|
@property
|
|
4887
5824
|
def ResumeTime(self):
|
|
5825
|
+
"""Recording resumption timestamp, in milliseconds
|
|
5826
|
+
:rtype: int
|
|
5827
|
+
"""
|
|
4888
5828
|
return self._ResumeTime
|
|
4889
5829
|
|
|
4890
5830
|
@ResumeTime.setter
|
|
@@ -4923,6 +5863,9 @@ class PauseOnlineRecordRequest(AbstractModel):
|
|
|
4923
5863
|
|
|
4924
5864
|
@property
|
|
4925
5865
|
def SdkAppId(self):
|
|
5866
|
+
"""SdkAppId of the customer
|
|
5867
|
+
:rtype: int
|
|
5868
|
+
"""
|
|
4926
5869
|
return self._SdkAppId
|
|
4927
5870
|
|
|
4928
5871
|
@SdkAppId.setter
|
|
@@ -4931,6 +5874,9 @@ class PauseOnlineRecordRequest(AbstractModel):
|
|
|
4931
5874
|
|
|
4932
5875
|
@property
|
|
4933
5876
|
def TaskId(self):
|
|
5877
|
+
"""ID of the real-time recording task
|
|
5878
|
+
:rtype: str
|
|
5879
|
+
"""
|
|
4934
5880
|
return self._TaskId
|
|
4935
5881
|
|
|
4936
5882
|
@TaskId.setter
|
|
@@ -4965,6 +5911,9 @@ class PauseOnlineRecordResponse(AbstractModel):
|
|
|
4965
5911
|
|
|
4966
5912
|
@property
|
|
4967
5913
|
def RequestId(self):
|
|
5914
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5915
|
+
:rtype: str
|
|
5916
|
+
"""
|
|
4968
5917
|
return self._RequestId
|
|
4969
5918
|
|
|
4970
5919
|
@RequestId.setter
|
|
@@ -5017,6 +5966,9 @@ The setting in this parameter is applied to all streams. However, if `StreamCont
|
|
|
5017
5966
|
|
|
5018
5967
|
@property
|
|
5019
5968
|
def Enabled(self):
|
|
5969
|
+
"""It specifies whether to enable RecordControl. Valid values: true (yes); false (no).
|
|
5970
|
+
:rtype: bool
|
|
5971
|
+
"""
|
|
5020
5972
|
return self._Enabled
|
|
5021
5973
|
|
|
5022
5974
|
@Enabled.setter
|
|
@@ -5025,6 +5977,14 @@ The setting in this parameter is applied to all streams. However, if `StreamCont
|
|
|
5025
5977
|
|
|
5026
5978
|
@property
|
|
5027
5979
|
def DisableRecord(self):
|
|
5980
|
+
"""A global parameter generally used in conjunction with `StreamControls` that specifies whether to disable recording. Valid values:
|
|
5981
|
+
|
|
5982
|
+
true: no stream is recorded.
|
|
5983
|
+
false: all streams are recorded. Default value: false.
|
|
5984
|
+
|
|
5985
|
+
The setting in this parameter is applied to all streams. However, if `StreamControls` is passed in, the parameters in `StreamControls` will take precedence.
|
|
5986
|
+
:rtype: bool
|
|
5987
|
+
"""
|
|
5028
5988
|
return self._DisableRecord
|
|
5029
5989
|
|
|
5030
5990
|
@DisableRecord.setter
|
|
@@ -5033,6 +5993,14 @@ The setting in this parameter is applied to all streams. However, if `StreamCont
|
|
|
5033
5993
|
|
|
5034
5994
|
@property
|
|
5035
5995
|
def DisableAudio(self):
|
|
5996
|
+
"""A global parameter generally used in conjunction with `StreamControls` that specifies whether to disable audio recording over all streams. Valid values:
|
|
5997
|
+
|
|
5998
|
+
true: no audio recording of any streams.
|
|
5999
|
+
false: audio recording of all streams. Default value: false.
|
|
6000
|
+
|
|
6001
|
+
The setting in this parameter is applied to all streams. However, if `StreamControls` is passed in, the parameters in `StreamControls` will take precedence.
|
|
6002
|
+
:rtype: bool
|
|
6003
|
+
"""
|
|
5036
6004
|
return self._DisableAudio
|
|
5037
6005
|
|
|
5038
6006
|
@DisableAudio.setter
|
|
@@ -5041,6 +6009,14 @@ The setting in this parameter is applied to all streams. However, if `StreamCont
|
|
|
5041
6009
|
|
|
5042
6010
|
@property
|
|
5043
6011
|
def PullSmallVideo(self):
|
|
6012
|
+
"""A global parameter generally used in conjunction with `StreamControls` that specifies whether to record low-resolution videos only. Valid values:
|
|
6013
|
+
|
|
6014
|
+
true: only records low-resolution videos for all streams. Please ensure that the up-streaming end pushes the low-resolution videos. Otherwise, the recorded video may be black.
|
|
6015
|
+
false: high-resolution video recording of all streams. Default value: false.
|
|
6016
|
+
|
|
6017
|
+
The setting in this parameter is applied to all streams. However, if `StreamControls` is passed in, the parameters in `StreamControls` will take precedence.
|
|
6018
|
+
:rtype: bool
|
|
6019
|
+
"""
|
|
5044
6020
|
return self._PullSmallVideo
|
|
5045
6021
|
|
|
5046
6022
|
@PullSmallVideo.setter
|
|
@@ -5049,6 +6025,9 @@ The setting in this parameter is applied to all streams. However, if `StreamCont
|
|
|
5049
6025
|
|
|
5050
6026
|
@property
|
|
5051
6027
|
def StreamControls(self):
|
|
6028
|
+
"""Parameters over specific streams, which take priority over global configurations. If it’s empty, all streams are recorded according to the global configurations.
|
|
6029
|
+
:rtype: list of StreamControl
|
|
6030
|
+
"""
|
|
5052
6031
|
return self._StreamControls
|
|
5053
6032
|
|
|
5054
6033
|
@StreamControls.setter
|
|
@@ -5124,6 +6103,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5124
6103
|
|
|
5125
6104
|
@property
|
|
5126
6105
|
def FinishReason(self):
|
|
6106
|
+
"""`AUTO`: Recording automatically stops. `USER_CALL`: The API for stopping recording is called.
|
|
6107
|
+
:rtype: str
|
|
6108
|
+
"""
|
|
5127
6109
|
return self._FinishReason
|
|
5128
6110
|
|
|
5129
6111
|
@FinishReason.setter
|
|
@@ -5132,6 +6114,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5132
6114
|
|
|
5133
6115
|
@property
|
|
5134
6116
|
def ExceptionCnt(self):
|
|
6117
|
+
"""Number of exceptions.
|
|
6118
|
+
:rtype: int
|
|
6119
|
+
"""
|
|
5135
6120
|
return self._ExceptionCnt
|
|
5136
6121
|
|
|
5137
6122
|
@ExceptionCnt.setter
|
|
@@ -5140,6 +6125,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5140
6125
|
|
|
5141
6126
|
@property
|
|
5142
6127
|
def RoomId(self):
|
|
6128
|
+
"""Room ID.
|
|
6129
|
+
:rtype: int
|
|
6130
|
+
"""
|
|
5143
6131
|
return self._RoomId
|
|
5144
6132
|
|
|
5145
6133
|
@RoomId.setter
|
|
@@ -5148,6 +6136,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5148
6136
|
|
|
5149
6137
|
@property
|
|
5150
6138
|
def GroupId(self):
|
|
6139
|
+
"""Group ID.
|
|
6140
|
+
:rtype: str
|
|
6141
|
+
"""
|
|
5151
6142
|
return self._GroupId
|
|
5152
6143
|
|
|
5153
6144
|
@GroupId.setter
|
|
@@ -5156,6 +6147,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5156
6147
|
|
|
5157
6148
|
@property
|
|
5158
6149
|
def RecordStartTime(self):
|
|
6150
|
+
"""Actual recording start time.
|
|
6151
|
+
:rtype: int
|
|
6152
|
+
"""
|
|
5159
6153
|
return self._RecordStartTime
|
|
5160
6154
|
|
|
5161
6155
|
@RecordStartTime.setter
|
|
@@ -5164,6 +6158,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5164
6158
|
|
|
5165
6159
|
@property
|
|
5166
6160
|
def RecordStopTime(self):
|
|
6161
|
+
"""Recording end time.
|
|
6162
|
+
:rtype: int
|
|
6163
|
+
"""
|
|
5167
6164
|
return self._RecordStopTime
|
|
5168
6165
|
|
|
5169
6166
|
@RecordStopTime.setter
|
|
@@ -5172,6 +6169,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5172
6169
|
|
|
5173
6170
|
@property
|
|
5174
6171
|
def TotalTime(self):
|
|
6172
|
+
"""Recording duration.
|
|
6173
|
+
:rtype: int
|
|
6174
|
+
"""
|
|
5175
6175
|
return self._TotalTime
|
|
5176
6176
|
|
|
5177
6177
|
@TotalTime.setter
|
|
@@ -5180,6 +6180,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5180
6180
|
|
|
5181
6181
|
@property
|
|
5182
6182
|
def VideoInfos(self):
|
|
6183
|
+
"""List of video information.
|
|
6184
|
+
:rtype: list of VideoInfo
|
|
6185
|
+
"""
|
|
5183
6186
|
return self._VideoInfos
|
|
5184
6187
|
|
|
5185
6188
|
@VideoInfos.setter
|
|
@@ -5188,6 +6191,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5188
6191
|
|
|
5189
6192
|
@property
|
|
5190
6193
|
def OmittedDurations(self):
|
|
6194
|
+
"""Omitted video durations.
|
|
6195
|
+
:rtype: list of OmittedDuration
|
|
6196
|
+
"""
|
|
5191
6197
|
return self._OmittedDurations
|
|
5192
6198
|
|
|
5193
6199
|
@OmittedDurations.setter
|
|
@@ -5196,6 +6202,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5196
6202
|
|
|
5197
6203
|
@property
|
|
5198
6204
|
def Details(self):
|
|
6205
|
+
"""Details.
|
|
6206
|
+
:rtype: str
|
|
6207
|
+
"""
|
|
5199
6208
|
return self._Details
|
|
5200
6209
|
|
|
5201
6210
|
@Details.setter
|
|
@@ -5204,6 +6213,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5204
6213
|
|
|
5205
6214
|
@property
|
|
5206
6215
|
def ErrorCode(self):
|
|
6216
|
+
"""Task execution error code.
|
|
6217
|
+
:rtype: int
|
|
6218
|
+
"""
|
|
5207
6219
|
return self._ErrorCode
|
|
5208
6220
|
|
|
5209
6221
|
@ErrorCode.setter
|
|
@@ -5212,6 +6224,9 @@ class RecordTaskResult(AbstractModel):
|
|
|
5212
6224
|
|
|
5213
6225
|
@property
|
|
5214
6226
|
def ErrorMsg(self):
|
|
6227
|
+
"""Error message.
|
|
6228
|
+
:rtype: str
|
|
6229
|
+
"""
|
|
5215
6230
|
return self._ErrorMsg
|
|
5216
6231
|
|
|
5217
6232
|
@ErrorMsg.setter
|
|
@@ -5286,6 +6301,9 @@ class RecordTaskSearchResult(AbstractModel):
|
|
|
5286
6301
|
|
|
5287
6302
|
@property
|
|
5288
6303
|
def TaskId(self):
|
|
6304
|
+
"""Unique task ID.
|
|
6305
|
+
:rtype: str
|
|
6306
|
+
"""
|
|
5289
6307
|
return self._TaskId
|
|
5290
6308
|
|
|
5291
6309
|
@TaskId.setter
|
|
@@ -5294,6 +6312,14 @@ class RecordTaskSearchResult(AbstractModel):
|
|
|
5294
6312
|
|
|
5295
6313
|
@property
|
|
5296
6314
|
def Status(self):
|
|
6315
|
+
"""Status of the real-time recording task.
|
|
6316
|
+
- PAUSED: Recording paused.
|
|
6317
|
+
- PREPARED: Recording in preparation.
|
|
6318
|
+
- RECORDING: Recording in progress.
|
|
6319
|
+
- STOPPED: Recording stopped.
|
|
6320
|
+
- FINISHED: Recording finished.
|
|
6321
|
+
:rtype: str
|
|
6322
|
+
"""
|
|
5297
6323
|
return self._Status
|
|
5298
6324
|
|
|
5299
6325
|
@Status.setter
|
|
@@ -5302,6 +6328,9 @@ class RecordTaskSearchResult(AbstractModel):
|
|
|
5302
6328
|
|
|
5303
6329
|
@property
|
|
5304
6330
|
def RoomId(self):
|
|
6331
|
+
"""Room ID of the real-time recording task.
|
|
6332
|
+
:rtype: int
|
|
6333
|
+
"""
|
|
5305
6334
|
return self._RoomId
|
|
5306
6335
|
|
|
5307
6336
|
@RoomId.setter
|
|
@@ -5310,6 +6339,9 @@ class RecordTaskSearchResult(AbstractModel):
|
|
|
5310
6339
|
|
|
5311
6340
|
@property
|
|
5312
6341
|
def CreateTime(self):
|
|
6342
|
+
"""Creation time of the task.
|
|
6343
|
+
:rtype: str
|
|
6344
|
+
"""
|
|
5313
6345
|
return self._CreateTime
|
|
5314
6346
|
|
|
5315
6347
|
@CreateTime.setter
|
|
@@ -5318,6 +6350,9 @@ class RecordTaskSearchResult(AbstractModel):
|
|
|
5318
6350
|
|
|
5319
6351
|
@property
|
|
5320
6352
|
def SdkAppId(self):
|
|
6353
|
+
"""SdkAppId of the whiteboard application.
|
|
6354
|
+
:rtype: int
|
|
6355
|
+
"""
|
|
5321
6356
|
return self._SdkAppId
|
|
5322
6357
|
|
|
5323
6358
|
@SdkAppId.setter
|
|
@@ -5326,6 +6361,9 @@ class RecordTaskSearchResult(AbstractModel):
|
|
|
5326
6361
|
|
|
5327
6362
|
@property
|
|
5328
6363
|
def Result(self):
|
|
6364
|
+
"""Real-time recording result.
|
|
6365
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.RecordTaskResult`
|
|
6366
|
+
"""
|
|
5329
6367
|
return self._Result
|
|
5330
6368
|
|
|
5331
6369
|
@Result.setter
|
|
@@ -5369,6 +6407,9 @@ class ResumeOnlineRecordRequest(AbstractModel):
|
|
|
5369
6407
|
|
|
5370
6408
|
@property
|
|
5371
6409
|
def SdkAppId(self):
|
|
6410
|
+
"""SdkAppId of the customer
|
|
6411
|
+
:rtype: int
|
|
6412
|
+
"""
|
|
5372
6413
|
return self._SdkAppId
|
|
5373
6414
|
|
|
5374
6415
|
@SdkAppId.setter
|
|
@@ -5377,6 +6418,9 @@ class ResumeOnlineRecordRequest(AbstractModel):
|
|
|
5377
6418
|
|
|
5378
6419
|
@property
|
|
5379
6420
|
def TaskId(self):
|
|
6421
|
+
"""ID of the resumed real-time recording task
|
|
6422
|
+
:rtype: str
|
|
6423
|
+
"""
|
|
5380
6424
|
return self._TaskId
|
|
5381
6425
|
|
|
5382
6426
|
@TaskId.setter
|
|
@@ -5411,6 +6455,9 @@ class ResumeOnlineRecordResponse(AbstractModel):
|
|
|
5411
6455
|
|
|
5412
6456
|
@property
|
|
5413
6457
|
def RequestId(self):
|
|
6458
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
6459
|
+
:rtype: str
|
|
6460
|
+
"""
|
|
5414
6461
|
return self._RequestId
|
|
5415
6462
|
|
|
5416
6463
|
@RequestId.setter
|
|
@@ -5445,6 +6492,9 @@ class RoomListItem(AbstractModel):
|
|
|
5445
6492
|
|
|
5446
6493
|
@property
|
|
5447
6494
|
def RoomId(self):
|
|
6495
|
+
"""Room ID.
|
|
6496
|
+
:rtype: str
|
|
6497
|
+
"""
|
|
5448
6498
|
return self._RoomId
|
|
5449
6499
|
|
|
5450
6500
|
@RoomId.setter
|
|
@@ -5453,6 +6503,9 @@ class RoomListItem(AbstractModel):
|
|
|
5453
6503
|
|
|
5454
6504
|
@property
|
|
5455
6505
|
def StartTime(self):
|
|
6506
|
+
"""The first time when the room ID appeared during the queried period, which is a Unix timestamp in milliseconds.
|
|
6507
|
+
:rtype: int
|
|
6508
|
+
"""
|
|
5456
6509
|
return self._StartTime
|
|
5457
6510
|
|
|
5458
6511
|
@StartTime.setter
|
|
@@ -5461,6 +6514,9 @@ class RoomListItem(AbstractModel):
|
|
|
5461
6514
|
|
|
5462
6515
|
@property
|
|
5463
6516
|
def EndTime(self):
|
|
6517
|
+
"""The last time when the room ID appeared during the queried period, which is a Unix timestamp in milliseconds.
|
|
6518
|
+
:rtype: int
|
|
6519
|
+
"""
|
|
5464
6520
|
return self._EndTime
|
|
5465
6521
|
|
|
5466
6522
|
@EndTime.setter
|
|
@@ -5469,6 +6525,9 @@ class RoomListItem(AbstractModel):
|
|
|
5469
6525
|
|
|
5470
6526
|
@property
|
|
5471
6527
|
def UserNumber(self):
|
|
6528
|
+
"""Number of users in the room.
|
|
6529
|
+
:rtype: int
|
|
6530
|
+
"""
|
|
5472
6531
|
return self._UserNumber
|
|
5473
6532
|
|
|
5474
6533
|
@UserNumber.setter
|
|
@@ -5520,6 +6579,9 @@ class RoomUsageDataItem(AbstractModel):
|
|
|
5520
6579
|
|
|
5521
6580
|
@property
|
|
5522
6581
|
def Time(self):
|
|
6582
|
+
"""Start date in the format of YYYY-MM-DD.
|
|
6583
|
+
:rtype: str
|
|
6584
|
+
"""
|
|
5523
6585
|
return self._Time
|
|
5524
6586
|
|
|
5525
6587
|
@Time.setter
|
|
@@ -5528,6 +6590,9 @@ class RoomUsageDataItem(AbstractModel):
|
|
|
5528
6590
|
|
|
5529
6591
|
@property
|
|
5530
6592
|
def SdkAppId(self):
|
|
6593
|
+
"""SdkAppId of the whiteboard application.
|
|
6594
|
+
:rtype: int
|
|
6595
|
+
"""
|
|
5531
6596
|
return self._SdkAppId
|
|
5532
6597
|
|
|
5533
6598
|
@SdkAppId.setter
|
|
@@ -5536,6 +6601,11 @@ class RoomUsageDataItem(AbstractModel):
|
|
|
5536
6601
|
|
|
5537
6602
|
@property
|
|
5538
6603
|
def SubProduct(self):
|
|
6604
|
+
"""Subproduct usage information, which is consistent with the corresponding request parameters.
|
|
6605
|
+
- sp_tiw_board: The duration of use of whiteboards.
|
|
6606
|
+
- sp_tiw_ric: The duration of real-time recording.
|
|
6607
|
+
:rtype: str
|
|
6608
|
+
"""
|
|
5539
6609
|
return self._SubProduct
|
|
5540
6610
|
|
|
5541
6611
|
@SubProduct.setter
|
|
@@ -5544,6 +6614,10 @@ class RoomUsageDataItem(AbstractModel):
|
|
|
5544
6614
|
|
|
5545
6615
|
@property
|
|
5546
6616
|
def Value(self):
|
|
6617
|
+
"""Usage values.
|
|
6618
|
+
- The unit of sp_tiw_board and sp_tiw_ric is minutes.
|
|
6619
|
+
:rtype: float
|
|
6620
|
+
"""
|
|
5547
6621
|
return self._Value
|
|
5548
6622
|
|
|
5549
6623
|
@Value.setter
|
|
@@ -5552,6 +6626,9 @@ class RoomUsageDataItem(AbstractModel):
|
|
|
5552
6626
|
|
|
5553
6627
|
@property
|
|
5554
6628
|
def RoomID(self):
|
|
6629
|
+
"""
|
|
6630
|
+
:rtype: int
|
|
6631
|
+
"""
|
|
5555
6632
|
return self._RoomID
|
|
5556
6633
|
|
|
5557
6634
|
@RoomID.setter
|
|
@@ -5592,6 +6669,9 @@ class SetOnlineRecordCallbackKeyRequest(AbstractModel):
|
|
|
5592
6669
|
|
|
5593
6670
|
@property
|
|
5594
6671
|
def SdkAppId(self):
|
|
6672
|
+
"""SdkAppId of the application
|
|
6673
|
+
:rtype: int
|
|
6674
|
+
"""
|
|
5595
6675
|
return self._SdkAppId
|
|
5596
6676
|
|
|
5597
6677
|
@SdkAppId.setter
|
|
@@ -5600,6 +6680,9 @@ class SetOnlineRecordCallbackKeyRequest(AbstractModel):
|
|
|
5600
6680
|
|
|
5601
6681
|
@property
|
|
5602
6682
|
def CallbackKey(self):
|
|
6683
|
+
"""Authentication key for the real-time recording callback. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key will be deleted. For more information, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
|
|
6684
|
+
:rtype: str
|
|
6685
|
+
"""
|
|
5603
6686
|
return self._CallbackKey
|
|
5604
6687
|
|
|
5605
6688
|
@CallbackKey.setter
|
|
@@ -5634,6 +6717,9 @@ class SetOnlineRecordCallbackKeyResponse(AbstractModel):
|
|
|
5634
6717
|
|
|
5635
6718
|
@property
|
|
5636
6719
|
def RequestId(self):
|
|
6720
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
6721
|
+
:rtype: str
|
|
6722
|
+
"""
|
|
5637
6723
|
return self._RequestId
|
|
5638
6724
|
|
|
5639
6725
|
@RequestId.setter
|
|
@@ -5662,6 +6748,9 @@ class SetOnlineRecordCallbackRequest(AbstractModel):
|
|
|
5662
6748
|
|
|
5663
6749
|
@property
|
|
5664
6750
|
def SdkAppId(self):
|
|
6751
|
+
"""SdkAppId of the customer
|
|
6752
|
+
:rtype: int
|
|
6753
|
+
"""
|
|
5665
6754
|
return self._SdkAppId
|
|
5666
6755
|
|
|
5667
6756
|
@SdkAppId.setter
|
|
@@ -5670,6 +6759,9 @@ class SetOnlineRecordCallbackRequest(AbstractModel):
|
|
|
5670
6759
|
|
|
5671
6760
|
@property
|
|
5672
6761
|
def Callback(self):
|
|
6762
|
+
"""Callback address of the real-time recording task result. If an empty string is passed in, the existing callback address will be deleted. The callback address only supports the HTTP or HTTPS protocol, so the callback address must start with `http://` or `https://`. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
|
|
6763
|
+
:rtype: str
|
|
6764
|
+
"""
|
|
5673
6765
|
return self._Callback
|
|
5674
6766
|
|
|
5675
6767
|
@Callback.setter
|
|
@@ -5704,6 +6796,9 @@ class SetOnlineRecordCallbackResponse(AbstractModel):
|
|
|
5704
6796
|
|
|
5705
6797
|
@property
|
|
5706
6798
|
def RequestId(self):
|
|
6799
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
6800
|
+
:rtype: str
|
|
6801
|
+
"""
|
|
5707
6802
|
return self._RequestId
|
|
5708
6803
|
|
|
5709
6804
|
@RequestId.setter
|
|
@@ -5732,6 +6827,9 @@ class SetTranscodeCallbackKeyRequest(AbstractModel):
|
|
|
5732
6827
|
|
|
5733
6828
|
@property
|
|
5734
6829
|
def SdkAppId(self):
|
|
6830
|
+
"""SdkAppId of the application
|
|
6831
|
+
:rtype: int
|
|
6832
|
+
"""
|
|
5735
6833
|
return self._SdkAppId
|
|
5736
6834
|
|
|
5737
6835
|
@SdkAppId.setter
|
|
@@ -5740,6 +6838,9 @@ class SetTranscodeCallbackKeyRequest(AbstractModel):
|
|
|
5740
6838
|
|
|
5741
6839
|
@property
|
|
5742
6840
|
def CallbackKey(self):
|
|
6841
|
+
"""Authentication key for the document transcoding callback. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key will be deleted. For more information about callback authentication, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
|
|
6842
|
+
:rtype: str
|
|
6843
|
+
"""
|
|
5743
6844
|
return self._CallbackKey
|
|
5744
6845
|
|
|
5745
6846
|
@CallbackKey.setter
|
|
@@ -5774,6 +6875,9 @@ class SetTranscodeCallbackKeyResponse(AbstractModel):
|
|
|
5774
6875
|
|
|
5775
6876
|
@property
|
|
5776
6877
|
def RequestId(self):
|
|
6878
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
6879
|
+
:rtype: str
|
|
6880
|
+
"""
|
|
5777
6881
|
return self._RequestId
|
|
5778
6882
|
|
|
5779
6883
|
@RequestId.setter
|
|
@@ -5803,6 +6907,9 @@ For more information about the callback format, please [see here](https://www.te
|
|
|
5803
6907
|
|
|
5804
6908
|
@property
|
|
5805
6909
|
def SdkAppId(self):
|
|
6910
|
+
"""SdkAppId of the customer
|
|
6911
|
+
:rtype: int
|
|
6912
|
+
"""
|
|
5806
6913
|
return self._SdkAppId
|
|
5807
6914
|
|
|
5808
6915
|
@SdkAppId.setter
|
|
@@ -5811,6 +6918,10 @@ For more information about the callback format, please [see here](https://www.te
|
|
|
5811
6918
|
|
|
5812
6919
|
@property
|
|
5813
6920
|
def Callback(self):
|
|
6921
|
+
"""Callback address for the document transcoding progress. If an empty string is passed in, the existing callback address will be deleted. The callback address only supports the HTTP or HTTPS protocol, so the callback address must start with `http://` or `https://`.
|
|
6922
|
+
For more information about the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
|
|
6923
|
+
:rtype: str
|
|
6924
|
+
"""
|
|
5814
6925
|
return self._Callback
|
|
5815
6926
|
|
|
5816
6927
|
@Callback.setter
|
|
@@ -5845,6 +6956,9 @@ class SetTranscodeCallbackResponse(AbstractModel):
|
|
|
5845
6956
|
|
|
5846
6957
|
@property
|
|
5847
6958
|
def RequestId(self):
|
|
6959
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
6960
|
+
:rtype: str
|
|
6961
|
+
"""
|
|
5848
6962
|
return self._RequestId
|
|
5849
6963
|
|
|
5850
6964
|
@RequestId.setter
|
|
@@ -5873,6 +6987,9 @@ class SetVideoGenerationTaskCallbackKeyRequest(AbstractModel):
|
|
|
5873
6987
|
|
|
5874
6988
|
@property
|
|
5875
6989
|
def SdkAppId(self):
|
|
6990
|
+
"""SdkAppId of the whiteboard application.
|
|
6991
|
+
:rtype: int
|
|
6992
|
+
"""
|
|
5876
6993
|
return self._SdkAppId
|
|
5877
6994
|
|
|
5878
6995
|
@SdkAppId.setter
|
|
@@ -5881,6 +6998,9 @@ class SetVideoGenerationTaskCallbackKeyRequest(AbstractModel):
|
|
|
5881
6998
|
|
|
5882
6999
|
@property
|
|
5883
7000
|
def CallbackKey(self):
|
|
7001
|
+
"""Callback authentication key for recording video generation. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key is deleted.
|
|
7002
|
+
:rtype: str
|
|
7003
|
+
"""
|
|
5884
7004
|
return self._CallbackKey
|
|
5885
7005
|
|
|
5886
7006
|
@CallbackKey.setter
|
|
@@ -5915,6 +7035,9 @@ class SetVideoGenerationTaskCallbackKeyResponse(AbstractModel):
|
|
|
5915
7035
|
|
|
5916
7036
|
@property
|
|
5917
7037
|
def RequestId(self):
|
|
7038
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
7039
|
+
:rtype: str
|
|
7040
|
+
"""
|
|
5918
7041
|
return self._RequestId
|
|
5919
7042
|
|
|
5920
7043
|
@RequestId.setter
|
|
@@ -5943,6 +7066,9 @@ class SetVideoGenerationTaskCallbackRequest(AbstractModel):
|
|
|
5943
7066
|
|
|
5944
7067
|
@property
|
|
5945
7068
|
def SdkAppId(self):
|
|
7069
|
+
"""SdkAppId of the whiteboard application.
|
|
7070
|
+
:rtype: int
|
|
7071
|
+
"""
|
|
5946
7072
|
return self._SdkAppId
|
|
5947
7073
|
|
|
5948
7074
|
@SdkAppId.setter
|
|
@@ -5951,6 +7077,9 @@ class SetVideoGenerationTaskCallbackRequest(AbstractModel):
|
|
|
5951
7077
|
|
|
5952
7078
|
@property
|
|
5953
7079
|
def Callback(self):
|
|
7080
|
+
"""Callback URL of the offline recording task result. If it is specified as null, the set callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with `http://` or `https://`.
|
|
7081
|
+
:rtype: str
|
|
7082
|
+
"""
|
|
5954
7083
|
return self._Callback
|
|
5955
7084
|
|
|
5956
7085
|
@Callback.setter
|
|
@@ -5985,6 +7114,9 @@ class SetVideoGenerationTaskCallbackResponse(AbstractModel):
|
|
|
5985
7114
|
|
|
5986
7115
|
@property
|
|
5987
7116
|
def RequestId(self):
|
|
7117
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
7118
|
+
:rtype: str
|
|
7119
|
+
"""
|
|
5988
7120
|
return self._RequestId
|
|
5989
7121
|
|
|
5990
7122
|
@RequestId.setter
|
|
@@ -6013,6 +7145,9 @@ class SetWhiteboardPushCallbackKeyRequest(AbstractModel):
|
|
|
6013
7145
|
|
|
6014
7146
|
@property
|
|
6015
7147
|
def SdkAppId(self):
|
|
7148
|
+
"""SdkAppId of the whiteboard application.
|
|
7149
|
+
:rtype: int
|
|
7150
|
+
"""
|
|
6016
7151
|
return self._SdkAppId
|
|
6017
7152
|
|
|
6018
7153
|
@SdkAppId.setter
|
|
@@ -6021,6 +7156,9 @@ class SetWhiteboardPushCallbackKeyRequest(AbstractModel):
|
|
|
6021
7156
|
|
|
6022
7157
|
@property
|
|
6023
7158
|
def CallbackKey(self):
|
|
7159
|
+
"""Callback authentication key for whiteboard push. It is a string that can have up to 64 characters. If an empty string is passed in, the existing callback authentication key is deleted. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
|
|
7160
|
+
:rtype: str
|
|
7161
|
+
"""
|
|
6024
7162
|
return self._CallbackKey
|
|
6025
7163
|
|
|
6026
7164
|
@CallbackKey.setter
|
|
@@ -6055,6 +7193,9 @@ class SetWhiteboardPushCallbackKeyResponse(AbstractModel):
|
|
|
6055
7193
|
|
|
6056
7194
|
@property
|
|
6057
7195
|
def RequestId(self):
|
|
7196
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
7197
|
+
:rtype: str
|
|
7198
|
+
"""
|
|
6058
7199
|
return self._RequestId
|
|
6059
7200
|
|
|
6060
7201
|
@RequestId.setter
|
|
@@ -6083,6 +7224,9 @@ class SetWhiteboardPushCallbackRequest(AbstractModel):
|
|
|
6083
7224
|
|
|
6084
7225
|
@property
|
|
6085
7226
|
def SdkAppId(self):
|
|
7227
|
+
"""SdkAppId of the whiteboard application.
|
|
7228
|
+
:rtype: int
|
|
7229
|
+
"""
|
|
6086
7230
|
return self._SdkAppId
|
|
6087
7231
|
|
|
6088
7232
|
@SdkAppId.setter
|
|
@@ -6091,6 +7235,9 @@ class SetWhiteboardPushCallbackRequest(AbstractModel):
|
|
|
6091
7235
|
|
|
6092
7236
|
@property
|
|
6093
7237
|
def Callback(self):
|
|
7238
|
+
"""Callback URL of the whiteboard push task result. If an empty string is passed in, the existing callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with `http://` or `https://`. For the callback format, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
|
|
7239
|
+
:rtype: str
|
|
7240
|
+
"""
|
|
6094
7241
|
return self._Callback
|
|
6095
7242
|
|
|
6096
7243
|
@Callback.setter
|
|
@@ -6125,6 +7272,9 @@ class SetWhiteboardPushCallbackResponse(AbstractModel):
|
|
|
6125
7272
|
|
|
6126
7273
|
@property
|
|
6127
7274
|
def RequestId(self):
|
|
7275
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
7276
|
+
:rtype: str
|
|
7277
|
+
"""
|
|
6128
7278
|
return self._RequestId
|
|
6129
7279
|
|
|
6130
7280
|
@RequestId.setter
|
|
@@ -6162,6 +7312,9 @@ class SnapshotCOS(AbstractModel):
|
|
|
6162
7312
|
|
|
6163
7313
|
@property
|
|
6164
7314
|
def Uin(self):
|
|
7315
|
+
"""UIN of the Tencent Cloud account.
|
|
7316
|
+
:rtype: int
|
|
7317
|
+
"""
|
|
6165
7318
|
return self._Uin
|
|
6166
7319
|
|
|
6167
7320
|
@Uin.setter
|
|
@@ -6170,6 +7323,9 @@ class SnapshotCOS(AbstractModel):
|
|
|
6170
7323
|
|
|
6171
7324
|
@property
|
|
6172
7325
|
def Region(self):
|
|
7326
|
+
"""COS region.
|
|
7327
|
+
:rtype: str
|
|
7328
|
+
"""
|
|
6173
7329
|
return self._Region
|
|
6174
7330
|
|
|
6175
7331
|
@Region.setter
|
|
@@ -6178,6 +7334,9 @@ class SnapshotCOS(AbstractModel):
|
|
|
6178
7334
|
|
|
6179
7335
|
@property
|
|
6180
7336
|
def Bucket(self):
|
|
7337
|
+
"""COS bucket name.
|
|
7338
|
+
:rtype: str
|
|
7339
|
+
"""
|
|
6181
7340
|
return self._Bucket
|
|
6182
7341
|
|
|
6183
7342
|
@Bucket.setter
|
|
@@ -6186,6 +7345,9 @@ class SnapshotCOS(AbstractModel):
|
|
|
6186
7345
|
|
|
6187
7346
|
@property
|
|
6188
7347
|
def TargetDir(self):
|
|
7348
|
+
"""Root directory for storing whiteboard snapshots.
|
|
7349
|
+
:rtype: str
|
|
7350
|
+
"""
|
|
6189
7351
|
return self._TargetDir
|
|
6190
7352
|
|
|
6191
7353
|
@TargetDir.setter
|
|
@@ -6194,6 +7356,9 @@ class SnapshotCOS(AbstractModel):
|
|
|
6194
7356
|
|
|
6195
7357
|
@property
|
|
6196
7358
|
def Domain(self):
|
|
7359
|
+
"""CDN acceleration domain name.
|
|
7360
|
+
:rtype: str
|
|
7361
|
+
"""
|
|
6197
7362
|
return self._Domain
|
|
6198
7363
|
|
|
6199
7364
|
@Domain.setter
|
|
@@ -6244,6 +7409,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
6244
7409
|
|
|
6245
7410
|
@property
|
|
6246
7411
|
def ErrorCode(self):
|
|
7412
|
+
"""Task execution error code.
|
|
7413
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
7414
|
+
:rtype: str
|
|
7415
|
+
"""
|
|
6247
7416
|
return self._ErrorCode
|
|
6248
7417
|
|
|
6249
7418
|
@ErrorCode.setter
|
|
@@ -6252,6 +7421,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
6252
7421
|
|
|
6253
7422
|
@property
|
|
6254
7423
|
def ErrorMessage(self):
|
|
7424
|
+
"""Task execution error message.
|
|
7425
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
7426
|
+
:rtype: str
|
|
7427
|
+
"""
|
|
6255
7428
|
return self._ErrorMessage
|
|
6256
7429
|
|
|
6257
7430
|
@ErrorMessage.setter
|
|
@@ -6260,6 +7433,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
6260
7433
|
|
|
6261
7434
|
@property
|
|
6262
7435
|
def Total(self):
|
|
7436
|
+
"""Number of generated snapshot images.
|
|
7437
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
7438
|
+
:rtype: int
|
|
7439
|
+
"""
|
|
6263
7440
|
return self._Total
|
|
6264
7441
|
|
|
6265
7442
|
@Total.setter
|
|
@@ -6268,6 +7445,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
6268
7445
|
|
|
6269
7446
|
@property
|
|
6270
7447
|
def Snapshots(self):
|
|
7448
|
+
"""List of URLs of the snapshot images.
|
|
7449
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
7450
|
+
:rtype: list of str
|
|
7451
|
+
"""
|
|
6271
7452
|
return self._Snapshots
|
|
6272
7453
|
|
|
6273
7454
|
@Snapshots.setter
|
|
@@ -6310,6 +7491,9 @@ class SnapshotWhiteboard(AbstractModel):
|
|
|
6310
7491
|
|
|
6311
7492
|
@property
|
|
6312
7493
|
def Width(self):
|
|
7494
|
+
"""Whiteboard width. Valid range: [0,2560]. Default value: 1280.
|
|
7495
|
+
:rtype: int
|
|
7496
|
+
"""
|
|
6313
7497
|
return self._Width
|
|
6314
7498
|
|
|
6315
7499
|
@Width.setter
|
|
@@ -6318,6 +7502,9 @@ class SnapshotWhiteboard(AbstractModel):
|
|
|
6318
7502
|
|
|
6319
7503
|
@property
|
|
6320
7504
|
def Height(self):
|
|
7505
|
+
"""Whiteboard height. Valid range: [0,2560]. Default value: 720.
|
|
7506
|
+
:rtype: int
|
|
7507
|
+
"""
|
|
6321
7508
|
return self._Height
|
|
6322
7509
|
|
|
6323
7510
|
@Height.setter
|
|
@@ -6326,6 +7513,9 @@ class SnapshotWhiteboard(AbstractModel):
|
|
|
6326
7513
|
|
|
6327
7514
|
@property
|
|
6328
7515
|
def InitParams(self):
|
|
7516
|
+
"""Escaped JSON string of the whiteboard initial parameters, which is passed through to the Tencent Interactive Whiteboard SDK.
|
|
7517
|
+
:rtype: str
|
|
7518
|
+
"""
|
|
6329
7519
|
return self._InitParams
|
|
6330
7520
|
|
|
6331
7521
|
@InitParams.setter
|
|
@@ -6411,6 +7601,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6411
7601
|
|
|
6412
7602
|
@property
|
|
6413
7603
|
def SdkAppId(self):
|
|
7604
|
+
"""SdkAppId of the customer
|
|
7605
|
+
:rtype: int
|
|
7606
|
+
"""
|
|
6414
7607
|
return self._SdkAppId
|
|
6415
7608
|
|
|
6416
7609
|
@SdkAppId.setter
|
|
@@ -6419,6 +7612,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6419
7612
|
|
|
6420
7613
|
@property
|
|
6421
7614
|
def RoomId(self):
|
|
7615
|
+
"""ID of the room for recording. Value range: (1, 4294967295)
|
|
7616
|
+
:rtype: int
|
|
7617
|
+
"""
|
|
6422
7618
|
return self._RoomId
|
|
6423
7619
|
|
|
6424
7620
|
@RoomId.setter
|
|
@@ -6427,6 +7623,10 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6427
7623
|
|
|
6428
7624
|
@property
|
|
6429
7625
|
def RecordUserId(self):
|
|
7626
|
+
"""User ID used by the recording service for entering a room. The ID cannot exceed 60 bytes in length. Its format is `tic_record_user_${RoomId}_${Random}`, where `${RoomId}` indicates the ID of the room for recording and `${Random}` is a random string.
|
|
7627
|
+
The ID must be an unused ID in the SDK. The recording service uses the user ID to enter the room for audio, video, and whiteboard recording. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the recording operation.
|
|
7628
|
+
:rtype: str
|
|
7629
|
+
"""
|
|
6430
7630
|
return self._RecordUserId
|
|
6431
7631
|
|
|
6432
7632
|
@RecordUserId.setter
|
|
@@ -6435,6 +7635,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6435
7635
|
|
|
6436
7636
|
@property
|
|
6437
7637
|
def RecordUserSig(self):
|
|
7638
|
+
"""Signature corresponding to RecordUserId
|
|
7639
|
+
:rtype: str
|
|
7640
|
+
"""
|
|
6438
7641
|
return self._RecordUserSig
|
|
6439
7642
|
|
|
6440
7643
|
@RecordUserSig.setter
|
|
@@ -6443,6 +7646,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6443
7646
|
|
|
6444
7647
|
@property
|
|
6445
7648
|
def GroupId(self):
|
|
7649
|
+
"""(Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.
|
|
7650
|
+
:rtype: str
|
|
7651
|
+
"""
|
|
6446
7652
|
return self._GroupId
|
|
6447
7653
|
|
|
6448
7654
|
@GroupId.setter
|
|
@@ -6451,6 +7657,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6451
7657
|
|
|
6452
7658
|
@property
|
|
6453
7659
|
def Concat(self):
|
|
7660
|
+
"""Real-time recording video splicing parameter
|
|
7661
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.Concat`
|
|
7662
|
+
"""
|
|
6454
7663
|
return self._Concat
|
|
6455
7664
|
|
|
6456
7665
|
@Concat.setter
|
|
@@ -6459,6 +7668,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6459
7668
|
|
|
6460
7669
|
@property
|
|
6461
7670
|
def Whiteboard(self):
|
|
7671
|
+
"""Real-time recording whiteboard parameter, such as the whiteboard width and height
|
|
7672
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.Whiteboard`
|
|
7673
|
+
"""
|
|
6462
7674
|
return self._Whiteboard
|
|
6463
7675
|
|
|
6464
7676
|
@Whiteboard.setter
|
|
@@ -6467,6 +7679,12 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6467
7679
|
|
|
6468
7680
|
@property
|
|
6469
7681
|
def MixStream(self):
|
|
7682
|
+
"""Real-time recording stream mixing parameter
|
|
7683
|
+
Notes:
|
|
7684
|
+
1. The stream mixing feature needs to be enabled separately. If you need the feature, contact TIW customer service.
|
|
7685
|
+
2. To use the stream mixing feature, the Extras parameter is required and must contain "MIX_STREAM".
|
|
7686
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.MixStream`
|
|
7687
|
+
"""
|
|
6470
7688
|
return self._MixStream
|
|
6471
7689
|
|
|
6472
7690
|
@MixStream.setter
|
|
@@ -6475,6 +7693,11 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6475
7693
|
|
|
6476
7694
|
@property
|
|
6477
7695
|
def Extras(self):
|
|
7696
|
+
"""List of advanced features used
|
|
7697
|
+
List of possible values:
|
|
7698
|
+
MIX_STREAM - Stream mixing feature
|
|
7699
|
+
:rtype: list of str
|
|
7700
|
+
"""
|
|
6478
7701
|
return self._Extras
|
|
6479
7702
|
|
|
6480
7703
|
@Extras.setter
|
|
@@ -6483,6 +7706,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6483
7706
|
|
|
6484
7707
|
@property
|
|
6485
7708
|
def AudioFileNeeded(self):
|
|
7709
|
+
"""Whether to return the audio-only recording file of different streams in the result callback. The file format is mp3.
|
|
7710
|
+
:rtype: bool
|
|
7711
|
+
"""
|
|
6486
7712
|
return self._AudioFileNeeded
|
|
6487
7713
|
|
|
6488
7714
|
@AudioFileNeeded.setter
|
|
@@ -6491,6 +7717,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6491
7717
|
|
|
6492
7718
|
@property
|
|
6493
7719
|
def RecordControl(self):
|
|
7720
|
+
"""A group of real-time recording parameters. It specifies the streams to be recorded, whether to disable the audio recording, and whether to record only low-resolution videos, etc.
|
|
7721
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.RecordControl`
|
|
7722
|
+
"""
|
|
6494
7723
|
return self._RecordControl
|
|
6495
7724
|
|
|
6496
7725
|
@RecordControl.setter
|
|
@@ -6499,6 +7728,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6499
7728
|
|
|
6500
7729
|
@property
|
|
6501
7730
|
def RecordMode(self):
|
|
7731
|
+
"""
|
|
7732
|
+
:rtype: str
|
|
7733
|
+
"""
|
|
6502
7734
|
return self._RecordMode
|
|
6503
7735
|
|
|
6504
7736
|
@RecordMode.setter
|
|
@@ -6507,6 +7739,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6507
7739
|
|
|
6508
7740
|
@property
|
|
6509
7741
|
def ChatGroupId(self):
|
|
7742
|
+
"""
|
|
7743
|
+
:rtype: str
|
|
7744
|
+
"""
|
|
6510
7745
|
return self._ChatGroupId
|
|
6511
7746
|
|
|
6512
7747
|
@ChatGroupId.setter
|
|
@@ -6515,6 +7750,11 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6515
7750
|
|
|
6516
7751
|
@property
|
|
6517
7752
|
def AutoStopTimeout(self):
|
|
7753
|
+
"""Recording timeout. Unit: seconds. Valid range: [300,86400]. Default value: 300.
|
|
7754
|
+
|
|
7755
|
+
If no upstream audio/video exists or no operation is performed on the whiteboard for the specified period of time, the recording service automatically stops the recording task.
|
|
7756
|
+
:rtype: int
|
|
7757
|
+
"""
|
|
6518
7758
|
return self._AutoStopTimeout
|
|
6519
7759
|
|
|
6520
7760
|
@AutoStopTimeout.setter
|
|
@@ -6523,6 +7763,9 @@ If no upstream audio/video exists or no operation is performed on the whiteboard
|
|
|
6523
7763
|
|
|
6524
7764
|
@property
|
|
6525
7765
|
def ExtraData(self):
|
|
7766
|
+
"""Internal parameter. You can ignore this parameter.
|
|
7767
|
+
:rtype: str
|
|
7768
|
+
"""
|
|
6526
7769
|
return self._ExtraData
|
|
6527
7770
|
|
|
6528
7771
|
@ExtraData.setter
|
|
@@ -6581,6 +7824,9 @@ class StartOnlineRecordResponse(AbstractModel):
|
|
|
6581
7824
|
|
|
6582
7825
|
@property
|
|
6583
7826
|
def TaskId(self):
|
|
7827
|
+
"""ID of the real-time recording task
|
|
7828
|
+
:rtype: str
|
|
7829
|
+
"""
|
|
6584
7830
|
return self._TaskId
|
|
6585
7831
|
|
|
6586
7832
|
@TaskId.setter
|
|
@@ -6589,6 +7835,9 @@ class StartOnlineRecordResponse(AbstractModel):
|
|
|
6589
7835
|
|
|
6590
7836
|
@property
|
|
6591
7837
|
def RequestId(self):
|
|
7838
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
7839
|
+
:rtype: str
|
|
7840
|
+
"""
|
|
6592
7841
|
return self._RequestId
|
|
6593
7842
|
|
|
6594
7843
|
@RequestId.setter
|
|
@@ -6732,6 +7981,9 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6732
7981
|
|
|
6733
7982
|
@property
|
|
6734
7983
|
def SdkAppId(self):
|
|
7984
|
+
"""SdkAppId of the whiteboard application.
|
|
7985
|
+
:rtype: int
|
|
7986
|
+
"""
|
|
6735
7987
|
return self._SdkAppId
|
|
6736
7988
|
|
|
6737
7989
|
@SdkAppId.setter
|
|
@@ -6740,6 +7992,12 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6740
7992
|
|
|
6741
7993
|
@property
|
|
6742
7994
|
def RoomId(self):
|
|
7995
|
+
"""Room ID of the whiteboard push task. Valid range: (1,4294967295).
|
|
7996
|
+
|
|
7997
|
+
1. By default, the whiteboard push task uses the RoomId string as the GroupID of the IM group. For example, if the RoomId string is 1234, the GroupID of the IM group is also 1234. Message synchronization requires joining a group. Make sure that an IM group is created before the push starts. Otherwise, the push fails.
|
|
7998
|
+
2. If neither TRTCRoomId nor TRTCRoomIdStr is specified, the value of RoomId is used as the Tencent Real-Time Communication (TRTC) room ID for the whiteboard push task.
|
|
7999
|
+
:rtype: int
|
|
8000
|
+
"""
|
|
6743
8001
|
return self._RoomId
|
|
6744
8002
|
|
|
6745
8003
|
@RoomId.setter
|
|
@@ -6748,6 +8006,10 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6748
8006
|
|
|
6749
8007
|
@property
|
|
6750
8008
|
def PushUserId(self):
|
|
8009
|
+
"""User ID used by the whiteboard push service for entering the whiteboard room. If `IMAuthParam`and `TRTCAuthParam` are not specified, this user ID is used for operations such as logging in to the IM application, joining an IM group, and entering the room for TRTC whiteboard push.
|
|
8010
|
+
The ID cannot exceed 60 bytes in length and must be an unused ID. The whiteboard push service uses the user ID to enter the room for whiteboard audio/video push. If this ID is already used in another scenario, the other scenario and whiteboard push service will conflict, affecting the pushing operation.
|
|
8011
|
+
:rtype: str
|
|
8012
|
+
"""
|
|
6751
8013
|
return self._PushUserId
|
|
6752
8014
|
|
|
6753
8015
|
@PushUserId.setter
|
|
@@ -6756,6 +8018,9 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6756
8018
|
|
|
6757
8019
|
@property
|
|
6758
8020
|
def PushUserSig(self):
|
|
8021
|
+
"""User's IM signature corresponding to the PushUserId.
|
|
8022
|
+
:rtype: str
|
|
8023
|
+
"""
|
|
6759
8024
|
return self._PushUserSig
|
|
6760
8025
|
|
|
6761
8026
|
@PushUserSig.setter
|
|
@@ -6764,6 +8029,9 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6764
8029
|
|
|
6765
8030
|
@property
|
|
6766
8031
|
def Whiteboard(self):
|
|
8032
|
+
"""Whiteboard parameters, such as the width, height, and background color of the whiteboard.
|
|
8033
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.Whiteboard`
|
|
8034
|
+
"""
|
|
6767
8035
|
return self._Whiteboard
|
|
6768
8036
|
|
|
6769
8037
|
@Whiteboard.setter
|
|
@@ -6772,6 +8040,11 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6772
8040
|
|
|
6773
8041
|
@property
|
|
6774
8042
|
def AutoStopTimeout(self):
|
|
8043
|
+
"""Whiteboard push timeout. Unit: seconds. Valid range: [300,259200]. Default value: 1800.
|
|
8044
|
+
|
|
8045
|
+
If no operation is performed on the whiteboard for the specified period of time, the whiteboard push service automatically stops whiteboard push.
|
|
8046
|
+
:rtype: int
|
|
8047
|
+
"""
|
|
6775
8048
|
return self._AutoStopTimeout
|
|
6776
8049
|
|
|
6777
8050
|
@AutoStopTimeout.setter
|
|
@@ -6780,6 +8053,9 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6780
8053
|
|
|
6781
8054
|
@property
|
|
6782
8055
|
def AutoManageBackup(self):
|
|
8056
|
+
"""Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.
|
|
8057
|
+
:rtype: bool
|
|
8058
|
+
"""
|
|
6783
8059
|
return self._AutoManageBackup
|
|
6784
8060
|
|
|
6785
8061
|
@AutoManageBackup.setter
|
|
@@ -6788,6 +8064,11 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6788
8064
|
|
|
6789
8065
|
@property
|
|
6790
8066
|
def Backup(self):
|
|
8067
|
+
"""Parameters of the backup whiteboard push task.
|
|
8068
|
+
|
|
8069
|
+
After the backup parameters are specified, the whiteboard push service adds a relayed video stream. That is, there are two video streams on the whiteboard in the same room.
|
|
8070
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.WhiteboardPushBackupParam`
|
|
8071
|
+
"""
|
|
6791
8072
|
return self._Backup
|
|
6792
8073
|
|
|
6793
8074
|
@Backup.setter
|
|
@@ -6796,6 +8077,9 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6796
8077
|
|
|
6797
8078
|
@property
|
|
6798
8079
|
def PrivateMapKey(self):
|
|
8080
|
+
"""Advanced permission control parameter in TRTC. If the advanced permission control feature is enabled in TRTC, this parameter is required.
|
|
8081
|
+
:rtype: str
|
|
8082
|
+
"""
|
|
6799
8083
|
return self._PrivateMapKey
|
|
6800
8084
|
|
|
6801
8085
|
@PrivateMapKey.setter
|
|
@@ -6804,6 +8088,9 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6804
8088
|
|
|
6805
8089
|
@property
|
|
6806
8090
|
def VideoFPS(self):
|
|
8091
|
+
"""Frame rate of the whiteboard push video. Valid range: [0,30]. Default value: 20. Unit: fps.
|
|
8092
|
+
:rtype: int
|
|
8093
|
+
"""
|
|
6807
8094
|
return self._VideoFPS
|
|
6808
8095
|
|
|
6809
8096
|
@VideoFPS.setter
|
|
@@ -6812,6 +8099,11 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6812
8099
|
|
|
6813
8100
|
@property
|
|
6814
8101
|
def VideoBitrate(self):
|
|
8102
|
+
"""Whiteboard push bitrate. Valid range: [0,2000]. Default value: 1200. Unit: kbps.
|
|
8103
|
+
|
|
8104
|
+
The bitrate specified here is a reference value. During actual push, a dynamic bitrate is used. The actual bitrate does not remain the specified value but rather fluctuates around it.
|
|
8105
|
+
:rtype: int
|
|
8106
|
+
"""
|
|
6815
8107
|
return self._VideoBitrate
|
|
6816
8108
|
|
|
6817
8109
|
@VideoBitrate.setter
|
|
@@ -6820,6 +8112,13 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6820
8112
|
|
|
6821
8113
|
@property
|
|
6822
8114
|
def AutoRecord(self):
|
|
8115
|
+
"""Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`.
|
|
8116
|
+
|
|
8117
|
+
Default value: `false`. If you need to enable automatic whiteboard push recording, set this parameter to `true`.
|
|
8118
|
+
|
|
8119
|
+
If the recording mode in TRTC is set to `Global Auto Recording`, ignore this parameter.
|
|
8120
|
+
:rtype: bool
|
|
8121
|
+
"""
|
|
6823
8122
|
return self._AutoRecord
|
|
6824
8123
|
|
|
6825
8124
|
@AutoRecord.setter
|
|
@@ -6828,6 +8127,20 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6828
8127
|
|
|
6829
8128
|
@property
|
|
6830
8129
|
def UserDefinedRecordId(self):
|
|
8130
|
+
"""ID of the whiteboard push recording. The ID is filled in the `userdefinerecordid` parameter in the callback message after cloud recording is complete in TRTC, helping you identify the recording callback and locate the video file in VOD media resource management.
|
|
8131
|
+
|
|
8132
|
+
The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-).
|
|
8133
|
+
|
|
8134
|
+
After this parameter is set, automatic whiteboard push recording is enabled regardless of the value of the `AutoRecord` parameter.
|
|
8135
|
+
|
|
8136
|
+
Default RecordId generation rule:
|
|
8137
|
+
urlencode(SdkAppID_RoomID_PushUserID)
|
|
8138
|
+
|
|
8139
|
+
Example:
|
|
8140
|
+
SdkAppID = 12345678,RoomID = 12345,PushUserID = push_user_1
|
|
8141
|
+
Therefore: RecordId = 12345678_12345_push_user_1
|
|
8142
|
+
:rtype: str
|
|
8143
|
+
"""
|
|
6831
8144
|
return self._UserDefinedRecordId
|
|
6832
8145
|
|
|
6833
8146
|
@UserDefinedRecordId.setter
|
|
@@ -6836,6 +8149,13 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6836
8149
|
|
|
6837
8150
|
@property
|
|
6838
8151
|
def AutoPublish(self):
|
|
8152
|
+
"""Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`.
|
|
8153
|
+
|
|
8154
|
+
Default value: `false`. If you need to enable automatic relay whiteboard push, set this parameter to `true`.
|
|
8155
|
+
|
|
8156
|
+
If the recording mode in TRTC is set to `Global Auto Relay`, ignore this parameter.
|
|
8157
|
+
:rtype: bool
|
|
8158
|
+
"""
|
|
6839
8159
|
return self._AutoPublish
|
|
6840
8160
|
|
|
6841
8161
|
@AutoPublish.setter
|
|
@@ -6844,6 +8164,20 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6844
8164
|
|
|
6845
8165
|
@property
|
|
6846
8166
|
def UserDefinedStreamId(self):
|
|
8167
|
+
"""Stream ID used by TRTC for relay whiteboard push. With this ID, you can stream the user’s audio/video by using the domain name and standard streaming solution (FLV or HLS) in TRTC.
|
|
8168
|
+
|
|
8169
|
+
The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-).
|
|
8170
|
+
|
|
8171
|
+
After this parameter is set, automatic relay whiteboard push is enabled regardless of the value of the `AutoPublish` parameter.
|
|
8172
|
+
|
|
8173
|
+
Default StreamID generation rule:
|
|
8174
|
+
urlencode(SdkAppID_RoomID_PushUserID_main)
|
|
8175
|
+
|
|
8176
|
+
Example:
|
|
8177
|
+
SdkAppID = 12345678,RoomID = 12345,PushUserID = push_user_1
|
|
8178
|
+
Therefore, StreamID = 12345678_12345_push_user_1_main
|
|
8179
|
+
:rtype: str
|
|
8180
|
+
"""
|
|
6847
8181
|
return self._UserDefinedStreamId
|
|
6848
8182
|
|
|
6849
8183
|
@UserDefinedStreamId.setter
|
|
@@ -6852,6 +8186,9 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6852
8186
|
|
|
6853
8187
|
@property
|
|
6854
8188
|
def ExtraData(self):
|
|
8189
|
+
"""Internal parameter. You can ignore this parameter.
|
|
8190
|
+
:rtype: str
|
|
8191
|
+
"""
|
|
6855
8192
|
return self._ExtraData
|
|
6856
8193
|
|
|
6857
8194
|
@ExtraData.setter
|
|
@@ -6860,6 +8197,13 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6860
8197
|
|
|
6861
8198
|
@property
|
|
6862
8199
|
def TRTCRoomId(self):
|
|
8200
|
+
"""TRTC room ID of the numeric type. Valid range: (1,4294967295).
|
|
8201
|
+
|
|
8202
|
+
If RoomId and TRTCRoomId are both specified, the value of TRTCRoomId takes priority as the room ID for TRTC whiteboard push.
|
|
8203
|
+
|
|
8204
|
+
If the TRTCRoomIdStr parameter is specified, this parameter is ignored.
|
|
8205
|
+
:rtype: int
|
|
8206
|
+
"""
|
|
6863
8207
|
return self._TRTCRoomId
|
|
6864
8208
|
|
|
6865
8209
|
@TRTCRoomId.setter
|
|
@@ -6868,6 +8212,11 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6868
8212
|
|
|
6869
8213
|
@property
|
|
6870
8214
|
def TRTCRoomIdStr(self):
|
|
8215
|
+
"""TRTC room ID of the string type.
|
|
8216
|
+
|
|
8217
|
+
If TRTCRoomIdStr is specified, its value takes priority as the room ID for TRTC whiteboard push.
|
|
8218
|
+
:rtype: str
|
|
8219
|
+
"""
|
|
6871
8220
|
return self._TRTCRoomIdStr
|
|
6872
8221
|
|
|
6873
8222
|
@TRTCRoomIdStr.setter
|
|
@@ -6876,6 +8225,12 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6876
8225
|
|
|
6877
8226
|
@property
|
|
6878
8227
|
def IMAuthParam(self):
|
|
8228
|
+
"""IM authentication parameters.
|
|
8229
|
+
If the ID of the IM application used by whiteboard messages is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the IM application.
|
|
8230
|
+
|
|
8231
|
+
If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the transmission channel for whiteboard messages. If this parameter is left empty, the SdkAppId value in the common parameters is used.
|
|
8232
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.AuthParam`
|
|
8233
|
+
"""
|
|
6879
8234
|
return self._IMAuthParam
|
|
6880
8235
|
|
|
6881
8236
|
@IMAuthParam.setter
|
|
@@ -6884,6 +8239,12 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6884
8239
|
|
|
6885
8240
|
@property
|
|
6886
8241
|
def TRTCAuthParam(self):
|
|
8242
|
+
"""TRTC authentication parameters, used for room entrance authentication for TRTC push.
|
|
8243
|
+
If the ID of the TRTC application to which the target TRTC room belongs is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the TRTC application.
|
|
8244
|
+
|
|
8245
|
+
If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the ID of the target TRTC application. If this parameter is left empty, the SdkAppId value in the common parameters is used.
|
|
8246
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.AuthParam`
|
|
8247
|
+
"""
|
|
6887
8248
|
return self._TRTCAuthParam
|
|
6888
8249
|
|
|
6889
8250
|
@TRTCAuthParam.setter
|
|
@@ -6892,6 +8253,14 @@ TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCa
|
|
|
6892
8253
|
|
|
6893
8254
|
@property
|
|
6894
8255
|
def TRTCEnterRoomMode(self):
|
|
8256
|
+
"""This parameter is available only to users in the allowlist for trial.
|
|
8257
|
+
|
|
8258
|
+
TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCall`.
|
|
8259
|
+
|
|
8260
|
+
`TRTCAppSceneVideoCall`: This scenario is most suitable when there are two or more people on a video call. The internal encoders and network protocols are optimized for video smoothness to reduce call latency and lagging.
|
|
8261
|
+
`TRTCAppSceneLIVE`: This scenario is most suitable when there is only one person speaking or performing for an online audience, and occasionally multiple people interact with one another through video. The internal encoders and network protocols are optimized for performance and compatibility to deliver better performance and video clarity.
|
|
8262
|
+
:rtype: str
|
|
8263
|
+
"""
|
|
6895
8264
|
return self._TRTCEnterRoomMode
|
|
6896
8265
|
|
|
6897
8266
|
@TRTCEnterRoomMode.setter
|
|
@@ -6960,6 +8329,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
6960
8329
|
|
|
6961
8330
|
@property
|
|
6962
8331
|
def TaskId(self):
|
|
8332
|
+
"""Push task ID.
|
|
8333
|
+
:rtype: str
|
|
8334
|
+
"""
|
|
6963
8335
|
return self._TaskId
|
|
6964
8336
|
|
|
6965
8337
|
@TaskId.setter
|
|
@@ -6968,6 +8340,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
6968
8340
|
|
|
6969
8341
|
@property
|
|
6970
8342
|
def Backup(self):
|
|
8343
|
+
"""Result parameters of the backup task.
|
|
8344
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
8345
|
+
:rtype: str
|
|
8346
|
+
"""
|
|
6971
8347
|
return self._Backup
|
|
6972
8348
|
|
|
6973
8349
|
@Backup.setter
|
|
@@ -6976,6 +8352,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
6976
8352
|
|
|
6977
8353
|
@property
|
|
6978
8354
|
def RequestId(self):
|
|
8355
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
8356
|
+
:rtype: str
|
|
8357
|
+
"""
|
|
6979
8358
|
return self._RequestId
|
|
6980
8359
|
|
|
6981
8360
|
@RequestId.setter
|
|
@@ -7006,6 +8385,9 @@ class StopOnlineRecordRequest(AbstractModel):
|
|
|
7006
8385
|
|
|
7007
8386
|
@property
|
|
7008
8387
|
def SdkAppId(self):
|
|
8388
|
+
"""SdkAppId of the customer
|
|
8389
|
+
:rtype: int
|
|
8390
|
+
"""
|
|
7009
8391
|
return self._SdkAppId
|
|
7010
8392
|
|
|
7011
8393
|
@SdkAppId.setter
|
|
@@ -7014,6 +8396,9 @@ class StopOnlineRecordRequest(AbstractModel):
|
|
|
7014
8396
|
|
|
7015
8397
|
@property
|
|
7016
8398
|
def TaskId(self):
|
|
8399
|
+
"""ID of the recording task to stop
|
|
8400
|
+
:rtype: str
|
|
8401
|
+
"""
|
|
7017
8402
|
return self._TaskId
|
|
7018
8403
|
|
|
7019
8404
|
@TaskId.setter
|
|
@@ -7048,6 +8433,9 @@ class StopOnlineRecordResponse(AbstractModel):
|
|
|
7048
8433
|
|
|
7049
8434
|
@property
|
|
7050
8435
|
def RequestId(self):
|
|
8436
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
8437
|
+
:rtype: str
|
|
8438
|
+
"""
|
|
7051
8439
|
return self._RequestId
|
|
7052
8440
|
|
|
7053
8441
|
@RequestId.setter
|
|
@@ -7076,6 +8464,9 @@ class StopWhiteboardPushRequest(AbstractModel):
|
|
|
7076
8464
|
|
|
7077
8465
|
@property
|
|
7078
8466
|
def SdkAppId(self):
|
|
8467
|
+
"""SdkAppId of the whiteboard application.
|
|
8468
|
+
:rtype: int
|
|
8469
|
+
"""
|
|
7079
8470
|
return self._SdkAppId
|
|
7080
8471
|
|
|
7081
8472
|
@SdkAppId.setter
|
|
@@ -7084,6 +8475,9 @@ class StopWhiteboardPushRequest(AbstractModel):
|
|
|
7084
8475
|
|
|
7085
8476
|
@property
|
|
7086
8477
|
def TaskId(self):
|
|
8478
|
+
"""ID of the whiteboard push task to be stopped.
|
|
8479
|
+
:rtype: str
|
|
8480
|
+
"""
|
|
7087
8481
|
return self._TaskId
|
|
7088
8482
|
|
|
7089
8483
|
@TaskId.setter
|
|
@@ -7122,6 +8516,10 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
7122
8516
|
|
|
7123
8517
|
@property
|
|
7124
8518
|
def Backup(self):
|
|
8519
|
+
"""Parameters of the backup task.
|
|
8520
|
+
Note: This parameter may return null, indicating that no valid values can be obtained.
|
|
8521
|
+
:rtype: str
|
|
8522
|
+
"""
|
|
7125
8523
|
return self._Backup
|
|
7126
8524
|
|
|
7127
8525
|
@Backup.setter
|
|
@@ -7130,6 +8528,9 @@ Note: This parameter may return null, indicating that no valid values can be obt
|
|
|
7130
8528
|
|
|
7131
8529
|
@property
|
|
7132
8530
|
def RequestId(self):
|
|
8531
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
8532
|
+
:rtype: str
|
|
8533
|
+
"""
|
|
7133
8534
|
return self._RequestId
|
|
7134
8535
|
|
|
7135
8536
|
@RequestId.setter
|
|
@@ -7186,6 +8587,15 @@ Default value: false
|
|
|
7186
8587
|
|
|
7187
8588
|
@property
|
|
7188
8589
|
def StreamId(self):
|
|
8590
|
+
"""Video stream ID
|
|
8591
|
+
Description of the possible video stream ID values:
|
|
8592
|
+
1. `tic_record_user`: the whiteboard video stream
|
|
8593
|
+
2. `tic_substream`: the auxiliary video stream
|
|
8594
|
+
3. Specific user ID: the video stream of the specified user
|
|
8595
|
+
|
|
8596
|
+
The actual recording uses the prefix match of the video stream ID. The real stream becomes the specified stream once its ID prefix matches with the stream ID.
|
|
8597
|
+
:rtype: str
|
|
8598
|
+
"""
|
|
7189
8599
|
return self._StreamId
|
|
7190
8600
|
|
|
7191
8601
|
@StreamId.setter
|
|
@@ -7194,6 +8604,14 @@ Default value: false
|
|
|
7194
8604
|
|
|
7195
8605
|
@property
|
|
7196
8606
|
def DisableRecord(self):
|
|
8607
|
+
"""Whether to disable recording over the stream.
|
|
8608
|
+
|
|
8609
|
+
true: does not record this stream. This stream will not be included in the final recording file.
|
|
8610
|
+
false: records this stream. This stream will be included in the final recording file.
|
|
8611
|
+
|
|
8612
|
+
Default value: false
|
|
8613
|
+
:rtype: bool
|
|
8614
|
+
"""
|
|
7197
8615
|
return self._DisableRecord
|
|
7198
8616
|
|
|
7199
8617
|
@DisableRecord.setter
|
|
@@ -7202,6 +8620,14 @@ Default value: false
|
|
|
7202
8620
|
|
|
7203
8621
|
@property
|
|
7204
8622
|
def DisableAudio(self):
|
|
8623
|
+
"""Whether to disable the audio recording of the stream.
|
|
8624
|
+
|
|
8625
|
+
true: does not record the audio of the stream. In the final recording file, this stream will be soundless.
|
|
8626
|
+
false: the stream has both video and audio recording.
|
|
8627
|
+
|
|
8628
|
+
Default value: false
|
|
8629
|
+
:rtype: bool
|
|
8630
|
+
"""
|
|
7205
8631
|
return self._DisableAudio
|
|
7206
8632
|
|
|
7207
8633
|
@DisableAudio.setter
|
|
@@ -7210,6 +8636,14 @@ Default value: false
|
|
|
7210
8636
|
|
|
7211
8637
|
@property
|
|
7212
8638
|
def PullSmallVideo(self):
|
|
8639
|
+
"""Whether to only record low-resolution stream videos.
|
|
8640
|
+
|
|
8641
|
+
true: records only low-resolution videos. In this case, please make sure that the client pushes low-resolution videos upstream. Otherwise, the recorded video may be black.
|
|
8642
|
+
false: records only high-resolution videos.
|
|
8643
|
+
|
|
8644
|
+
Default value: false
|
|
8645
|
+
:rtype: bool
|
|
8646
|
+
"""
|
|
7213
8647
|
return self._PullSmallVideo
|
|
7214
8648
|
|
|
7215
8649
|
@PullSmallVideo.setter
|
|
@@ -7263,6 +8697,9 @@ Description of the possible video stream ID values:
|
|
|
7263
8697
|
|
|
7264
8698
|
@property
|
|
7265
8699
|
def LayoutParams(self):
|
|
8700
|
+
"""Stream layout configuration
|
|
8701
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.LayoutParams`
|
|
8702
|
+
"""
|
|
7266
8703
|
return self._LayoutParams
|
|
7267
8704
|
|
|
7268
8705
|
@LayoutParams.setter
|
|
@@ -7271,6 +8708,14 @@ Description of the possible video stream ID values:
|
|
|
7271
8708
|
|
|
7272
8709
|
@property
|
|
7273
8710
|
def InputStreamId(self):
|
|
8711
|
+
"""Video stream ID
|
|
8712
|
+
Description of the possible video stream ID values:
|
|
8713
|
+
1. tic_record_user: the current picture is used to display the whiteboard video stream.
|
|
8714
|
+
2. tic_substream: the current picture is used to display the auxiliary video stream.
|
|
8715
|
+
3. Specific user ID: the current picture is used to display the video stream of a specific user.
|
|
8716
|
+
4.Left empty: the current picture is vacant for new video stream.
|
|
8717
|
+
:rtype: str
|
|
8718
|
+
"""
|
|
7274
8719
|
return self._InputStreamId
|
|
7275
8720
|
|
|
7276
8721
|
@InputStreamId.setter
|
|
@@ -7279,6 +8724,9 @@ Description of the possible video stream ID values:
|
|
|
7279
8724
|
|
|
7280
8725
|
@property
|
|
7281
8726
|
def BackgroundColor(self):
|
|
8727
|
+
"""Background color in RGB format, such as "#FF0000" for red. The default color is black.
|
|
8728
|
+
:rtype: str
|
|
8729
|
+
"""
|
|
7282
8730
|
return self._BackgroundColor
|
|
7283
8731
|
|
|
7284
8732
|
@BackgroundColor.setter
|
|
@@ -7287,6 +8735,12 @@ Description of the possible video stream ID values:
|
|
|
7287
8735
|
|
|
7288
8736
|
@property
|
|
7289
8737
|
def FillMode(self):
|
|
8738
|
+
"""Video filling mode.
|
|
8739
|
+
|
|
8740
|
+
0: self-adaption mode. Scales the video proportionally to completely display it in the specified area. In this mode, there may be black bars.
|
|
8741
|
+
1: full-screen mode. Scales the video to make it fill the entire specified area. In this mode, no black bars will appear, but the video may not be displayed fully.
|
|
8742
|
+
:rtype: int
|
|
8743
|
+
"""
|
|
7290
8744
|
return self._FillMode
|
|
7291
8745
|
|
|
7292
8746
|
@FillMode.setter
|
|
@@ -7328,6 +8782,9 @@ class Tag(AbstractModel):
|
|
|
7328
8782
|
|
|
7329
8783
|
@property
|
|
7330
8784
|
def TagKey(self):
|
|
8785
|
+
"""Tag key.
|
|
8786
|
+
:rtype: str
|
|
8787
|
+
"""
|
|
7331
8788
|
return self._TagKey
|
|
7332
8789
|
|
|
7333
8790
|
@TagKey.setter
|
|
@@ -7336,6 +8793,9 @@ class Tag(AbstractModel):
|
|
|
7336
8793
|
|
|
7337
8794
|
@property
|
|
7338
8795
|
def TagValue(self):
|
|
8796
|
+
"""Tag value.
|
|
8797
|
+
:rtype: str
|
|
8798
|
+
"""
|
|
7339
8799
|
return self._TagValue
|
|
7340
8800
|
|
|
7341
8801
|
@TagValue.setter
|
|
@@ -7373,6 +8833,9 @@ class TimeValue(AbstractModel):
|
|
|
7373
8833
|
|
|
7374
8834
|
@property
|
|
7375
8835
|
def Time(self):
|
|
8836
|
+
"""Unix timestamp in seconds.
|
|
8837
|
+
:rtype: int
|
|
8838
|
+
"""
|
|
7376
8839
|
return self._Time
|
|
7377
8840
|
|
|
7378
8841
|
@Time.setter
|
|
@@ -7381,6 +8844,9 @@ class TimeValue(AbstractModel):
|
|
|
7381
8844
|
|
|
7382
8845
|
@property
|
|
7383
8846
|
def Value(self):
|
|
8847
|
+
"""Current value of the queried metric.
|
|
8848
|
+
:rtype: float
|
|
8849
|
+
"""
|
|
7384
8850
|
return self._Value
|
|
7385
8851
|
|
|
7386
8852
|
@Value.setter
|
|
@@ -7442,6 +8908,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7442
8908
|
|
|
7443
8909
|
@property
|
|
7444
8910
|
def ResultUrl(self):
|
|
8911
|
+
"""Transcoding result URL.
|
|
8912
|
+
:rtype: str
|
|
8913
|
+
"""
|
|
7445
8914
|
return self._ResultUrl
|
|
7446
8915
|
|
|
7447
8916
|
@ResultUrl.setter
|
|
@@ -7450,6 +8919,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7450
8919
|
|
|
7451
8920
|
@property
|
|
7452
8921
|
def Resolution(self):
|
|
8922
|
+
"""Target resolution.
|
|
8923
|
+
:rtype: str
|
|
8924
|
+
"""
|
|
7453
8925
|
return self._Resolution
|
|
7454
8926
|
|
|
7455
8927
|
@Resolution.setter
|
|
@@ -7458,6 +8930,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7458
8930
|
|
|
7459
8931
|
@property
|
|
7460
8932
|
def Title(self):
|
|
8933
|
+
"""Title (usually the document name).
|
|
8934
|
+
:rtype: str
|
|
8935
|
+
"""
|
|
7461
8936
|
return self._Title
|
|
7462
8937
|
|
|
7463
8938
|
@Title.setter
|
|
@@ -7466,6 +8941,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7466
8941
|
|
|
7467
8942
|
@property
|
|
7468
8943
|
def Pages(self):
|
|
8944
|
+
"""Number of transcoded pages.
|
|
8945
|
+
:rtype: int
|
|
8946
|
+
"""
|
|
7469
8947
|
return self._Pages
|
|
7470
8948
|
|
|
7471
8949
|
@Pages.setter
|
|
@@ -7474,6 +8952,12 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7474
8952
|
|
|
7475
8953
|
@property
|
|
7476
8954
|
def ThumbnailUrl(self):
|
|
8955
|
+
"""URL prefix of the thumbnail. If the URL prefix is `http://example.com/g0jb42ps49vtebjshilb/`, the thumbnail URL for the first page of the dynamically transcoded PowerPoint file is
|
|
8956
|
+
`http://example.com/g0jb42ps49vtebjshilb/1.jpg`, and so on.
|
|
8957
|
+
|
|
8958
|
+
If the document transcoding request carries the ThumbnailResolution parameter and the transcoding type is dynamic transcoding, this parameter is not null. In other cases, this parameter is null.
|
|
8959
|
+
:rtype: str
|
|
8960
|
+
"""
|
|
7477
8961
|
return self._ThumbnailUrl
|
|
7478
8962
|
|
|
7479
8963
|
@ThumbnailUrl.setter
|
|
@@ -7482,6 +8966,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7482
8966
|
|
|
7483
8967
|
@property
|
|
7484
8968
|
def ThumbnailResolution(self):
|
|
8969
|
+
"""Resolution of the thumbnail generated for dynamic transcoding
|
|
8970
|
+
:rtype: str
|
|
8971
|
+
"""
|
|
7485
8972
|
return self._ThumbnailResolution
|
|
7486
8973
|
|
|
7487
8974
|
@ThumbnailResolution.setter
|
|
@@ -7490,6 +8977,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7490
8977
|
|
|
7491
8978
|
@property
|
|
7492
8979
|
def CompressFileUrl(self):
|
|
8980
|
+
"""URL for downloading the transcoded and compressed file. If `CompressFileType` carried in the document transcoding request is null or is not a supported compression format, this parameter is null.
|
|
8981
|
+
:rtype: str
|
|
8982
|
+
"""
|
|
7493
8983
|
return self._CompressFileUrl
|
|
7494
8984
|
|
|
7495
8985
|
@CompressFileUrl.setter
|
|
@@ -7498,6 +8988,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7498
8988
|
|
|
7499
8989
|
@property
|
|
7500
8990
|
def ErrorCode(self):
|
|
8991
|
+
"""Task execution error code.
|
|
8992
|
+
:rtype: int
|
|
8993
|
+
"""
|
|
7501
8994
|
return self._ErrorCode
|
|
7502
8995
|
|
|
7503
8996
|
@ErrorCode.setter
|
|
@@ -7506,6 +8999,9 @@ If the document transcoding request carries the ThumbnailResolution parameter an
|
|
|
7506
8999
|
|
|
7507
9000
|
@property
|
|
7508
9001
|
def ErrorMsg(self):
|
|
9002
|
+
"""Task execution error message.
|
|
9003
|
+
:rtype: str
|
|
9004
|
+
"""
|
|
7509
9005
|
return self._ErrorMsg
|
|
7510
9006
|
|
|
7511
9007
|
@ErrorMsg.setter
|
|
@@ -7568,6 +9064,9 @@ class TranscodeTaskSearchResult(AbstractModel):
|
|
|
7568
9064
|
|
|
7569
9065
|
@property
|
|
7570
9066
|
def CreateTime(self):
|
|
9067
|
+
"""Creation time of the task.
|
|
9068
|
+
:rtype: str
|
|
9069
|
+
"""
|
|
7571
9070
|
return self._CreateTime
|
|
7572
9071
|
|
|
7573
9072
|
@CreateTime.setter
|
|
@@ -7576,6 +9075,9 @@ class TranscodeTaskSearchResult(AbstractModel):
|
|
|
7576
9075
|
|
|
7577
9076
|
@property
|
|
7578
9077
|
def TaskId(self):
|
|
9078
|
+
"""Unique task ID.
|
|
9079
|
+
:rtype: str
|
|
9080
|
+
"""
|
|
7579
9081
|
return self._TaskId
|
|
7580
9082
|
|
|
7581
9083
|
@TaskId.setter
|
|
@@ -7584,6 +9086,12 @@ class TranscodeTaskSearchResult(AbstractModel):
|
|
|
7584
9086
|
|
|
7585
9087
|
@property
|
|
7586
9088
|
def Status(self):
|
|
9089
|
+
"""Current task status.
|
|
9090
|
+
- QUEUED: Queuing for transcoding.
|
|
9091
|
+
- PROCESSING: Transcoding in progress.
|
|
9092
|
+
- FINISHED: Transcoding finished.
|
|
9093
|
+
:rtype: str
|
|
9094
|
+
"""
|
|
7587
9095
|
return self._Status
|
|
7588
9096
|
|
|
7589
9097
|
@Status.setter
|
|
@@ -7592,6 +9100,9 @@ class TranscodeTaskSearchResult(AbstractModel):
|
|
|
7592
9100
|
|
|
7593
9101
|
@property
|
|
7594
9102
|
def OriginalFilename(self):
|
|
9103
|
+
"""Original name of the transcoded document.
|
|
9104
|
+
:rtype: str
|
|
9105
|
+
"""
|
|
7595
9106
|
return self._OriginalFilename
|
|
7596
9107
|
|
|
7597
9108
|
@OriginalFilename.setter
|
|
@@ -7600,6 +9111,9 @@ class TranscodeTaskSearchResult(AbstractModel):
|
|
|
7600
9111
|
|
|
7601
9112
|
@property
|
|
7602
9113
|
def SdkAppId(self):
|
|
9114
|
+
"""SdkAppId of the whiteboard application.
|
|
9115
|
+
:rtype: int
|
|
9116
|
+
"""
|
|
7603
9117
|
return self._SdkAppId
|
|
7604
9118
|
|
|
7605
9119
|
@SdkAppId.setter
|
|
@@ -7608,6 +9122,9 @@ class TranscodeTaskSearchResult(AbstractModel):
|
|
|
7608
9122
|
|
|
7609
9123
|
@property
|
|
7610
9124
|
def Result(self):
|
|
9125
|
+
"""Transcoding task result.
|
|
9126
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.TranscodeTaskResult`
|
|
9127
|
+
"""
|
|
7611
9128
|
return self._Result
|
|
7612
9129
|
|
|
7613
9130
|
@Result.setter
|
|
@@ -7616,6 +9133,9 @@ class TranscodeTaskSearchResult(AbstractModel):
|
|
|
7616
9133
|
|
|
7617
9134
|
@property
|
|
7618
9135
|
def IsStatic(self):
|
|
9136
|
+
"""Specifies whether the transcoding is static.
|
|
9137
|
+
:rtype: bool
|
|
9138
|
+
"""
|
|
7619
9139
|
return self._IsStatic
|
|
7620
9140
|
|
|
7621
9141
|
@IsStatic.setter
|
|
@@ -7672,6 +9192,9 @@ class UsageDataItem(AbstractModel):
|
|
|
7672
9192
|
|
|
7673
9193
|
@property
|
|
7674
9194
|
def Time(self):
|
|
9195
|
+
"""Start date in the format of YYYY-MM-DD.
|
|
9196
|
+
:rtype: str
|
|
9197
|
+
"""
|
|
7675
9198
|
return self._Time
|
|
7676
9199
|
|
|
7677
9200
|
@Time.setter
|
|
@@ -7680,6 +9203,9 @@ class UsageDataItem(AbstractModel):
|
|
|
7680
9203
|
|
|
7681
9204
|
@property
|
|
7682
9205
|
def SdkAppId(self):
|
|
9206
|
+
"""SdkAppId of the whiteboard application.
|
|
9207
|
+
:rtype: int
|
|
9208
|
+
"""
|
|
7683
9209
|
return self._SdkAppId
|
|
7684
9210
|
|
|
7685
9211
|
@SdkAppId.setter
|
|
@@ -7688,6 +9214,13 @@ class UsageDataItem(AbstractModel):
|
|
|
7688
9214
|
|
|
7689
9215
|
@property
|
|
7690
9216
|
def SubProduct(self):
|
|
9217
|
+
"""Subproduct usage information, which is consistent with the corresponding request parameters.
|
|
9218
|
+
- sp_tiw_board: The duration of use of whiteboards.
|
|
9219
|
+
- sp_tiw_dt: The number of pages dynamically transcoded.
|
|
9220
|
+
- sp_tiw_st: The number of pages statically transcoded.
|
|
9221
|
+
- sp_tiw_ric: The duration of real-time recording.
|
|
9222
|
+
:rtype: str
|
|
9223
|
+
"""
|
|
7691
9224
|
return self._SubProduct
|
|
7692
9225
|
|
|
7693
9226
|
@SubProduct.setter
|
|
@@ -7696,6 +9229,11 @@ class UsageDataItem(AbstractModel):
|
|
|
7696
9229
|
|
|
7697
9230
|
@property
|
|
7698
9231
|
def Value(self):
|
|
9232
|
+
"""Usage values.
|
|
9233
|
+
- The unit of sp_tiw_dt and sp_tiw_st is pages.
|
|
9234
|
+
- The unit of sp_tiw_board and sp_tiw_ric is minutes.
|
|
9235
|
+
:rtype: float
|
|
9236
|
+
"""
|
|
7699
9237
|
return self._Value
|
|
7700
9238
|
|
|
7701
9239
|
@Value.setter
|
|
@@ -7738,6 +9276,9 @@ class UserListItem(AbstractModel):
|
|
|
7738
9276
|
|
|
7739
9277
|
@property
|
|
7740
9278
|
def UserId(self):
|
|
9279
|
+
"""User ID in the room.
|
|
9280
|
+
:rtype: str
|
|
9281
|
+
"""
|
|
7741
9282
|
return self._UserId
|
|
7742
9283
|
|
|
7743
9284
|
@UserId.setter
|
|
@@ -7746,6 +9287,9 @@ class UserListItem(AbstractModel):
|
|
|
7746
9287
|
|
|
7747
9288
|
@property
|
|
7748
9289
|
def StartTime(self):
|
|
9290
|
+
"""The first time when the user ID appeared during the queried period, which is a Unix timestamp in milliseconds.
|
|
9291
|
+
:rtype: int
|
|
9292
|
+
"""
|
|
7749
9293
|
return self._StartTime
|
|
7750
9294
|
|
|
7751
9295
|
@StartTime.setter
|
|
@@ -7754,6 +9298,9 @@ class UserListItem(AbstractModel):
|
|
|
7754
9298
|
|
|
7755
9299
|
@property
|
|
7756
9300
|
def EndTime(self):
|
|
9301
|
+
"""The last time when the user ID appeared during the queried period, which is a Unix timestamp in milliseconds.
|
|
9302
|
+
:rtype: int
|
|
9303
|
+
"""
|
|
7757
9304
|
return self._EndTime
|
|
7758
9305
|
|
|
7759
9306
|
@EndTime.setter
|
|
@@ -7816,6 +9363,9 @@ class VideoInfo(AbstractModel):
|
|
|
7816
9363
|
|
|
7817
9364
|
@property
|
|
7818
9365
|
def VideoPlayTime(self):
|
|
9366
|
+
"""Video playback start time, in milliseconds
|
|
9367
|
+
:rtype: int
|
|
9368
|
+
"""
|
|
7819
9369
|
return self._VideoPlayTime
|
|
7820
9370
|
|
|
7821
9371
|
@VideoPlayTime.setter
|
|
@@ -7824,6 +9374,9 @@ class VideoInfo(AbstractModel):
|
|
|
7824
9374
|
|
|
7825
9375
|
@property
|
|
7826
9376
|
def VideoSize(self):
|
|
9377
|
+
"""Video size, in bytes
|
|
9378
|
+
:rtype: int
|
|
9379
|
+
"""
|
|
7827
9380
|
return self._VideoSize
|
|
7828
9381
|
|
|
7829
9382
|
@VideoSize.setter
|
|
@@ -7832,6 +9385,9 @@ class VideoInfo(AbstractModel):
|
|
|
7832
9385
|
|
|
7833
9386
|
@property
|
|
7834
9387
|
def VideoFormat(self):
|
|
9388
|
+
"""Video format
|
|
9389
|
+
:rtype: str
|
|
9390
|
+
"""
|
|
7835
9391
|
return self._VideoFormat
|
|
7836
9392
|
|
|
7837
9393
|
@VideoFormat.setter
|
|
@@ -7840,6 +9396,9 @@ class VideoInfo(AbstractModel):
|
|
|
7840
9396
|
|
|
7841
9397
|
@property
|
|
7842
9398
|
def VideoDuration(self):
|
|
9399
|
+
"""Video playback duration, in milliseconds
|
|
9400
|
+
:rtype: int
|
|
9401
|
+
"""
|
|
7843
9402
|
return self._VideoDuration
|
|
7844
9403
|
|
|
7845
9404
|
@VideoDuration.setter
|
|
@@ -7848,6 +9407,9 @@ class VideoInfo(AbstractModel):
|
|
|
7848
9407
|
|
|
7849
9408
|
@property
|
|
7850
9409
|
def VideoUrl(self):
|
|
9410
|
+
"""Video file URL
|
|
9411
|
+
:rtype: str
|
|
9412
|
+
"""
|
|
7851
9413
|
return self._VideoUrl
|
|
7852
9414
|
|
|
7853
9415
|
@VideoUrl.setter
|
|
@@ -7856,6 +9418,9 @@ class VideoInfo(AbstractModel):
|
|
|
7856
9418
|
|
|
7857
9419
|
@property
|
|
7858
9420
|
def VideoId(self):
|
|
9421
|
+
"""Video file ID
|
|
9422
|
+
:rtype: str
|
|
9423
|
+
"""
|
|
7859
9424
|
return self._VideoId
|
|
7860
9425
|
|
|
7861
9426
|
@VideoId.setter
|
|
@@ -7864,6 +9429,9 @@ class VideoInfo(AbstractModel):
|
|
|
7864
9429
|
|
|
7865
9430
|
@property
|
|
7866
9431
|
def VideoType(self):
|
|
9432
|
+
"""Video stream type - 0: camera video - 1: screen-sharing video - 2: whiteboard video - 3: mixed stream video - 4: audio-only (mp3)
|
|
9433
|
+
:rtype: int
|
|
9434
|
+
"""
|
|
7867
9435
|
return self._VideoType
|
|
7868
9436
|
|
|
7869
9437
|
@VideoType.setter
|
|
@@ -7872,6 +9440,9 @@ class VideoInfo(AbstractModel):
|
|
|
7872
9440
|
|
|
7873
9441
|
@property
|
|
7874
9442
|
def UserId(self):
|
|
9443
|
+
"""ID of the user to which the camera video or screen-sharing video belongs (whiteboard video: null, mixed stream video: tic_mixstream_<Room ID>_<Mixed stream layout type>, auxiliary video: tic_substream_user ID)
|
|
9444
|
+
:rtype: str
|
|
9445
|
+
"""
|
|
7875
9446
|
return self._UserId
|
|
7876
9447
|
|
|
7877
9448
|
@UserId.setter
|
|
@@ -7880,6 +9451,9 @@ class VideoInfo(AbstractModel):
|
|
|
7880
9451
|
|
|
7881
9452
|
@property
|
|
7882
9453
|
def Width(self):
|
|
9454
|
+
"""Width of the video resolution.
|
|
9455
|
+
:rtype: int
|
|
9456
|
+
"""
|
|
7883
9457
|
return self._Width
|
|
7884
9458
|
|
|
7885
9459
|
@Width.setter
|
|
@@ -7888,6 +9462,9 @@ class VideoInfo(AbstractModel):
|
|
|
7888
9462
|
|
|
7889
9463
|
@property
|
|
7890
9464
|
def Height(self):
|
|
9465
|
+
"""Height of the video resolution.
|
|
9466
|
+
:rtype: int
|
|
9467
|
+
"""
|
|
7891
9468
|
return self._Height
|
|
7892
9469
|
|
|
7893
9470
|
@Height.setter
|
|
@@ -7936,6 +9513,9 @@ class Whiteboard(AbstractModel):
|
|
|
7936
9513
|
|
|
7937
9514
|
@property
|
|
7938
9515
|
def Width(self):
|
|
9516
|
+
"""Whiteboard video width in the real-time recording result. The value must be equal to or greater than 2. Default value: 1280.
|
|
9517
|
+
:rtype: int
|
|
9518
|
+
"""
|
|
7939
9519
|
return self._Width
|
|
7940
9520
|
|
|
7941
9521
|
@Width.setter
|
|
@@ -7944,6 +9524,9 @@ class Whiteboard(AbstractModel):
|
|
|
7944
9524
|
|
|
7945
9525
|
@property
|
|
7946
9526
|
def Height(self):
|
|
9527
|
+
"""Whiteboard video height in the real-time recording result. The value must be equal to or greater than 2. Default value: 960.
|
|
9528
|
+
:rtype: int
|
|
9529
|
+
"""
|
|
7947
9530
|
return self._Height
|
|
7948
9531
|
|
|
7949
9532
|
@Height.setter
|
|
@@ -7952,6 +9535,9 @@ class Whiteboard(AbstractModel):
|
|
|
7952
9535
|
|
|
7953
9536
|
@property
|
|
7954
9537
|
def InitParam(self):
|
|
9538
|
+
"""Whiteboard initialization parameter, which is passed through to the whiteboard SDK
|
|
9539
|
+
:rtype: str
|
|
9540
|
+
"""
|
|
7955
9541
|
return self._InitParam
|
|
7956
9542
|
|
|
7957
9543
|
@InitParam.setter
|
|
@@ -8017,6 +9603,12 @@ transcode: Document transcoding.
|
|
|
8017
9603
|
|
|
8018
9604
|
@property
|
|
8019
9605
|
def TaskType(self):
|
|
9606
|
+
"""Task type.
|
|
9607
|
+
|
|
9608
|
+
recording: Real-time recording.
|
|
9609
|
+
transcode: Document transcoding.
|
|
9610
|
+
:rtype: str
|
|
9611
|
+
"""
|
|
8020
9612
|
return self._TaskType
|
|
8021
9613
|
|
|
8022
9614
|
@TaskType.setter
|
|
@@ -8025,6 +9617,9 @@ transcode: Document transcoding.
|
|
|
8025
9617
|
|
|
8026
9618
|
@property
|
|
8027
9619
|
def BucketName(self):
|
|
9620
|
+
"""Bucket name.
|
|
9621
|
+
:rtype: str
|
|
9622
|
+
"""
|
|
8028
9623
|
return self._BucketName
|
|
8029
9624
|
|
|
8030
9625
|
@BucketName.setter
|
|
@@ -8033,6 +9628,9 @@ transcode: Document transcoding.
|
|
|
8033
9628
|
|
|
8034
9629
|
@property
|
|
8035
9630
|
def BucketLocation(self):
|
|
9631
|
+
"""Region of the bucket.
|
|
9632
|
+
:rtype: str
|
|
9633
|
+
"""
|
|
8036
9634
|
return self._BucketLocation
|
|
8037
9635
|
|
|
8038
9636
|
@BucketLocation.setter
|
|
@@ -8041,6 +9639,9 @@ transcode: Document transcoding.
|
|
|
8041
9639
|
|
|
8042
9640
|
@property
|
|
8043
9641
|
def BucketPrefix(self):
|
|
9642
|
+
"""Resource prefix of the bucket.
|
|
9643
|
+
:rtype: str
|
|
9644
|
+
"""
|
|
8044
9645
|
return self._BucketPrefix
|
|
8045
9646
|
|
|
8046
9647
|
@BucketPrefix.setter
|
|
@@ -8049,6 +9650,9 @@ transcode: Document transcoding.
|
|
|
8049
9650
|
|
|
8050
9651
|
@property
|
|
8051
9652
|
def ResultDomain(self):
|
|
9653
|
+
"""Destination CDN domain name.
|
|
9654
|
+
:rtype: str
|
|
9655
|
+
"""
|
|
8052
9656
|
return self._ResultDomain
|
|
8053
9657
|
|
|
8054
9658
|
@ResultDomain.setter
|
|
@@ -8057,6 +9661,9 @@ transcode: Document transcoding.
|
|
|
8057
9661
|
|
|
8058
9662
|
@property
|
|
8059
9663
|
def Callback(self):
|
|
9664
|
+
"""Callback URL.
|
|
9665
|
+
:rtype: str
|
|
9666
|
+
"""
|
|
8060
9667
|
return self._Callback
|
|
8061
9668
|
|
|
8062
9669
|
@Callback.setter
|
|
@@ -8065,6 +9672,9 @@ transcode: Document transcoding.
|
|
|
8065
9672
|
|
|
8066
9673
|
@property
|
|
8067
9674
|
def CallbackKey(self):
|
|
9675
|
+
"""Callback authentication key.
|
|
9676
|
+
:rtype: str
|
|
9677
|
+
"""
|
|
8068
9678
|
return self._CallbackKey
|
|
8069
9679
|
|
|
8070
9680
|
@CallbackKey.setter
|
|
@@ -8073,6 +9683,9 @@ transcode: Document transcoding.
|
|
|
8073
9683
|
|
|
8074
9684
|
@property
|
|
8075
9685
|
def SdkAppId(self):
|
|
9686
|
+
"""SdkAppId of the whiteboard application.
|
|
9687
|
+
:rtype: int
|
|
9688
|
+
"""
|
|
8076
9689
|
return self._SdkAppId
|
|
8077
9690
|
|
|
8078
9691
|
@SdkAppId.setter
|
|
@@ -8081,6 +9694,9 @@ transcode: Document transcoding.
|
|
|
8081
9694
|
|
|
8082
9695
|
@property
|
|
8083
9696
|
def AdminUserId(self):
|
|
9697
|
+
"""IM admin user ID.
|
|
9698
|
+
:rtype: str
|
|
9699
|
+
"""
|
|
8084
9700
|
return self._AdminUserId
|
|
8085
9701
|
|
|
8086
9702
|
@AdminUserId.setter
|
|
@@ -8089,6 +9705,9 @@ transcode: Document transcoding.
|
|
|
8089
9705
|
|
|
8090
9706
|
@property
|
|
8091
9707
|
def AdminUserSig(self):
|
|
9708
|
+
"""IM admin user signature.
|
|
9709
|
+
:rtype: str
|
|
9710
|
+
"""
|
|
8092
9711
|
return self._AdminUserSig
|
|
8093
9712
|
|
|
8094
9713
|
@AdminUserSig.setter
|
|
@@ -8135,6 +9754,10 @@ The ID must be an unused ID in the SDK. The whiteboard push service uses the use
|
|
|
8135
9754
|
|
|
8136
9755
|
@property
|
|
8137
9756
|
def PushUserId(self):
|
|
9757
|
+
"""User ID used by the whiteboard push service for entering a room,
|
|
9758
|
+
The ID must be an unused ID in the SDK. The whiteboard push service uses the user ID to enter the room for whiteboard push. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the pushing operation.
|
|
9759
|
+
:rtype: str
|
|
9760
|
+
"""
|
|
8138
9761
|
return self._PushUserId
|
|
8139
9762
|
|
|
8140
9763
|
@PushUserId.setter
|
|
@@ -8143,6 +9766,9 @@ The ID must be an unused ID in the SDK. The whiteboard push service uses the use
|
|
|
8143
9766
|
|
|
8144
9767
|
@property
|
|
8145
9768
|
def PushUserSig(self):
|
|
9769
|
+
"""Signature corresponding to the PushUserId ID.
|
|
9770
|
+
:rtype: str
|
|
9771
|
+
"""
|
|
8146
9772
|
return self._PushUserSig
|
|
8147
9773
|
|
|
8148
9774
|
@PushUserSig.setter
|
|
@@ -8201,6 +9827,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8201
9827
|
|
|
8202
9828
|
@property
|
|
8203
9829
|
def FinishReason(self):
|
|
9830
|
+
"""`AUTO`: Pushing automatically stops. `USER_CALL`: The API for stopping pushing is called.
|
|
9831
|
+
:rtype: str
|
|
9832
|
+
"""
|
|
8204
9833
|
return self._FinishReason
|
|
8205
9834
|
|
|
8206
9835
|
@FinishReason.setter
|
|
@@ -8209,6 +9838,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8209
9838
|
|
|
8210
9839
|
@property
|
|
8211
9840
|
def ExceptionCnt(self):
|
|
9841
|
+
"""Number of exceptions.
|
|
9842
|
+
:rtype: int
|
|
9843
|
+
"""
|
|
8212
9844
|
return self._ExceptionCnt
|
|
8213
9845
|
|
|
8214
9846
|
@ExceptionCnt.setter
|
|
@@ -8217,6 +9849,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8217
9849
|
|
|
8218
9850
|
@property
|
|
8219
9851
|
def RoomId(self):
|
|
9852
|
+
"""Room ID.
|
|
9853
|
+
:rtype: int
|
|
9854
|
+
"""
|
|
8220
9855
|
return self._RoomId
|
|
8221
9856
|
|
|
8222
9857
|
@RoomId.setter
|
|
@@ -8225,6 +9860,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8225
9860
|
|
|
8226
9861
|
@property
|
|
8227
9862
|
def GroupId(self):
|
|
9863
|
+
"""IM group ID.
|
|
9864
|
+
:rtype: str
|
|
9865
|
+
"""
|
|
8228
9866
|
return self._GroupId
|
|
8229
9867
|
|
|
8230
9868
|
@GroupId.setter
|
|
@@ -8233,6 +9871,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8233
9871
|
|
|
8234
9872
|
@property
|
|
8235
9873
|
def PushStartTime(self):
|
|
9874
|
+
"""Actual push start time.
|
|
9875
|
+
:rtype: int
|
|
9876
|
+
"""
|
|
8236
9877
|
return self._PushStartTime
|
|
8237
9878
|
|
|
8238
9879
|
@PushStartTime.setter
|
|
@@ -8241,6 +9882,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8241
9882
|
|
|
8242
9883
|
@property
|
|
8243
9884
|
def PushStopTime(self):
|
|
9885
|
+
"""Push end time.
|
|
9886
|
+
:rtype: int
|
|
9887
|
+
"""
|
|
8244
9888
|
return self._PushStopTime
|
|
8245
9889
|
|
|
8246
9890
|
@PushStopTime.setter
|
|
@@ -8249,6 +9893,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8249
9893
|
|
|
8250
9894
|
@property
|
|
8251
9895
|
def IMSyncTime(self):
|
|
9896
|
+
"""IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.
|
|
9897
|
+
:rtype: int
|
|
9898
|
+
"""
|
|
8252
9899
|
return self._IMSyncTime
|
|
8253
9900
|
|
|
8254
9901
|
@IMSyncTime.setter
|
|
@@ -8257,6 +9904,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8257
9904
|
|
|
8258
9905
|
@property
|
|
8259
9906
|
def ErrorCode(self):
|
|
9907
|
+
"""Task execution error code.
|
|
9908
|
+
:rtype: int
|
|
9909
|
+
"""
|
|
8260
9910
|
return self._ErrorCode
|
|
8261
9911
|
|
|
8262
9912
|
@ErrorCode.setter
|
|
@@ -8265,6 +9915,9 @@ class WhiteboardPushResult(AbstractModel):
|
|
|
8265
9915
|
|
|
8266
9916
|
@property
|
|
8267
9917
|
def ErrorMsg(self):
|
|
9918
|
+
"""Error message.
|
|
9919
|
+
:rtype: str
|
|
9920
|
+
"""
|
|
8268
9921
|
return self._ErrorMsg
|
|
8269
9922
|
|
|
8270
9923
|
@ErrorMsg.setter
|
|
@@ -8327,6 +9980,9 @@ class WhiteboardPushTaskSearchResult(AbstractModel):
|
|
|
8327
9980
|
|
|
8328
9981
|
@property
|
|
8329
9982
|
def TaskId(self):
|
|
9983
|
+
"""Unique task ID.
|
|
9984
|
+
:rtype: str
|
|
9985
|
+
"""
|
|
8330
9986
|
return self._TaskId
|
|
8331
9987
|
|
|
8332
9988
|
@TaskId.setter
|
|
@@ -8335,6 +9991,12 @@ class WhiteboardPushTaskSearchResult(AbstractModel):
|
|
|
8335
9991
|
|
|
8336
9992
|
@property
|
|
8337
9993
|
def Status(self):
|
|
9994
|
+
"""Status of the whiteboard push task.
|
|
9995
|
+
- PREPARED: Push in preparation.
|
|
9996
|
+
- PUSHING: Pushing in progress.
|
|
9997
|
+
- STOPPED: Pushing stopped.
|
|
9998
|
+
:rtype: str
|
|
9999
|
+
"""
|
|
8338
10000
|
return self._Status
|
|
8339
10001
|
|
|
8340
10002
|
@Status.setter
|
|
@@ -8343,6 +10005,9 @@ class WhiteboardPushTaskSearchResult(AbstractModel):
|
|
|
8343
10005
|
|
|
8344
10006
|
@property
|
|
8345
10007
|
def RoomId(self):
|
|
10008
|
+
"""Room ID of the whiteboard push task.
|
|
10009
|
+
:rtype: int
|
|
10010
|
+
"""
|
|
8346
10011
|
return self._RoomId
|
|
8347
10012
|
|
|
8348
10013
|
@RoomId.setter
|
|
@@ -8351,6 +10016,9 @@ class WhiteboardPushTaskSearchResult(AbstractModel):
|
|
|
8351
10016
|
|
|
8352
10017
|
@property
|
|
8353
10018
|
def CreateTime(self):
|
|
10019
|
+
"""Creation time of the task.
|
|
10020
|
+
:rtype: str
|
|
10021
|
+
"""
|
|
8354
10022
|
return self._CreateTime
|
|
8355
10023
|
|
|
8356
10024
|
@CreateTime.setter
|
|
@@ -8359,6 +10027,9 @@ class WhiteboardPushTaskSearchResult(AbstractModel):
|
|
|
8359
10027
|
|
|
8360
10028
|
@property
|
|
8361
10029
|
def SdkAppId(self):
|
|
10030
|
+
"""SdkAppId of the whiteboard application.
|
|
10031
|
+
:rtype: int
|
|
10032
|
+
"""
|
|
8362
10033
|
return self._SdkAppId
|
|
8363
10034
|
|
|
8364
10035
|
@SdkAppId.setter
|
|
@@ -8367,6 +10038,9 @@ class WhiteboardPushTaskSearchResult(AbstractModel):
|
|
|
8367
10038
|
|
|
8368
10039
|
@property
|
|
8369
10040
|
def Result(self):
|
|
10041
|
+
"""Whiteboard push result.
|
|
10042
|
+
:rtype: :class:`tencentcloud.tiw.v20190919.models.WhiteboardPushResult`
|
|
10043
|
+
"""
|
|
8370
10044
|
return self._Result
|
|
8371
10045
|
|
|
8372
10046
|
@Result.setter
|
|
@@ -8375,6 +10049,9 @@ class WhiteboardPushTaskSearchResult(AbstractModel):
|
|
|
8375
10049
|
|
|
8376
10050
|
@property
|
|
8377
10051
|
def PushUserId(self):
|
|
10052
|
+
"""User ID of the whiteboard push task.
|
|
10053
|
+
:rtype: str
|
|
10054
|
+
"""
|
|
8378
10055
|
return self._PushUserId
|
|
8379
10056
|
|
|
8380
10057
|
@PushUserId.setter
|