tccli 3.0.875.1__py2.py3-none-any.whl → 3.0.877.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/aa/v20200224/api.json +39 -0
- tccli/services/acp/v20220105/api.json +115 -0
- tccli/services/advisor/v20200721/api.json +30 -0
- tccli/services/af/v20200226/api.json +114 -0
- tccli/services/afc/v20200226/api.json +83 -0
- tccli/services/aiart/v20221229/api.json +25 -0
- tccli/services/ame/v20190916/api.json +329 -0
- tccli/services/ams/v20201229/api.json +151 -0
- tccli/services/anicloud/v20220923/api.json +36 -0
- tccli/services/antiddos/v20200309/api.json +928 -0
- tccli/services/apigateway/v20180808/api.json +1115 -0
- tccli/services/apm/v20210622/api.json +130 -0
- tccli/services/asr/v20190614/api.json +161 -2
- tccli/services/asw/v20200722/api.json +84 -0
- tccli/services/autoscaling/v20180419/api.json +564 -0
- tccli/services/ba/v20200720/api.json +10 -0
- tccli/services/batch/v20170312/api.json +514 -6
- tccli/services/bda/v20200324/api.json +186 -0
- tccli/services/bi/v20220105/api.json +28 -0
- tccli/services/billing/v20180709/api.json +515 -0
- tccli/services/bm/v20180423/api.json +542 -0
- tccli/services/bma/v20210624/api.json +322 -1
- tccli/services/bma/v20221115/api.json +137 -1
- tccli/services/bmeip/v20180625/api.json +134 -0
- tccli/services/bmlb/v20180625/api.json +633 -0
- tccli/services/bmvpc/v20180625/api.json +454 -0
- tccli/services/bpaas/v20181217/api.json +54 -0
- tccli/services/bsca/v20210811/api.json +86 -0
- tccli/services/btoe/v20210514/api.json +75 -0
- tccli/services/cam/v20190116/api.json +531 -5
- tccli/services/cam/v20190116/examples.json +4 -4
- tccli/services/captcha/v20190722/api.json +220 -0
- tccli/services/car/v20220110/api.json +15 -0
- tccli/services/cat/v20180409/api.json +135 -0
- tccli/services/cbs/v20170312/api.json +376 -0
- tccli/services/ccc/v20200210/api.json +497 -0
- tccli/services/cdb/cdb_client.py +53 -0
- tccli/services/cdb/v20170320/api.json +1574 -13
- tccli/services/cdb/v20170320/examples.json +10 -2
- tccli/services/cdc/v20201214/api.json +266 -0
- tccli/services/cdn/v20180606/api.json +1591 -171
- tccli/services/cds/v20180420/api.json +45 -0
- tccli/services/cdwch/v20200915/api.json +241 -0
- tccli/services/cfg/v20210820/api.json +203 -11
- tccli/services/cfg/v20210820/examples.json +2 -2
- tccli/services/cfs/v20190719/api.json +358 -0
- tccli/services/cfw/v20190904/api.json +764 -27
- tccli/services/cfw/v20190904/examples.json +7 -7
- tccli/services/chdfs/v20201112/api.json +128 -0
- tccli/services/ciam/v20220331/api.json +211 -0
- tccli/services/cii/v20210408/api.json +155 -0
- tccli/services/ckafka/v20190819/api.json +1388 -0
- tccli/services/clb/v20180317/api.json +873 -7
- tccli/services/cloudaudit/v20190319/api.json +158 -0
- tccli/services/cloudhsm/v20191112/api.json +159 -0
- tccli/services/cloudstudio/v20210524/api.json +201 -0
- tccli/services/cls/v20201016/api.json +719 -6
- tccli/services/cme/v20191029/api.json +736 -0
- tccli/services/cmq/v20190304/api.json +155 -0
- tccli/services/cpdp/v20190820/api.json +4099 -0
- tccli/services/csip/v20221121/api.json +207 -0
- tccli/services/cvm/v20170312/api.json +905 -6
- tccli/services/cwp/cwp_client.py +163 -4
- tccli/services/cwp/v20180228/api.json +3090 -0
- tccli/services/cwp/v20180228/examples.json +24 -0
- tccli/services/cynosdb/v20190107/api.json +936 -0
- tccli/services/dasb/v20191018/api.json +538 -0
- tccli/services/dayu/v20180709/api.json +1067 -0
- tccli/services/dbbrain/v20191016/api.json +353 -0
- tccli/services/dbbrain/v20210527/api.json +594 -0
- tccli/services/dbdc/v20201029/api.json +173 -0
- tccli/services/dc/v20180410/api.json +274 -0
- tccli/services/dcdb/v20180411/api.json +714 -0
- tccli/services/dlc/v20210125/api.json +987 -0
- tccli/services/dnspod/v20210323/api.json +622 -0
- tccli/services/domain/v20180808/api.json +229 -0
- tccli/services/drm/v20181115/api.json +76 -0
- tccli/services/ds/v20180523/api.json +99 -0
- tccli/services/dts/v20180330/api.json +228 -0
- tccli/services/dts/v20211206/api.json +548 -0
- tccli/services/eb/v20210416/api.json +256 -0
- tccli/services/ecc/v20181213/api.json +70 -0
- tccli/services/ecdn/v20191012/api.json +217 -0
- tccli/services/ecm/v20190719/api.json +1127 -0
- tccli/services/eiam/v20210420/api.json +348 -0
- tccli/services/eis/v20210601/api.json +86 -0
- tccli/services/emr/v20190103/api.json +754 -0
- tccli/services/es/v20180416/api.json +582 -0
- tccli/services/ess/v20201111/api.json +624 -1
- tccli/services/essbasic/v20210526/api.json +625 -3
- tccli/services/facefusion/v20181201/api.json +66 -0
- tccli/services/facefusion/v20220927/api.json +38 -0
- tccli/services/faceid/v20180301/api.json +370 -0
- tccli/services/fmu/v20191213/api.json +72 -0
- tccli/services/ft/v20200304/api.json +45 -0
- tccli/services/gaap/v20180529/api.json +880 -0
- tccli/services/gme/v20180711/api.json +267 -0
- tccli/services/goosefs/v20220519/api.json +14 -0
- tccli/services/gs/v20191118/api.json +45 -1
- tccli/services/hasim/v20210716/api.json +261 -0
- tccli/services/hcm/v20181106/api.json +27 -0
- tccli/services/iai/v20180301/api.json +363 -0
- tccli/services/iai/v20200303/api.json +376 -0
- tccli/services/icr/v20211014/api.json +49 -0
- tccli/services/ie/v20200304/api.json +401 -0
- tccli/services/iecp/v20210914/api.json +923 -0
- tccli/services/ims/v20200713/api.json +102 -0
- tccli/services/ims/v20201229/api.json +110 -0
- tccli/services/iot/v20180123/api.json +322 -0
- tccli/services/iotcloud/v20210408/api.json +508 -0
- tccli/services/iotexplorer/v20190423/api.json +660 -0
- tccli/services/iottid/v20190411/api.json +38 -0
- tccli/services/iotvideo/v20191126/api.json +398 -0
- tccli/services/iotvideo/v20201215/api.json +583 -0
- tccli/services/iotvideo/v20211125/api.json +692 -0
- tccli/services/iotvideoindustry/v20201201/api.json +639 -0
- tccli/services/irp/v20220805/api.json +152 -0
- tccli/services/ivld/v20210903/api.json +258 -0
- tccli/services/keewidb/v20220308/api.json +424 -0
- tccli/services/kms/v20190118/api.json +230 -0
- tccli/services/lcic/v20220817/api.json +414 -0
- tccli/services/lighthouse/v20200324/api.json +541 -2
- tccli/services/lighthouse/v20200324/examples.json +1 -1
- tccli/services/live/v20180801/api.json +1253 -66
- tccli/services/live/v20180801/examples.json +16 -16
- tccli/services/mariadb/v20170312/api.json +643 -0
- tccli/services/market/v20191010/api.json +13 -0
- tccli/services/memcached/v20190318/api.json +39 -0
- tccli/services/mmps/v20200710/api.json +175 -0
- tccli/services/mna/v20210119/api.json +120 -0
- tccli/services/mongodb/v20190725/api.json +440 -0
- tccli/services/monitor/v20180724/api.json +1599 -3
- tccli/services/monitor/v20180724/examples.json +1 -1
- tccli/services/mps/v20190612/api.json +2136 -115
- tccli/services/mps/v20190612/examples.json +2 -2
- tccli/services/mrs/v20200910/api.json +1016 -0
- tccli/services/ms/v20180408/api.json +183 -0
- tccli/services/msp/v20180319/api.json +54 -0
- tccli/services/nlp/v20190408/api.json +189 -0
- tccli/services/nlp/v20190408/examples.json +1 -1
- tccli/services/oceanus/v20190422/api.json +373 -0
- tccli/services/ocr/v20181119/api.json +1585 -7
- tccli/services/omics/v20221128/api.json +176 -0
- tccli/services/organization/v20181225/api.json +75 -0
- tccli/services/organization/v20210331/api.json +155 -0
- tccli/services/partners/v20180321/api.json +281 -0
- tccli/services/pds/v20210701/api.json +12 -0
- tccli/services/postgres/v20170312/api.json +823 -0
- tccli/services/privatedns/v20201028/api.json +162 -0
- tccli/services/pts/v20210728/api.json +620 -0
- tccli/services/rce/v20201103/api.json +85 -0
- tccli/services/redis/v20180412/api.json +867 -14
- tccli/services/redis/v20180412/examples.json +2 -2
- tccli/services/region/v20220627/api.json +30 -0
- tccli/services/rkp/v20191209/api.json +50 -0
- tccli/services/rum/v20210622/api.json +706 -0
- tccli/services/scf/v20180416/api.json +583 -0
- tccli/services/ses/v20201002/api.json +178 -0
- tccli/services/smh/v20210712/api.json +99 -0
- tccli/services/smop/v20201203/api.json +24 -0
- tccli/services/smpn/v20190822/api.json +32 -0
- tccli/services/sms/v20190711/api.json +153 -0
- tccli/services/sms/v20210111/api.json +168 -0
- tccli/services/soe/v20180724/api.json +114 -0
- tccli/services/sqlserver/v20180328/api.json +1012 -0
- tccli/services/ssa/v20180608/api.json +580 -0
- tccli/services/ssl/v20191205/api.json +412 -0
- tccli/services/sslpod/v20190605/api.json +75 -0
- tccli/services/ssm/v20190923/api.json +168 -0
- tccli/services/sts/v20180813/api.json +47 -0
- tccli/services/taf/v20200210/api.json +55 -0
- tccli/services/tag/v20180813/api.json +217 -0
- tccli/services/tan/v20220420/api.json +3 -0
- tccli/services/tat/v20201028/api.json +213 -0
- tccli/services/tbaas/v20180416/api.json +353 -0
- tccli/services/tbp/v20190311/api.json +41 -0
- tccli/services/tbp/v20190627/api.json +34 -0
- tccli/services/tcaplusdb/v20190823/api.json +554 -0
- tccli/services/tcbr/v20220217/api.json +188 -0
- tccli/services/tcm/v20210413/api.json +235 -0
- tccli/services/tcr/v20190924/api.json +711 -0
- tccli/services/tcss/v20201101/api.json +3101 -24
- tccli/services/tcss/v20201101/examples.json +6 -6
- tccli/services/tdcpg/v20211118/api.json +179 -0
- tccli/services/tdid/v20210519/api.json +369 -0
- tccli/services/tdmq/v20200217/api.json +1166 -0
- tccli/services/tds/v20220801/api.json +61 -0
- tccli/services/tem/v20210701/api.json +747 -0
- tccli/services/teo/v20220106/api.json +81 -0
- tccli/services/teo/v20220901/api.json +1234 -17
- tccli/services/thpc/v20211109/api.json +93 -0
- tccli/services/thpc/v20220401/api.json +216 -0
- tccli/services/thpc/v20230321/api.json +222 -0
- tccli/services/tic/v20201117/api.json +76 -0
- tccli/services/tics/v20181115/api.json +60 -0
- tccli/services/tiia/v20190529/api.json +229 -0
- tccli/services/tione/v20191022/api.json +228 -0
- tccli/services/tione/v20211111/api.json +945 -0
- tccli/services/tiw/v20190919/api.json +472 -0
- tccli/services/tke/v20180525/api.json +1751 -0
- tccli/services/tms/v20201229/api.json +49 -0
- tccli/services/tmt/v20180321/api.json +70 -0
- tccli/services/tourism/v20230215/api.json +16 -0
- tccli/services/trdp/v20220726/api.json +77 -0
- tccli/services/trp/v20210515/api.json +468 -0
- tccli/services/trro/v20220325/api.json +187 -0
- tccli/services/trtc/v20190722/api.json +501 -0
- tccli/services/tse/v20201207/api.json +185 -0
- tccli/services/tsf/tsf_client.py +57 -4
- tccli/services/tsf/v20180326/api.json +2409 -0
- tccli/services/tsf/v20180326/examples.json +8 -0
- tccli/services/tsw/v20210412/api.json +2 -0
- tccli/services/tts/v20190823/api.json +43 -0
- tccli/services/ump/v20200918/api.json +168 -0
- tccli/services/vm/v20201229/api.json +147 -0
- tccli/services/vm/v20210922/api.json +154 -0
- tccli/services/vms/v20200902/api.json +15 -0
- tccli/services/vod/v20180717/api.json +2787 -0
- tccli/services/vpc/v20170312/api.json +2175 -0
- tccli/services/vpc/v20170312/examples.json +16 -0
- tccli/services/vpc/vpc_client.py +114 -8
- tccli/services/vrs/v20200824/api.json +35 -0
- tccli/services/waf/v20180125/api.json +607 -0
- tccli/services/wav/v20210129/api.json +395 -0
- tccli/services/wedata/v20210820/api.json +2154 -0
- tccli/services/yinsuda/v20220527/api.json +194 -0
- tccli/services/yunsou/v20191115/api.json +50 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/METADATA +2 -2
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/RECORD +234 -234
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/LICENSE +0 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/top_level.txt +0 -0
@@ -454,6 +454,7 @@
|
|
454
454
|
"members": [
|
455
455
|
{
|
456
456
|
"default": "",
|
457
|
+
"disabled": false,
|
457
458
|
"document": "应用SdkAppId",
|
458
459
|
"member": "int64",
|
459
460
|
"name": "SdkAppId",
|
@@ -463,6 +464,7 @@
|
|
463
464
|
},
|
464
465
|
{
|
465
466
|
"default": "",
|
467
|
+
"disabled": false,
|
466
468
|
"document": "应用名",
|
467
469
|
"member": "string",
|
468
470
|
"name": "AppName",
|
@@ -472,6 +474,7 @@
|
|
472
474
|
},
|
473
475
|
{
|
474
476
|
"default": "",
|
477
|
+
"disabled": false,
|
475
478
|
"document": "创建时间",
|
476
479
|
"member": "datetime",
|
477
480
|
"name": "CreateTime",
|
@@ -481,6 +484,7 @@
|
|
481
484
|
},
|
482
485
|
{
|
483
486
|
"default": "",
|
487
|
+
"disabled": false,
|
484
488
|
"document": "标签列表",
|
485
489
|
"member": "Tag",
|
486
490
|
"name": "TagList",
|
@@ -513,6 +517,7 @@
|
|
513
517
|
"members": [
|
514
518
|
{
|
515
519
|
"default": "",
|
520
|
+
"disabled": false,
|
516
521
|
"document": "应用SdkAppId",
|
517
522
|
"example": "12345678",
|
518
523
|
"member": "int64",
|
@@ -523,6 +528,7 @@
|
|
523
528
|
},
|
524
529
|
{
|
525
530
|
"default": "",
|
531
|
+
"disabled": false,
|
526
532
|
"document": "用户ID",
|
527
533
|
"example": "userid",
|
528
534
|
"member": "string",
|
@@ -533,6 +539,7 @@
|
|
533
539
|
},
|
534
540
|
{
|
535
541
|
"default": "",
|
542
|
+
"disabled": false,
|
536
543
|
"document": "用户ID对应的签名",
|
537
544
|
"example": "usersig",
|
538
545
|
"member": "string",
|
@@ -549,6 +556,7 @@
|
|
549
556
|
"members": [
|
550
557
|
{
|
551
558
|
"default": "",
|
559
|
+
"disabled": false,
|
552
560
|
"document": "混流画布宽高配置",
|
553
561
|
"member": "LayoutParams",
|
554
562
|
"name": "LayoutParams",
|
@@ -558,6 +566,7 @@
|
|
558
566
|
},
|
559
567
|
{
|
560
568
|
"default": "",
|
569
|
+
"disabled": false,
|
561
570
|
"document": "背景颜色,默认为黑色,格式为RGB格式,如红色为\"#FF0000\"",
|
562
571
|
"member": "string",
|
563
572
|
"name": "BackgroundColor",
|
@@ -573,6 +582,7 @@
|
|
573
582
|
"members": [
|
574
583
|
{
|
575
584
|
"default": "",
|
585
|
+
"disabled": false,
|
576
586
|
"document": "是否开启拼接功能\n在开启了视频拼接功能的情况下,实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频",
|
577
587
|
"member": "bool",
|
578
588
|
"name": "Enabled",
|
@@ -582,6 +592,7 @@
|
|
582
592
|
},
|
583
593
|
{
|
584
594
|
"default": "",
|
595
|
+
"disabled": false,
|
585
596
|
"document": "视频拼接时使用的垫片图片下载地址,不填默认用全黑的图片进行视频垫片",
|
586
597
|
"member": "string",
|
587
598
|
"name": "Image",
|
@@ -597,6 +608,7 @@
|
|
597
608
|
"members": [
|
598
609
|
{
|
599
610
|
"default": "",
|
611
|
+
"disabled": false,
|
600
612
|
"document": "应用SdkAppId",
|
601
613
|
"member": "int64",
|
602
614
|
"name": "SdkAppId",
|
@@ -605,6 +617,7 @@
|
|
605
617
|
},
|
606
618
|
{
|
607
619
|
"default": "",
|
620
|
+
"disabled": false,
|
608
621
|
"document": "App名字",
|
609
622
|
"member": "string",
|
610
623
|
"name": "AppName",
|
@@ -613,6 +626,7 @@
|
|
613
626
|
},
|
614
627
|
{
|
615
628
|
"default": "",
|
629
|
+
"disabled": false,
|
616
630
|
"document": "创建IM应用需要的SKey",
|
617
631
|
"member": "string",
|
618
632
|
"name": "SKey",
|
@@ -621,6 +635,7 @@
|
|
621
635
|
},
|
622
636
|
{
|
623
637
|
"default": "",
|
638
|
+
"disabled": false,
|
624
639
|
"document": "创建IM应用需要的TinyId",
|
625
640
|
"member": "string",
|
626
641
|
"name": "TinyId",
|
@@ -629,6 +644,7 @@
|
|
629
644
|
},
|
630
645
|
{
|
631
646
|
"default": "",
|
647
|
+
"disabled": false,
|
632
648
|
"document": "需要绑定的标签列表",
|
633
649
|
"member": "Tag",
|
634
650
|
"name": "TagList",
|
@@ -642,6 +658,7 @@
|
|
642
658
|
"document": "CreateApplication返回参数结构体",
|
643
659
|
"members": [
|
644
660
|
{
|
661
|
+
"disabled": false,
|
645
662
|
"document": "客户的AppId",
|
646
663
|
"member": "int64",
|
647
664
|
"name": "AppId",
|
@@ -649,6 +666,7 @@
|
|
649
666
|
"value_allowed_null": false
|
650
667
|
},
|
651
668
|
{
|
669
|
+
"disabled": false,
|
652
670
|
"document": "App名字",
|
653
671
|
"member": "string",
|
654
672
|
"name": "AppName",
|
@@ -656,6 +674,7 @@
|
|
656
674
|
"value_allowed_null": false
|
657
675
|
},
|
658
676
|
{
|
677
|
+
"disabled": false,
|
659
678
|
"document": "应用SdkAppId",
|
660
679
|
"member": "int64",
|
661
680
|
"name": "SdkAppId",
|
@@ -676,6 +695,7 @@
|
|
676
695
|
"members": [
|
677
696
|
{
|
678
697
|
"default": "",
|
698
|
+
"disabled": false,
|
679
699
|
"document": "客户的SdkAppId",
|
680
700
|
"member": "int64",
|
681
701
|
"name": "SdkAppId",
|
@@ -684,6 +704,7 @@
|
|
684
704
|
},
|
685
705
|
{
|
686
706
|
"default": "",
|
707
|
+
"disabled": false,
|
687
708
|
"document": "录制任务对应的房间号",
|
688
709
|
"member": "int64",
|
689
710
|
"name": "RoomId",
|
@@ -692,6 +713,7 @@
|
|
692
713
|
},
|
693
714
|
{
|
694
715
|
"default": "",
|
716
|
+
"disabled": false,
|
695
717
|
"document": "录制任务对应的群组Id",
|
696
718
|
"member": "string",
|
697
719
|
"name": "GroupId",
|
@@ -700,6 +722,7 @@
|
|
700
722
|
},
|
701
723
|
{
|
702
724
|
"default": "",
|
725
|
+
"disabled": false,
|
703
726
|
"document": "混流参数配置\n目前课后录制暂未支持自定义混流布局Custom参数",
|
704
727
|
"member": "MixStream",
|
705
728
|
"name": "MixStream",
|
@@ -708,6 +731,7 @@
|
|
708
731
|
},
|
709
732
|
{
|
710
733
|
"default": "",
|
734
|
+
"disabled": false,
|
711
735
|
"document": "白板参数配置",
|
712
736
|
"member": "Whiteboard",
|
713
737
|
"name": "Whiteboard",
|
@@ -733,6 +757,7 @@
|
|
733
757
|
"document": "CreatePPTCheckTask请求参数结构体",
|
734
758
|
"members": [
|
735
759
|
{
|
760
|
+
"disabled": false,
|
736
761
|
"document": "客户的SdkAppId",
|
737
762
|
"example": "1400000001",
|
738
763
|
"member": "int64",
|
@@ -741,6 +766,7 @@
|
|
741
766
|
"type": "int"
|
742
767
|
},
|
743
768
|
{
|
769
|
+
"disabled": false,
|
744
770
|
"document": "经过URL编码后的PPT文件地址。URL 编码会将字符转换为可通过因特网传输的格式,例如文档地址为http://example.com/测试.pptx,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pptx。为了提高URL解析的成功率,请对URL进行编码。",
|
745
771
|
"example": "http://example.com/%E6%B5%8B%E8%AF%95.pptx",
|
746
772
|
"member": "string",
|
@@ -749,6 +775,7 @@
|
|
749
775
|
"type": "string"
|
750
776
|
},
|
751
777
|
{
|
778
|
+
"disabled": false,
|
752
779
|
"document": "是否对不支持元素开启自动处理的功能。默认不开启。\n\n在开启自动处理的情况下,会自动进行如下处理:\n1. 墨迹:移除不支持的墨迹(比如使用WPS画的)\n2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页\n3. 已损坏音视频:移除PPT上对损坏音视频的引用",
|
753
780
|
"example": "true",
|
754
781
|
"member": "bool",
|
@@ -763,6 +790,7 @@
|
|
763
790
|
"document": "CreatePPTCheckTask返回参数结构体",
|
764
791
|
"members": [
|
765
792
|
{
|
793
|
+
"disabled": false,
|
766
794
|
"document": "检测任务的唯一标识Id,用于查询该任务的进度以及检测结果",
|
767
795
|
"example": "g6ls63ps49vteb8bk1mb",
|
768
796
|
"member": "string",
|
@@ -784,6 +812,7 @@
|
|
784
812
|
"members": [
|
785
813
|
{
|
786
814
|
"default": "",
|
815
|
+
"disabled": false,
|
787
816
|
"document": "白板相关参数",
|
788
817
|
"example": "无",
|
789
818
|
"member": "SnapshotWhiteboard",
|
@@ -793,6 +822,7 @@
|
|
793
822
|
},
|
794
823
|
{
|
795
824
|
"default": "",
|
825
|
+
"disabled": false,
|
796
826
|
"document": "白板房间 `SdkAppId`",
|
797
827
|
"example": "1400124720",
|
798
828
|
"member": "uint64",
|
@@ -802,6 +832,7 @@
|
|
802
832
|
},
|
803
833
|
{
|
804
834
|
"default": "",
|
835
|
+
"disabled": false,
|
805
836
|
"document": "白板房间号",
|
806
837
|
"example": "1234",
|
807
838
|
"member": "uint64",
|
@@ -811,6 +842,7 @@
|
|
811
842
|
},
|
812
843
|
{
|
813
844
|
"default": "",
|
845
|
+
"disabled": false,
|
814
846
|
"document": "白板板书生成结果通知回调地址",
|
815
847
|
"example": "http://xxx",
|
816
848
|
"member": "string",
|
@@ -820,6 +852,7 @@
|
|
820
852
|
},
|
821
853
|
{
|
822
854
|
"default": "",
|
855
|
+
"disabled": false,
|
823
856
|
"document": "白板板书文件 `COS` 存储参数, 不填默认存储在公共存储桶,公共存储桶的数据仅保存3天",
|
824
857
|
"example": "无",
|
825
858
|
"member": "SnapshotCOS",
|
@@ -829,6 +862,7 @@
|
|
829
862
|
},
|
830
863
|
{
|
831
864
|
"default": "",
|
865
|
+
"disabled": false,
|
832
866
|
"document": "白板板书生成模式,默认为 `AllMarks`。取值说明如下:\n\n`AllMarks` - 全量模式,即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。\n\n`LatestMarksOnly` - 单页去重模式,即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。\n\n(**注意:`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效,否则即使在调用本API是指定了 `LatestMarksOnly` 模式,服务后台会使用默认的 `AllMarks` 模式生成白板板书**)",
|
833
867
|
"example": "AllMarks",
|
834
868
|
"member": "string",
|
@@ -843,6 +877,7 @@
|
|
843
877
|
"document": "CreateSnapshotTask返回参数结构体",
|
844
878
|
"members": [
|
845
879
|
{
|
880
|
+
"disabled": false,
|
846
881
|
"document": "白板板书生成任务ID,只有任务创建成功的时候才会返回此字段",
|
847
882
|
"example": "d1806f20-25b8-4c30-8176-c0832bf84e02",
|
848
883
|
"member": "string",
|
@@ -865,6 +900,7 @@
|
|
865
900
|
"members": [
|
866
901
|
{
|
867
902
|
"default": "",
|
903
|
+
"disabled": false,
|
868
904
|
"document": "客户的SdkAppId",
|
869
905
|
"example": "1400000001",
|
870
906
|
"member": "int64",
|
@@ -874,6 +910,7 @@
|
|
874
910
|
},
|
875
911
|
{
|
876
912
|
"default": "",
|
913
|
+
"disabled": false,
|
877
914
|
"document": "经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。",
|
878
915
|
"example": "https://path/to/document.ppt",
|
879
916
|
"member": "string",
|
@@ -883,6 +920,7 @@
|
|
883
920
|
},
|
884
921
|
{
|
885
922
|
"default": "",
|
923
|
+
"disabled": false,
|
886
924
|
"document": "是否为静态PPT,默认为False;\n如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;",
|
887
925
|
"example": "False",
|
888
926
|
"member": "bool",
|
@@ -892,6 +930,7 @@
|
|
892
930
|
},
|
893
931
|
{
|
894
932
|
"default": "",
|
933
|
+
"disabled": false,
|
895
934
|
"document": "注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率\n\n转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率\n\n示例:1280x720,注意分辨率宽高中间为英文字母\"xyz\"的\"x\"",
|
896
935
|
"example": "960x540",
|
897
936
|
"member": "string",
|
@@ -901,6 +940,7 @@
|
|
901
940
|
},
|
902
941
|
{
|
903
942
|
"default": "",
|
943
|
+
"disabled": false,
|
904
944
|
"document": "动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution",
|
905
945
|
"example": "960x540",
|
906
946
|
"member": "string",
|
@@ -910,6 +950,7 @@
|
|
910
950
|
},
|
911
951
|
{
|
912
952
|
"default": "",
|
953
|
+
"disabled": false,
|
913
954
|
"document": "转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式:\n\nzip: 生成`.zip`压缩包\ntar.gz: 生成`.tar.gz`压缩包",
|
914
955
|
"example": "zip",
|
915
956
|
"member": "string",
|
@@ -919,6 +960,7 @@
|
|
919
960
|
},
|
920
961
|
{
|
921
962
|
"default": "",
|
963
|
+
"disabled": false,
|
922
964
|
"document": "内部参数",
|
923
965
|
"example": "空 ",
|
924
966
|
"member": "string",
|
@@ -928,6 +970,7 @@
|
|
928
970
|
},
|
929
971
|
{
|
930
972
|
"default": "",
|
973
|
+
"disabled": false,
|
931
974
|
"document": "文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:<br/>\n- low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。<br/>\n- 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码\n<br/>\n注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB",
|
932
975
|
"example": "空",
|
933
976
|
"member": "string",
|
@@ -937,6 +980,7 @@
|
|
937
980
|
},
|
938
981
|
{
|
939
982
|
"default": "",
|
983
|
+
"disabled": false,
|
940
984
|
"document": "转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。\n分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。\n\n示例:1280x720,注意分辨率宽高中间为英文字母\"xyz\"的\"x\"",
|
941
985
|
"example": "960x540",
|
942
986
|
"member": "string",
|
@@ -946,6 +990,7 @@
|
|
946
990
|
},
|
947
991
|
{
|
948
992
|
"default": "",
|
993
|
+
"disabled": false,
|
949
994
|
"document": "是否对不支持元素开启自动处理的功能。默认不开启。\n\n在开启自动处理的情况下,会自动进行如下处理:\n1. 墨迹:移除不支持的墨迹(比如使用WPS画的)\n2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页\n3. 已损坏音视频:移除PPT上对损坏音视频的引用",
|
950
995
|
"example": "true",
|
951
996
|
"member": "bool",
|
@@ -960,6 +1005,7 @@
|
|
960
1005
|
"document": "CreateTranscode返回参数结构体",
|
961
1006
|
"members": [
|
962
1007
|
{
|
1008
|
+
"disabled": false,
|
963
1009
|
"document": "文档转码任务的唯一标识Id,用于查询该任务的进度以及转码结果",
|
964
1010
|
"example": "g6ls63ps49vteb8bk1mb",
|
965
1011
|
"member": "string",
|
@@ -982,6 +1028,7 @@
|
|
982
1028
|
"members": [
|
983
1029
|
{
|
984
1030
|
"default": "",
|
1031
|
+
"disabled": false,
|
985
1032
|
"document": "录制任务的TaskId",
|
986
1033
|
"member": "string",
|
987
1034
|
"name": "OnlineRecordTaskId",
|
@@ -990,6 +1037,7 @@
|
|
990
1037
|
},
|
991
1038
|
{
|
992
1039
|
"default": "",
|
1040
|
+
"disabled": false,
|
993
1041
|
"document": "客户的SdkAppId",
|
994
1042
|
"member": "int64",
|
995
1043
|
"name": "SdkAppId",
|
@@ -998,6 +1046,7 @@
|
|
998
1046
|
},
|
999
1047
|
{
|
1000
1048
|
"default": "",
|
1049
|
+
"disabled": false,
|
1001
1050
|
"document": "视频生成的白板参数,例如白板宽高等。\n\n此参数与开始录制接口提供的Whiteboard参数互斥,在本接口与开始录制接口都提供了Whiteboard参数时,优先使用本接口指定的Whiteboard参数进行视频生成,否则使用开始录制接口提供的Whiteboard参数进行视频生成。",
|
1002
1051
|
"member": "Whiteboard",
|
1003
1052
|
"name": "Whiteboard",
|
@@ -1006,6 +1055,7 @@
|
|
1006
1055
|
},
|
1007
1056
|
{
|
1008
1057
|
"default": "",
|
1058
|
+
"disabled": false,
|
1009
1059
|
"document": "视频拼接参数\n\n此参数与开始录制接口提供的Concat参数互斥,在本接口与开始录制接口都提供了Concat参数时,优先使用本接口指定的Concat参数进行视频拼接,否则使用开始录制接口提供的Concat参数进行视频拼接。",
|
1010
1060
|
"member": "Concat",
|
1011
1061
|
"name": "Concat",
|
@@ -1014,6 +1064,7 @@
|
|
1014
1064
|
},
|
1015
1065
|
{
|
1016
1066
|
"default": "",
|
1067
|
+
"disabled": false,
|
1017
1068
|
"document": "视频生成混流参数\n\n此参数与开始录制接口提供的MixStream参数互斥,在本接口与开始录制接口都提供了MixStream参数时,优先使用本接口指定的MixStream参数进行视频混流,否则使用开始录制接口提供的MixStream参数进行视频拼混流。",
|
1018
1069
|
"member": "MixStream",
|
1019
1070
|
"name": "MixStream",
|
@@ -1022,6 +1073,7 @@
|
|
1022
1073
|
},
|
1023
1074
|
{
|
1024
1075
|
"default": "",
|
1076
|
+
"disabled": false,
|
1025
1077
|
"document": "视频生成控制参数,用于更精细地指定需要生成哪些流,某一路流是否禁用音频,是否只录制小画面等\n\n此参数与开始录制接口提供的RecordControl参数互斥,在本接口与开始录制接口都提供了RecordControl参数时,优先使用本接口指定的RecordControl参数进行视频生成控制,否则使用开始录制接口提供的RecordControl参数进行视频拼生成控制。",
|
1026
1078
|
"member": "RecordControl",
|
1027
1079
|
"name": "RecordControl",
|
@@ -1030,6 +1082,7 @@
|
|
1030
1082
|
},
|
1031
1083
|
{
|
1032
1084
|
"default": "",
|
1085
|
+
"disabled": false,
|
1033
1086
|
"document": "内部参数",
|
1034
1087
|
"member": "string",
|
1035
1088
|
"name": "ExtraData",
|
@@ -1043,6 +1096,7 @@
|
|
1043
1096
|
"document": "CreateVideoGenerationTask返回参数结构体",
|
1044
1097
|
"members": [
|
1045
1098
|
{
|
1099
|
+
"disabled": false,
|
1046
1100
|
"document": "视频生成的任务Id",
|
1047
1101
|
"member": "string",
|
1048
1102
|
"name": "TaskId",
|
@@ -1063,6 +1117,7 @@
|
|
1063
1117
|
"members": [
|
1064
1118
|
{
|
1065
1119
|
"default": "",
|
1120
|
+
"disabled": false,
|
1066
1121
|
"document": "混流画布参数",
|
1067
1122
|
"member": "Canvas",
|
1068
1123
|
"name": "Canvas",
|
@@ -1072,6 +1127,7 @@
|
|
1072
1127
|
},
|
1073
1128
|
{
|
1074
1129
|
"default": "",
|
1130
|
+
"disabled": false,
|
1075
1131
|
"document": "流布局参数,每路流的布局不能超出画布区域",
|
1076
1132
|
"member": "StreamLayout",
|
1077
1133
|
"name": "InputStreamList",
|
@@ -1087,6 +1143,7 @@
|
|
1087
1143
|
"members": [
|
1088
1144
|
{
|
1089
1145
|
"default": "",
|
1146
|
+
"disabled": false,
|
1090
1147
|
"document": "时间\n按月格式yyyy-mm\n按天格式yyyy-mm-dd\n按分钟格式 yyyy-mm-dd HH:MM:SS",
|
1091
1148
|
"member": "string",
|
1092
1149
|
"name": "Time",
|
@@ -1096,6 +1153,7 @@
|
|
1096
1153
|
},
|
1097
1154
|
{
|
1098
1155
|
"default": "",
|
1156
|
+
"disabled": false,
|
1099
1157
|
"document": "画图所需要的值",
|
1100
1158
|
"member": "int64",
|
1101
1159
|
"name": "Value",
|
@@ -1105,6 +1163,7 @@
|
|
1105
1163
|
},
|
1106
1164
|
{
|
1107
1165
|
"default": "",
|
1166
|
+
"disabled": false,
|
1108
1167
|
"document": "各个具体指标的详情",
|
1109
1168
|
"member": "Detail",
|
1110
1169
|
"name": "Details",
|
@@ -1120,6 +1179,7 @@
|
|
1120
1179
|
"members": [
|
1121
1180
|
{
|
1122
1181
|
"default": "",
|
1182
|
+
"disabled": false,
|
1123
1183
|
"document": "目前支持的Service为cos:GetService,cdn:DescribeDomainsConfig",
|
1124
1184
|
"member": "string",
|
1125
1185
|
"name": "Service",
|
@@ -1128,6 +1188,7 @@
|
|
1128
1188
|
},
|
1129
1189
|
{
|
1130
1190
|
"default": "",
|
1191
|
+
"disabled": false,
|
1131
1192
|
"document": "JSON格式的请求参数",
|
1132
1193
|
"member": "string",
|
1133
1194
|
"name": "Data",
|
@@ -1141,6 +1202,7 @@
|
|
1141
1202
|
"document": "DescribeAPIService返回参数结构体",
|
1142
1203
|
"members": [
|
1143
1204
|
{
|
1205
|
+
"disabled": false,
|
1144
1206
|
"document": "Json格式的响应数据",
|
1145
1207
|
"member": "string",
|
1146
1208
|
"name": "ResponseData",
|
@@ -1165,6 +1227,7 @@
|
|
1165
1227
|
"document": "DescribeApplicationInfos返回参数结构体",
|
1166
1228
|
"members": [
|
1167
1229
|
{
|
1230
|
+
"disabled": false,
|
1168
1231
|
"document": "应用列表",
|
1169
1232
|
"example": "无",
|
1170
1233
|
"member": "ApplicationItem",
|
@@ -1174,6 +1237,7 @@
|
|
1174
1237
|
"value_allowed_null": false
|
1175
1238
|
},
|
1176
1239
|
{
|
1240
|
+
"disabled": false,
|
1177
1241
|
"document": "是否包含所有的应用,0-不包含,1-包含",
|
1178
1242
|
"example": "1",
|
1179
1243
|
"member": "int64",
|
@@ -1196,6 +1260,7 @@
|
|
1196
1260
|
"members": [
|
1197
1261
|
{
|
1198
1262
|
"default": "",
|
1263
|
+
"disabled": false,
|
1199
1264
|
"document": "用量开始时间(包括该时间点)",
|
1200
1265
|
"example": "2019-10-01 00:00:00",
|
1201
1266
|
"member": "datetime",
|
@@ -1205,6 +1270,7 @@
|
|
1205
1270
|
},
|
1206
1271
|
{
|
1207
1272
|
"default": "",
|
1273
|
+
"disabled": false,
|
1208
1274
|
"document": "用量结束时间(不包括该时间点)",
|
1209
1275
|
"example": "2019-12-31 00:00:00",
|
1210
1276
|
"member": "datetime",
|
@@ -1214,6 +1280,7 @@
|
|
1214
1280
|
},
|
1215
1281
|
{
|
1216
1282
|
"default": "",
|
1283
|
+
"disabled": false,
|
1217
1284
|
"document": "白板子产品名",
|
1218
1285
|
"example": "sp_tiw_ric",
|
1219
1286
|
"member": "string",
|
@@ -1223,6 +1290,7 @@
|
|
1223
1290
|
},
|
1224
1291
|
{
|
1225
1292
|
"default": "",
|
1293
|
+
"disabled": false,
|
1226
1294
|
"document": "时间跨度单位\n- MONTHLY:月\n- DAILY:天\n- MINUTELY:分钟",
|
1227
1295
|
"example": "DAILY",
|
1228
1296
|
"member": "string",
|
@@ -1232,6 +1300,7 @@
|
|
1232
1300
|
},
|
1233
1301
|
{
|
1234
1302
|
"default": "",
|
1303
|
+
"disabled": false,
|
1235
1304
|
"document": "白板应用的SdkAppId",
|
1236
1305
|
"example": "1400000001",
|
1237
1306
|
"member": "int64",
|
@@ -1241,6 +1310,7 @@
|
|
1241
1310
|
},
|
1242
1311
|
{
|
1243
1312
|
"default": "",
|
1313
|
+
"disabled": false,
|
1244
1314
|
"document": "true: 返回加权求和后的用量数据\nfalse: 返回原始用量数据",
|
1245
1315
|
"example": "1",
|
1246
1316
|
"member": "bool",
|
@@ -1255,6 +1325,7 @@
|
|
1255
1325
|
"document": "DescribeApplicationUsage返回参数结构体",
|
1256
1326
|
"members": [
|
1257
1327
|
{
|
1328
|
+
"disabled": false,
|
1258
1329
|
"document": "画图所需的用量数据",
|
1259
1330
|
"example": "无",
|
1260
1331
|
"member": "DataItem",
|
@@ -1277,6 +1348,7 @@
|
|
1277
1348
|
"members": [
|
1278
1349
|
{
|
1279
1350
|
"default": "",
|
1351
|
+
"disabled": false,
|
1280
1352
|
"document": "白板应用的SdkAppId",
|
1281
1353
|
"example": "1400000001",
|
1282
1354
|
"member": "int64",
|
@@ -1286,6 +1358,7 @@
|
|
1286
1358
|
},
|
1287
1359
|
{
|
1288
1360
|
"default": "",
|
1361
|
+
"disabled": false,
|
1289
1362
|
"document": "需要查询日志的白板房间号",
|
1290
1363
|
"example": "10000",
|
1291
1364
|
"member": "string",
|
@@ -1295,6 +1368,7 @@
|
|
1295
1368
|
},
|
1296
1369
|
{
|
1297
1370
|
"default": "",
|
1371
|
+
"disabled": false,
|
1298
1372
|
"document": "需要查询日志的用户ID",
|
1299
1373
|
"example": "tic_web",
|
1300
1374
|
"member": "string",
|
@@ -1304,6 +1378,7 @@
|
|
1304
1378
|
},
|
1305
1379
|
{
|
1306
1380
|
"default": "",
|
1381
|
+
"disabled": false,
|
1307
1382
|
"document": "查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间",
|
1308
1383
|
"example": "[1614519034000,1614691834999]",
|
1309
1384
|
"member": "int64",
|
@@ -1313,6 +1388,7 @@
|
|
1313
1388
|
},
|
1314
1389
|
{
|
1315
1390
|
"default": "",
|
1391
|
+
"disabled": false,
|
1316
1392
|
"document": "聚合日志条数查询的桶的时间范围,如5m, 1h, 4h等",
|
1317
1393
|
"example": "5m",
|
1318
1394
|
"member": "string",
|
@@ -1322,6 +1398,7 @@
|
|
1322
1398
|
},
|
1323
1399
|
{
|
1324
1400
|
"default": "",
|
1401
|
+
"disabled": false,
|
1325
1402
|
"document": "额外的查询条件",
|
1326
1403
|
"example": "action: addData",
|
1327
1404
|
"member": "string",
|
@@ -1331,6 +1408,7 @@
|
|
1331
1408
|
},
|
1332
1409
|
{
|
1333
1410
|
"default": "",
|
1411
|
+
"disabled": false,
|
1334
1412
|
"document": "是否按时间升序排列",
|
1335
1413
|
"example": "false",
|
1336
1414
|
"member": "bool",
|
@@ -1340,6 +1418,7 @@
|
|
1340
1418
|
},
|
1341
1419
|
{
|
1342
1420
|
"default": "",
|
1421
|
+
"disabled": false,
|
1343
1422
|
"document": "用于递归拉取的上下文Key,在上一次请求中返回",
|
1344
1423
|
"example": "空",
|
1345
1424
|
"member": "string",
|
@@ -1354,6 +1433,7 @@
|
|
1354
1433
|
"document": "DescribeBoardSDKLog返回参数结构体",
|
1355
1434
|
"members": [
|
1356
1435
|
{
|
1436
|
+
"disabled": false,
|
1357
1437
|
"document": "总共能查到日志条数",
|
1358
1438
|
"example": "65",
|
1359
1439
|
"member": "int64",
|
@@ -1363,6 +1443,7 @@
|
|
1363
1443
|
"value_allowed_null": false
|
1364
1444
|
},
|
1365
1445
|
{
|
1446
|
+
"disabled": false,
|
1366
1447
|
"document": "日志详细内容",
|
1367
1448
|
"example": "[]",
|
1368
1449
|
"member": "string",
|
@@ -1372,6 +1453,7 @@
|
|
1372
1453
|
"value_allowed_null": false
|
1373
1454
|
},
|
1374
1455
|
{
|
1456
|
+
"disabled": false,
|
1375
1457
|
"document": "按时间段聚合后每个时间段的日志条数",
|
1376
1458
|
"example": "[]",
|
1377
1459
|
"member": "string",
|
@@ -1381,6 +1463,7 @@
|
|
1381
1463
|
"value_allowed_null": false
|
1382
1464
|
},
|
1383
1465
|
{
|
1466
|
+
"disabled": false,
|
1384
1467
|
"document": "用于递归拉取的上下文Key,下一次请求的时候带上",
|
1385
1468
|
"example": "空",
|
1386
1469
|
"member": "string",
|
@@ -1420,6 +1503,7 @@
|
|
1420
1503
|
"members": [
|
1421
1504
|
{
|
1422
1505
|
"default": "",
|
1506
|
+
"disabled": false,
|
1423
1507
|
"document": "应用的SdkAppId",
|
1424
1508
|
"member": "int64",
|
1425
1509
|
"name": "SdkAppId",
|
@@ -1446,6 +1530,7 @@
|
|
1446
1530
|
"members": [
|
1447
1531
|
{
|
1448
1532
|
"default": "",
|
1533
|
+
"disabled": false,
|
1449
1534
|
"document": "客户的SdkAppId",
|
1450
1535
|
"member": "int64",
|
1451
1536
|
"name": "SdkAppId",
|
@@ -1454,6 +1539,7 @@
|
|
1454
1539
|
},
|
1455
1540
|
{
|
1456
1541
|
"default": "",
|
1542
|
+
"disabled": false,
|
1457
1543
|
"document": "课后录制任务的Id",
|
1458
1544
|
"member": "string",
|
1459
1545
|
"name": "TaskId",
|
@@ -1480,6 +1566,7 @@
|
|
1480
1566
|
"members": [
|
1481
1567
|
{
|
1482
1568
|
"default": "",
|
1569
|
+
"disabled": false,
|
1483
1570
|
"document": "应用的SdkAppId",
|
1484
1571
|
"example": "1400000001",
|
1485
1572
|
"member": "int64",
|
@@ -1494,6 +1581,7 @@
|
|
1494
1581
|
"document": "DescribeOnlineRecordCallback返回参数结构体",
|
1495
1582
|
"members": [
|
1496
1583
|
{
|
1584
|
+
"disabled": false,
|
1497
1585
|
"document": "实时录制事件回调地址,如果未设置回调地址,该字段为空字符串",
|
1498
1586
|
"example": "https://example.com/online/callback",
|
1499
1587
|
"member": "string",
|
@@ -1503,6 +1591,7 @@
|
|
1503
1591
|
"value_allowed_null": false
|
1504
1592
|
},
|
1505
1593
|
{
|
1594
|
+
"disabled": false,
|
1506
1595
|
"document": "实时录制回调鉴权密钥",
|
1507
1596
|
"example": "6vg9G7Fd",
|
1508
1597
|
"member": "string",
|
@@ -1525,6 +1614,7 @@
|
|
1525
1614
|
"members": [
|
1526
1615
|
{
|
1527
1616
|
"default": "",
|
1617
|
+
"disabled": false,
|
1528
1618
|
"document": "客户的SdkAppId",
|
1529
1619
|
"example": "1400000001",
|
1530
1620
|
"member": "int64",
|
@@ -1534,6 +1624,7 @@
|
|
1534
1624
|
},
|
1535
1625
|
{
|
1536
1626
|
"default": "",
|
1627
|
+
"disabled": false,
|
1537
1628
|
"document": "实时录制任务Id",
|
1538
1629
|
"example": "ghucnligqtgtvk2624mb",
|
1539
1630
|
"member": "string",
|
@@ -1548,6 +1639,7 @@
|
|
1548
1639
|
"document": "DescribeOnlineRecord返回参数结构体",
|
1549
1640
|
"members": [
|
1550
1641
|
{
|
1642
|
+
"disabled": false,
|
1551
1643
|
"document": "录制结束原因,\n- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制\n- USER_CALL: 主动调用了停止录制接口\n- EXCEPTION: 录制异常结束\n- FORCE_STOP: 强制停止录制,一般是因为暂停超过90分钟或者录制总时长超过24小时。",
|
1552
1644
|
"example": "USER_CALL",
|
1553
1645
|
"member": "string",
|
@@ -1557,6 +1649,7 @@
|
|
1557
1649
|
"value_allowed_null": false
|
1558
1650
|
},
|
1559
1651
|
{
|
1652
|
+
"disabled": false,
|
1560
1653
|
"document": "需要查询结果的录制任务Id",
|
1561
1654
|
"example": "ghucnligqtgtvk2624mb",
|
1562
1655
|
"member": "string",
|
@@ -1566,6 +1659,7 @@
|
|
1566
1659
|
"value_allowed_null": false
|
1567
1660
|
},
|
1568
1661
|
{
|
1662
|
+
"disabled": false,
|
1569
1663
|
"document": "录制任务状态\n- PREPARED: 表示录制正在准备中(进房/启动录制服务等操作)\n- RECORDING: 表示录制已开始\n- PAUSED: 表示录制已暂停\n- STOPPED: 表示录制已停止,正在处理并上传视频\n- FINISHED: 表示视频处理并上传完成,成功生成录制结果",
|
1570
1664
|
"example": "FINISHED",
|
1571
1665
|
"member": "string",
|
@@ -1575,6 +1669,7 @@
|
|
1575
1669
|
"value_allowed_null": false
|
1576
1670
|
},
|
1577
1671
|
{
|
1672
|
+
"disabled": false,
|
1578
1673
|
"document": "房间号",
|
1579
1674
|
"example": "880528",
|
1580
1675
|
"member": "int64",
|
@@ -1584,6 +1679,7 @@
|
|
1584
1679
|
"value_allowed_null": false
|
1585
1680
|
},
|
1586
1681
|
{
|
1682
|
+
"disabled": false,
|
1587
1683
|
"document": "白板的群组 Id",
|
1588
1684
|
"example": "880528",
|
1589
1685
|
"member": "string",
|
@@ -1593,6 +1689,7 @@
|
|
1593
1689
|
"value_allowed_null": false
|
1594
1690
|
},
|
1595
1691
|
{
|
1692
|
+
"disabled": false,
|
1596
1693
|
"document": "录制用户Id",
|
1597
1694
|
"example": "tic_record_user_880528_test-01",
|
1598
1695
|
"member": "string",
|
@@ -1602,6 +1699,7 @@
|
|
1602
1699
|
"value_allowed_null": false
|
1603
1700
|
},
|
1604
1701
|
{
|
1702
|
+
"disabled": false,
|
1605
1703
|
"document": "实际开始录制时间,Unix 时间戳,单位秒",
|
1606
1704
|
"example": "1568949369",
|
1607
1705
|
"member": "int64",
|
@@ -1611,6 +1709,7 @@
|
|
1611
1709
|
"value_allowed_null": false
|
1612
1710
|
},
|
1613
1711
|
{
|
1712
|
+
"disabled": false,
|
1614
1713
|
"document": "实际停止录制时间,Unix 时间戳,单位秒",
|
1615
1714
|
"example": "1568949392",
|
1616
1715
|
"member": "int64",
|
@@ -1620,6 +1719,7 @@
|
|
1620
1719
|
"value_allowed_null": false
|
1621
1720
|
},
|
1622
1721
|
{
|
1722
|
+
"disabled": false,
|
1623
1723
|
"document": "回放视频总时长(单位:毫秒)",
|
1624
1724
|
"example": "18317",
|
1625
1725
|
"member": "int64",
|
@@ -1629,6 +1729,7 @@
|
|
1629
1729
|
"value_allowed_null": false
|
1630
1730
|
},
|
1631
1731
|
{
|
1732
|
+
"disabled": false,
|
1632
1733
|
"document": "录制过程中出现异常的次数",
|
1633
1734
|
"example": "0",
|
1634
1735
|
"member": "int64",
|
@@ -1638,6 +1739,7 @@
|
|
1638
1739
|
"value_allowed_null": false
|
1639
1740
|
},
|
1640
1741
|
{
|
1742
|
+
"disabled": false,
|
1641
1743
|
"document": "拼接视频中被忽略的时间段,只有开启视频拼接功能的时候,这个参数才是有效的",
|
1642
1744
|
"example": "无",
|
1643
1745
|
"member": "OmittedDuration",
|
@@ -1647,6 +1749,7 @@
|
|
1647
1749
|
"value_allowed_null": false
|
1648
1750
|
},
|
1649
1751
|
{
|
1752
|
+
"disabled": false,
|
1650
1753
|
"document": "录制视频列表",
|
1651
1754
|
"example": "无",
|
1652
1755
|
"member": "VideoInfo",
|
@@ -1656,6 +1759,7 @@
|
|
1656
1759
|
"value_allowed_null": false
|
1657
1760
|
},
|
1658
1761
|
{
|
1762
|
+
"disabled": false,
|
1659
1763
|
"document": "回放URL,需配合信令播放器使用。此字段仅适用于`视频生成模式`\n注意:此字段可能返回 null,表示取不到有效值。",
|
1660
1764
|
"example": "http://replayurl",
|
1661
1765
|
"member": "string",
|
@@ -1665,6 +1769,7 @@
|
|
1665
1769
|
"value_allowed_null": true
|
1666
1770
|
},
|
1667
1771
|
{
|
1772
|
+
"disabled": false,
|
1668
1773
|
"document": "视频流在录制过程中断流次数\n注意:此字段可能返回 null,表示取不到有效值。",
|
1669
1774
|
"example": "无",
|
1670
1775
|
"member": "Interrupt",
|
@@ -1686,6 +1791,7 @@
|
|
1686
1791
|
"document": "DescribePPTCheckCallback请求参数结构体",
|
1687
1792
|
"members": [
|
1688
1793
|
{
|
1794
|
+
"disabled": false,
|
1689
1795
|
"document": "应用的SdkAppId",
|
1690
1796
|
"example": "1400000001",
|
1691
1797
|
"member": "int64",
|
@@ -1700,6 +1806,7 @@
|
|
1700
1806
|
"document": "DescribePPTCheckCallback返回参数结构体",
|
1701
1807
|
"members": [
|
1702
1808
|
{
|
1809
|
+
"disabled": false,
|
1703
1810
|
"document": "回调地址",
|
1704
1811
|
"example": "https://example.com/transcode/callback",
|
1705
1812
|
"member": "string",
|
@@ -1708,6 +1815,7 @@
|
|
1708
1815
|
"value_allowed_null": false
|
1709
1816
|
},
|
1710
1817
|
{
|
1818
|
+
"disabled": false,
|
1711
1819
|
"document": "回调鉴权密钥",
|
1712
1820
|
"example": "6vg9G7Fd",
|
1713
1821
|
"member": "string",
|
@@ -1728,6 +1836,7 @@
|
|
1728
1836
|
"document": "DescribePPTCheck请求参数结构体",
|
1729
1837
|
"members": [
|
1730
1838
|
{
|
1839
|
+
"disabled": false,
|
1731
1840
|
"document": "客户的SdkAppId",
|
1732
1841
|
"example": "1400000001",
|
1733
1842
|
"member": "int64",
|
@@ -1736,6 +1845,7 @@
|
|
1736
1845
|
"type": "int"
|
1737
1846
|
},
|
1738
1847
|
{
|
1848
|
+
"disabled": false,
|
1739
1849
|
"document": "任务的唯一标识Id",
|
1740
1850
|
"example": "g0jb42ps49vtebjshilb",
|
1741
1851
|
"member": "string",
|
@@ -1750,6 +1860,7 @@
|
|
1750
1860
|
"document": "DescribePPTCheck返回参数结构体",
|
1751
1861
|
"members": [
|
1752
1862
|
{
|
1863
|
+
"disabled": false,
|
1753
1864
|
"document": "任务的唯一标识Id",
|
1754
1865
|
"example": "0agdnligqtgtvkm65emb",
|
1755
1866
|
"member": "string",
|
@@ -1758,6 +1869,7 @@
|
|
1758
1869
|
"value_allowed_null": false
|
1759
1870
|
},
|
1760
1871
|
{
|
1872
|
+
"disabled": false,
|
1761
1873
|
"document": "PPT文件是否正常",
|
1762
1874
|
"example": "false",
|
1763
1875
|
"member": "bool",
|
@@ -1766,6 +1878,7 @@
|
|
1766
1878
|
"value_allowed_null": false
|
1767
1879
|
},
|
1768
1880
|
{
|
1881
|
+
"disabled": false,
|
1769
1882
|
"document": "修复后的PPT URL,只有创建任务时参数AutoHandleUnsupportedElement=true,才返回此参数\n注意:此字段可能返回 null,表示取不到有效值。",
|
1770
1883
|
"example": "https://xxx/xxx/测试_fixed.ppt",
|
1771
1884
|
"member": "string",
|
@@ -1774,6 +1887,7 @@
|
|
1774
1887
|
"value_allowed_null": true
|
1775
1888
|
},
|
1776
1889
|
{
|
1890
|
+
"disabled": false,
|
1777
1891
|
"document": "错误PPT页面列表\n注意:此字段可能返回 null,表示取不到有效值。",
|
1778
1892
|
"example": "无",
|
1779
1893
|
"member": "PPTErrSlide",
|
@@ -1782,6 +1896,7 @@
|
|
1782
1896
|
"value_allowed_null": true
|
1783
1897
|
},
|
1784
1898
|
{
|
1899
|
+
"disabled": false,
|
1785
1900
|
"document": "任务的当前状态 - QUEUED: 正在排队等待 - PROCESSING: 执行中 - FINISHED: 执行完成\t",
|
1786
1901
|
"example": "FINISHED",
|
1787
1902
|
"member": "string",
|
@@ -1790,6 +1905,7 @@
|
|
1790
1905
|
"value_allowed_null": false
|
1791
1906
|
},
|
1792
1907
|
{
|
1908
|
+
"disabled": false,
|
1793
1909
|
"document": "当前进度,取值范围为0~100",
|
1794
1910
|
"example": "100",
|
1795
1911
|
"member": "int64",
|
@@ -1811,6 +1927,7 @@
|
|
1811
1927
|
"members": [
|
1812
1928
|
{
|
1813
1929
|
"default": "",
|
1930
|
+
"disabled": false,
|
1814
1931
|
"document": "开始时间",
|
1815
1932
|
"member": "datetime",
|
1816
1933
|
"name": "BeginTime",
|
@@ -1819,6 +1936,7 @@
|
|
1819
1936
|
},
|
1820
1937
|
{
|
1821
1938
|
"default": "",
|
1939
|
+
"disabled": false,
|
1822
1940
|
"document": "结束时间",
|
1823
1941
|
"member": "datetime",
|
1824
1942
|
"name": "EndTime",
|
@@ -1845,6 +1963,7 @@
|
|
1845
1963
|
"members": [
|
1846
1964
|
{
|
1847
1965
|
"default": "",
|
1966
|
+
"disabled": false,
|
1848
1967
|
"document": "白板应用的SdkAppId",
|
1849
1968
|
"example": "1400000001",
|
1850
1969
|
"member": "int64",
|
@@ -1854,6 +1973,7 @@
|
|
1854
1973
|
},
|
1855
1974
|
{
|
1856
1975
|
"default": "",
|
1976
|
+
"disabled": false,
|
1857
1977
|
"document": "开始时间,Unix时间戳,单位秒,时间跨度不能超过7天",
|
1858
1978
|
"example": "1614691834",
|
1859
1979
|
"member": "int64",
|
@@ -1863,6 +1983,7 @@
|
|
1863
1983
|
},
|
1864
1984
|
{
|
1865
1985
|
"default": "",
|
1986
|
+
"disabled": false,
|
1866
1987
|
"document": "结束时间,Unix时间戳,单位秒,时间跨度不能超过7天",
|
1867
1988
|
"example": "1614691834",
|
1868
1989
|
"member": "int64",
|
@@ -1872,6 +1993,7 @@
|
|
1872
1993
|
},
|
1873
1994
|
{
|
1874
1995
|
"default": "",
|
1996
|
+
"disabled": false,
|
1875
1997
|
"document": "查询的指标,目前支持以下值\n - image_load_total_count: 图片加载总数(单位,次)\n - image_load_fail_count: 图片加载失败数量(单位,次)\n - image_load_success_rate: 图片加载成功率(百分比)\n - ppt_load_total_count: PPT加载总数(单位,次)\n - ppt_load_fail_count: PPT加载失败总数(单位,次)\n - ppt_load_success_rate: PPT加载成功率(单位,百分比)\n - verify_sdk_total_count: 白板鉴权总次数(单位,次)\n - verify_sdk_fail_count: 白板鉴权失败次数(单位,次)\n - verify_sdk_success_rate: 白板鉴权成功率(单位,百分比)\n - verify_sdk_in_one_second_rate: 白板鉴权秒开率(单位,百分比)\n - verify_sdk_cost_avg: 白板鉴权耗时平均时间(单位,毫秒)",
|
1876
1998
|
"example": "image_load_success_rate",
|
1877
1999
|
"member": "string",
|
@@ -1881,6 +2003,7 @@
|
|
1881
2003
|
},
|
1882
2004
|
{
|
1883
2005
|
"default": "",
|
2006
|
+
"disabled": false,
|
1884
2007
|
"document": "聚合的时间维度,目前只支持1小时,输入值为\"1h\"",
|
1885
2008
|
"example": "1h",
|
1886
2009
|
"member": "string",
|
@@ -1895,6 +2018,7 @@
|
|
1895
2018
|
"document": "DescribeQualityMetrics返回参数结构体",
|
1896
2019
|
"members": [
|
1897
2020
|
{
|
2021
|
+
"disabled": false,
|
1898
2022
|
"document": "输入的查询指标",
|
1899
2023
|
"example": "image_load_success_rate",
|
1900
2024
|
"member": "string",
|
@@ -1904,6 +2028,7 @@
|
|
1904
2028
|
"value_allowed_null": false
|
1905
2029
|
},
|
1906
2030
|
{
|
2031
|
+
"disabled": false,
|
1907
2032
|
"document": "时间序列",
|
1908
2033
|
"example": "无",
|
1909
2034
|
"member": "TimeValue",
|
@@ -1930,6 +2055,7 @@
|
|
1930
2055
|
"document": "DescribeRecordSearch返回参数结构体",
|
1931
2056
|
"members": [
|
1932
2057
|
{
|
2058
|
+
"disabled": false,
|
1933
2059
|
"document": "录制任务搜索结果集合",
|
1934
2060
|
"example": "无",
|
1935
2061
|
"member": "RecordTaskSearchResult",
|
@@ -1939,6 +2065,7 @@
|
|
1939
2065
|
"value_allowed_null": false
|
1940
2066
|
},
|
1941
2067
|
{
|
2068
|
+
"disabled": false,
|
1942
2069
|
"document": "录制总任务数",
|
1943
2070
|
"example": "151",
|
1944
2071
|
"member": "int64",
|
@@ -1961,6 +2088,7 @@
|
|
1961
2088
|
"members": [
|
1962
2089
|
{
|
1963
2090
|
"default": "",
|
2091
|
+
"disabled": false,
|
1964
2092
|
"document": "白板应用的SdkAppId",
|
1965
2093
|
"example": "1400000001",
|
1966
2094
|
"member": "int64",
|
@@ -1970,6 +2098,7 @@
|
|
1970
2098
|
},
|
1971
2099
|
{
|
1972
2100
|
"default": "",
|
2101
|
+
"disabled": false,
|
1973
2102
|
"document": "查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间",
|
1974
2103
|
"example": "[1614519034000,1614691834999]",
|
1975
2104
|
"member": "int64",
|
@@ -1979,6 +2108,7 @@
|
|
1979
2108
|
},
|
1980
2109
|
{
|
1981
2110
|
"default": "",
|
2111
|
+
"disabled": false,
|
1982
2112
|
"document": "额外的查询条件",
|
1983
2113
|
"example": "action: addData",
|
1984
2114
|
"member": "string",
|
@@ -1988,6 +2118,7 @@
|
|
1988
2118
|
},
|
1989
2119
|
{
|
1990
2120
|
"default": "",
|
2121
|
+
"disabled": false,
|
1991
2122
|
"document": "返回最大的数据条数,默认1000",
|
1992
2123
|
"example": "1000",
|
1993
2124
|
"member": "int64",
|
@@ -2002,6 +2133,7 @@
|
|
2002
2133
|
"document": "DescribeRoomList返回参数结构体",
|
2003
2134
|
"members": [
|
2004
2135
|
{
|
2136
|
+
"disabled": false,
|
2005
2137
|
"document": "白板房间列表",
|
2006
2138
|
"example": "[]",
|
2007
2139
|
"member": "RoomListItem",
|
@@ -2023,6 +2155,7 @@
|
|
2023
2155
|
"document": "DescribeRunningTasks请求参数结构体",
|
2024
2156
|
"members": [
|
2025
2157
|
{
|
2158
|
+
"disabled": false,
|
2026
2159
|
"document": "应用的SdkAppID",
|
2027
2160
|
"example": "1400000001",
|
2028
2161
|
"member": "int64",
|
@@ -2031,6 +2164,7 @@
|
|
2031
2164
|
"type": "int"
|
2032
2165
|
},
|
2033
2166
|
{
|
2167
|
+
"disabled": false,
|
2034
2168
|
"document": "指定需要获取的任务类型。\n有效取值如下:\n- TranscodeH5: 动态转码任务,文档转HTML5页面\n- TranscodeJPG: 静态转码任务,文档转图片\n- WhiteboardPush: 白板推流任务\n- OnlineRecord: 实时录制任务",
|
2035
2169
|
"example": "WhiteboardPush",
|
2036
2170
|
"member": "string",
|
@@ -2039,6 +2173,7 @@
|
|
2039
2173
|
"type": "string"
|
2040
2174
|
},
|
2041
2175
|
{
|
2176
|
+
"disabled": false,
|
2042
2177
|
"document": "分页获取时的任务偏移量,默认为0。",
|
2043
2178
|
"example": "0",
|
2044
2179
|
"member": "int64",
|
@@ -2047,6 +2182,7 @@
|
|
2047
2182
|
"type": "int"
|
2048
2183
|
},
|
2049
2184
|
{
|
2185
|
+
"disabled": false,
|
2050
2186
|
"document": "每次获取任务列表时最大获取任务数,默认值为100。\n有效取值范围:[1, 500]",
|
2051
2187
|
"example": "100",
|
2052
2188
|
"member": "int64",
|
@@ -2061,6 +2197,7 @@
|
|
2061
2197
|
"document": "DescribeRunningTasks返回参数结构体",
|
2062
2198
|
"members": [
|
2063
2199
|
{
|
2200
|
+
"disabled": false,
|
2064
2201
|
"document": "当前正在执行中的任务总数",
|
2065
2202
|
"example": "1",
|
2066
2203
|
"member": "int64",
|
@@ -2069,6 +2206,7 @@
|
|
2069
2206
|
"value_allowed_null": false
|
2070
2207
|
},
|
2071
2208
|
{
|
2209
|
+
"disabled": false,
|
2072
2210
|
"document": "任务信息列表",
|
2073
2211
|
"example": "无",
|
2074
2212
|
"member": "RunningTaskItem",
|
@@ -2090,6 +2228,7 @@
|
|
2090
2228
|
"members": [
|
2091
2229
|
{
|
2092
2230
|
"default": "",
|
2231
|
+
"disabled": false,
|
2093
2232
|
"document": "查询任务ID",
|
2094
2233
|
"example": "f2e1728c-6e87-4481-abe1-cde8542a5a10",
|
2095
2234
|
"member": "string",
|
@@ -2099,6 +2238,7 @@
|
|
2099
2238
|
},
|
2100
2239
|
{
|
2101
2240
|
"default": "",
|
2241
|
+
"disabled": false,
|
2102
2242
|
"document": "任务SdkAppId",
|
2103
2243
|
"example": "1400124720",
|
2104
2244
|
"member": "uint64",
|
@@ -2113,6 +2253,7 @@
|
|
2113
2253
|
"document": "DescribeSnapshotTask返回参数结构体",
|
2114
2254
|
"members": [
|
2115
2255
|
{
|
2256
|
+
"disabled": false,
|
2116
2257
|
"document": "任务ID\n注意:此字段可能返回 null,表示取不到有效值。",
|
2117
2258
|
"example": "f2e1728c-6e87-4481-abe1-cde8542a5a10",
|
2118
2259
|
"member": "string",
|
@@ -2122,6 +2263,7 @@
|
|
2122
2263
|
"value_allowed_null": true
|
2123
2264
|
},
|
2124
2265
|
{
|
2266
|
+
"disabled": false,
|
2125
2267
|
"document": "任务状态\nRunning - 任务执行中\nFinished - 任务已结束\n注意:此字段可能返回 null,表示取不到有效值。",
|
2126
2268
|
"example": "Finished",
|
2127
2269
|
"member": "string",
|
@@ -2131,6 +2273,7 @@
|
|
2131
2273
|
"value_allowed_null": true
|
2132
2274
|
},
|
2133
2275
|
{
|
2276
|
+
"disabled": false,
|
2134
2277
|
"document": "任务创建时间,单位s\n注意:此字段可能返回 null,表示取不到有效值。",
|
2135
2278
|
"example": "1620982173",
|
2136
2279
|
"member": "uint64",
|
@@ -2140,6 +2283,7 @@
|
|
2140
2283
|
"value_allowed_null": true
|
2141
2284
|
},
|
2142
2285
|
{
|
2286
|
+
"disabled": false,
|
2143
2287
|
"document": "任务完成时间,单位s\n注意:此字段可能返回 null,表示取不到有效值。",
|
2144
2288
|
"example": "1621082195",
|
2145
2289
|
"member": "uint64",
|
@@ -2149,6 +2293,7 @@
|
|
2149
2293
|
"value_allowed_null": true
|
2150
2294
|
},
|
2151
2295
|
{
|
2296
|
+
"disabled": false,
|
2152
2297
|
"document": "任务结果信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
2153
2298
|
"example": "无",
|
2154
2299
|
"member": "SnapshotResult",
|
@@ -2171,6 +2316,7 @@
|
|
2171
2316
|
"members": [
|
2172
2317
|
{
|
2173
2318
|
"default": "",
|
2319
|
+
"disabled": false,
|
2174
2320
|
"document": "互动白板应用SdkAppId",
|
2175
2321
|
"example": "1400000001",
|
2176
2322
|
"member": "int64",
|
@@ -2180,6 +2326,7 @@
|
|
2180
2326
|
},
|
2181
2327
|
{
|
2182
2328
|
"default": "",
|
2329
|
+
"disabled": false,
|
2183
2330
|
"document": "需要查询的子产品用量,支持传入以下值\n- sp_tiw_board: 互动白板时长,单位为分钟\n- sp_tiw_dt: 动态转码页数,单位页\n- sp_tiw_st: 静态转码页数,单位页\n- sp_tiw_ric: 实时录制时长,单位分钟\n\n注意:动态转码以1:8的比例计算文档转码页数,静态转码以1:1的比例计算文档转码页数",
|
2184
2331
|
"example": "sp_tiw_board",
|
2185
2332
|
"member": "string",
|
@@ -2189,6 +2336,7 @@
|
|
2189
2336
|
},
|
2190
2337
|
{
|
2191
2338
|
"default": "",
|
2339
|
+
"disabled": false,
|
2192
2340
|
"document": "开始时间,格式YYYY-MM-DD,查询结果里包括该天数据",
|
2193
2341
|
"example": "2021-10-01",
|
2194
2342
|
"member": "date",
|
@@ -2198,6 +2346,7 @@
|
|
2198
2346
|
},
|
2199
2347
|
{
|
2200
2348
|
"default": "",
|
2349
|
+
"disabled": false,
|
2201
2350
|
"document": "结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。",
|
2202
2351
|
"example": "2021-10-31",
|
2203
2352
|
"member": "date",
|
@@ -2212,6 +2361,7 @@
|
|
2212
2361
|
"document": "DescribeTIWDailyUsage返回参数结构体",
|
2213
2362
|
"members": [
|
2214
2363
|
{
|
2364
|
+
"disabled": false,
|
2215
2365
|
"document": "指定区间指定产品的用量汇总",
|
2216
2366
|
"example": "无",
|
2217
2367
|
"member": "UsageDataItem",
|
@@ -2234,6 +2384,7 @@
|
|
2234
2384
|
"members": [
|
2235
2385
|
{
|
2236
2386
|
"default": "",
|
2387
|
+
"disabled": false,
|
2237
2388
|
"document": "互动白板应用SdkAppId",
|
2238
2389
|
"example": "1400000001",
|
2239
2390
|
"member": "int64",
|
@@ -2243,6 +2394,7 @@
|
|
2243
2394
|
},
|
2244
2395
|
{
|
2245
2396
|
"default": "",
|
2397
|
+
"disabled": false,
|
2246
2398
|
"document": "需要查询的子产品用量,支持传入以下值\n- sp_tiw_board: 互动白板时长,单位为分钟\n- sp_tiw_ric: 实时录制时长,单位分钟",
|
2247
2399
|
"example": "sp_tiw_board",
|
2248
2400
|
"member": "string",
|
@@ -2252,6 +2404,7 @@
|
|
2252
2404
|
},
|
2253
2405
|
{
|
2254
2406
|
"default": "",
|
2407
|
+
"disabled": false,
|
2255
2408
|
"document": "开始时间,格式YYYY-MM-DD,查询结果里包括该天数据",
|
2256
2409
|
"example": "2021-10-01",
|
2257
2410
|
"member": "date",
|
@@ -2261,6 +2414,7 @@
|
|
2261
2414
|
},
|
2262
2415
|
{
|
2263
2416
|
"default": "",
|
2417
|
+
"disabled": false,
|
2264
2418
|
"document": "结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。",
|
2265
2419
|
"example": "2021-10-31",
|
2266
2420
|
"member": "date",
|
@@ -2270,6 +2424,7 @@
|
|
2270
2424
|
},
|
2271
2425
|
{
|
2272
2426
|
"default": "",
|
2427
|
+
"disabled": false,
|
2273
2428
|
"document": "需要查询的房间ID列表,不填默认查询全部房间",
|
2274
2429
|
"example": "无",
|
2275
2430
|
"member": "uint64",
|
@@ -2279,6 +2434,7 @@
|
|
2279
2434
|
},
|
2280
2435
|
{
|
2281
2436
|
"default": "",
|
2437
|
+
"disabled": false,
|
2282
2438
|
"document": "查询偏移量,默认为0",
|
2283
2439
|
"example": "0",
|
2284
2440
|
"member": "uint64",
|
@@ -2288,6 +2444,7 @@
|
|
2288
2444
|
},
|
2289
2445
|
{
|
2290
2446
|
"default": "",
|
2447
|
+
"disabled": false,
|
2291
2448
|
"document": "每次查询返回条目限制,默认为20",
|
2292
2449
|
"example": "20",
|
2293
2450
|
"member": "uint64",
|
@@ -2302,6 +2459,7 @@
|
|
2302
2459
|
"document": "DescribeTIWRoomDailyUsage返回参数结构体",
|
2303
2460
|
"members": [
|
2304
2461
|
{
|
2462
|
+
"disabled": false,
|
2305
2463
|
"document": "指定区间指定产品的房间用量列表",
|
2306
2464
|
"example": "无",
|
2307
2465
|
"member": "RoomUsageDataItem",
|
@@ -2311,6 +2469,7 @@
|
|
2311
2469
|
"value_allowed_null": false
|
2312
2470
|
},
|
2313
2471
|
{
|
2472
|
+
"disabled": false,
|
2314
2473
|
"document": "用量列表总数",
|
2315
2474
|
"example": "10",
|
2316
2475
|
"member": "uint64",
|
@@ -2333,6 +2492,7 @@
|
|
2333
2492
|
"members": [
|
2334
2493
|
{
|
2335
2494
|
"default": "",
|
2495
|
+
"disabled": false,
|
2336
2496
|
"document": "应用的SdkAppId",
|
2337
2497
|
"example": "1400000001",
|
2338
2498
|
"member": "int64",
|
@@ -2347,6 +2507,7 @@
|
|
2347
2507
|
"document": "DescribeTranscodeCallback返回参数结构体",
|
2348
2508
|
"members": [
|
2349
2509
|
{
|
2510
|
+
"disabled": false,
|
2350
2511
|
"document": "文档转码回调地址",
|
2351
2512
|
"example": "https://example.com/transcode/callback",
|
2352
2513
|
"member": "string",
|
@@ -2356,6 +2517,7 @@
|
|
2356
2517
|
"value_allowed_null": false
|
2357
2518
|
},
|
2358
2519
|
{
|
2520
|
+
"disabled": false,
|
2359
2521
|
"document": "文档转码回调鉴权密钥",
|
2360
2522
|
"example": "6vg9G7Fd",
|
2361
2523
|
"member": "string",
|
@@ -2377,6 +2539,7 @@
|
|
2377
2539
|
"document": "DescribeTranscode请求参数结构体",
|
2378
2540
|
"members": [
|
2379
2541
|
{
|
2542
|
+
"disabled": false,
|
2380
2543
|
"document": "客户的SdkAppId",
|
2381
2544
|
"example": "1400000001",
|
2382
2545
|
"member": "int64",
|
@@ -2385,6 +2548,7 @@
|
|
2385
2548
|
"type": "int"
|
2386
2549
|
},
|
2387
2550
|
{
|
2551
|
+
"disabled": false,
|
2388
2552
|
"document": "文档转码任务的唯一标识Id",
|
2389
2553
|
"example": "g0jb42ps49vtebjshilb",
|
2390
2554
|
"member": "string",
|
@@ -2399,6 +2563,7 @@
|
|
2399
2563
|
"document": "DescribeTranscode返回参数结构体",
|
2400
2564
|
"members": [
|
2401
2565
|
{
|
2566
|
+
"disabled": false,
|
2402
2567
|
"document": "文档的总页数",
|
2403
2568
|
"example": "1",
|
2404
2569
|
"member": "int64",
|
@@ -2407,6 +2572,7 @@
|
|
2407
2572
|
"value_allowed_null": false
|
2408
2573
|
},
|
2409
2574
|
{
|
2575
|
+
"disabled": false,
|
2410
2576
|
"document": "转码的当前进度,取值范围为0~100",
|
2411
2577
|
"example": "100",
|
2412
2578
|
"member": "int64",
|
@@ -2415,6 +2581,7 @@
|
|
2415
2581
|
"value_allowed_null": false
|
2416
2582
|
},
|
2417
2583
|
{
|
2584
|
+
"disabled": false,
|
2418
2585
|
"document": "文档的分辨率",
|
2419
2586
|
"example": "793x1122",
|
2420
2587
|
"member": "string",
|
@@ -2423,6 +2590,7 @@
|
|
2423
2590
|
"value_allowed_null": false
|
2424
2591
|
},
|
2425
2592
|
{
|
2593
|
+
"disabled": false,
|
2426
2594
|
"document": "转码完成后结果的URL\n动态转码:PPT转动态H5的链接\n静态转码:文档每一页的图片URL前缀,比如,该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/`,那么文档第1页的图片URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`,其它页以此类推",
|
2427
2595
|
"example": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
|
2428
2596
|
"member": "string",
|
@@ -2431,6 +2599,7 @@
|
|
2431
2599
|
"value_allowed_null": false
|
2432
2600
|
},
|
2433
2601
|
{
|
2602
|
+
"disabled": false,
|
2434
2603
|
"document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
|
2435
2604
|
"example": "FINISHED",
|
2436
2605
|
"member": "string",
|
@@ -2439,6 +2608,7 @@
|
|
2439
2608
|
"value_allowed_null": false
|
2440
2609
|
},
|
2441
2610
|
{
|
2611
|
+
"disabled": false,
|
2442
2612
|
"document": "转码任务的唯一标识Id",
|
2443
2613
|
"example": "0agdnligqtgtvkm65emb",
|
2444
2614
|
"member": "string",
|
@@ -2447,6 +2617,7 @@
|
|
2447
2617
|
"value_allowed_null": false
|
2448
2618
|
},
|
2449
2619
|
{
|
2620
|
+
"disabled": false,
|
2450
2621
|
"document": "文档的文件名",
|
2451
2622
|
"example": "59378.docx",
|
2452
2623
|
"member": "string",
|
@@ -2455,6 +2626,7 @@
|
|
2455
2626
|
"value_allowed_null": false
|
2456
2627
|
},
|
2457
2628
|
{
|
2629
|
+
"disabled": false,
|
2458
2630
|
"document": "缩略图URL前缀,比如,该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/ `,那么动态PPT第1页的缩略图URL为\n`http://example.com/g0jb42ps49vtebjshilb/1.jpg`,其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数,并且转码类型为动态转码,该参数不为空,其余情况该参数为空字符串",
|
2459
2631
|
"example": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
|
2460
2632
|
"member": "string",
|
@@ -2463,6 +2635,7 @@
|
|
2463
2635
|
"value_allowed_null": false
|
2464
2636
|
},
|
2465
2637
|
{
|
2638
|
+
"disabled": false,
|
2466
2639
|
"document": "动态转码缩略图生成分辨率",
|
2467
2640
|
"example": "793x1122",
|
2468
2641
|
"member": "string",
|
@@ -2471,6 +2644,7 @@
|
|
2471
2644
|
"value_allowed_null": false
|
2472
2645
|
},
|
2473
2646
|
{
|
2647
|
+
"disabled": false,
|
2474
2648
|
"document": "转码压缩文件下载的URL,如果发起文档转码请求参数中`CompressFileType`为空或者不是支持的压缩格式,该参数为空字符串",
|
2475
2649
|
"example": "无",
|
2476
2650
|
"member": "string",
|
@@ -2479,6 +2653,7 @@
|
|
2479
2653
|
"value_allowed_null": false
|
2480
2654
|
},
|
2481
2655
|
{
|
2656
|
+
"disabled": false,
|
2482
2657
|
"document": "资源清单文件下载URL(内测体验)\n注意:此字段可能返回 null,表示取不到有效值。",
|
2483
2658
|
"example": "无",
|
2484
2659
|
"member": "string",
|
@@ -2487,6 +2662,7 @@
|
|
2487
2662
|
"value_allowed_null": true
|
2488
2663
|
},
|
2489
2664
|
{
|
2665
|
+
"disabled": false,
|
2490
2666
|
"document": "文档制作方式(内测体验)\n注意:此字段可能返回 null,表示取不到有效值。",
|
2491
2667
|
"example": "office",
|
2492
2668
|
"member": "string",
|
@@ -2512,6 +2688,7 @@
|
|
2512
2688
|
"document": "DescribeTranscodeSearch返回参数结构体",
|
2513
2689
|
"members": [
|
2514
2690
|
{
|
2691
|
+
"disabled": false,
|
2515
2692
|
"document": "转码任务搜索结果集合",
|
2516
2693
|
"example": "无",
|
2517
2694
|
"member": "TranscodeTaskSearchResult",
|
@@ -2521,6 +2698,7 @@
|
|
2521
2698
|
"value_allowed_null": false
|
2522
2699
|
},
|
2523
2700
|
{
|
2701
|
+
"disabled": false,
|
2524
2702
|
"document": "转码总任务数",
|
2525
2703
|
"example": "1340",
|
2526
2704
|
"member": "int64",
|
@@ -2543,6 +2721,7 @@
|
|
2543
2721
|
"members": [
|
2544
2722
|
{
|
2545
2723
|
"default": "",
|
2724
|
+
"disabled": false,
|
2546
2725
|
"document": "统计时间段的开始时间",
|
2547
2726
|
"member": "datetime",
|
2548
2727
|
"name": "BeginTime",
|
@@ -2551,6 +2730,7 @@
|
|
2551
2730
|
},
|
2552
2731
|
{
|
2553
2732
|
"default": "",
|
2733
|
+
"disabled": false,
|
2554
2734
|
"document": "统计时间段的结束时间",
|
2555
2735
|
"member": "datetime",
|
2556
2736
|
"name": "EndTime",
|
@@ -2559,6 +2739,7 @@
|
|
2559
2739
|
},
|
2560
2740
|
{
|
2561
2741
|
"default": "",
|
2742
|
+
"disabled": false,
|
2562
2743
|
"document": "需要获取用量的子产品列表",
|
2563
2744
|
"member": "string",
|
2564
2745
|
"name": "SubProducts",
|
@@ -2567,6 +2748,7 @@
|
|
2567
2748
|
},
|
2568
2749
|
{
|
2569
2750
|
"default": "",
|
2751
|
+
"disabled": false,
|
2570
2752
|
"document": "true: 返回加权后的数据\nfalse: 返回原始数据",
|
2571
2753
|
"member": "bool",
|
2572
2754
|
"name": "IsWeighted",
|
@@ -2593,6 +2775,7 @@
|
|
2593
2775
|
"members": [
|
2594
2776
|
{
|
2595
2777
|
"default": "",
|
2778
|
+
"disabled": false,
|
2596
2779
|
"document": "白板应用的SdkAppId",
|
2597
2780
|
"example": "1400000001",
|
2598
2781
|
"member": "int64",
|
@@ -2602,6 +2785,7 @@
|
|
2602
2785
|
},
|
2603
2786
|
{
|
2604
2787
|
"default": "",
|
2788
|
+
"disabled": false,
|
2605
2789
|
"document": "需要查询用户列表的白板房间号",
|
2606
2790
|
"example": "10000",
|
2607
2791
|
"member": "string",
|
@@ -2611,6 +2795,7 @@
|
|
2611
2795
|
},
|
2612
2796
|
{
|
2613
2797
|
"default": "",
|
2798
|
+
"disabled": false,
|
2614
2799
|
"document": "查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间",
|
2615
2800
|
"example": "[1614519034000,1614691834999]",
|
2616
2801
|
"member": "int64",
|
@@ -2620,6 +2805,7 @@
|
|
2620
2805
|
},
|
2621
2806
|
{
|
2622
2807
|
"default": "",
|
2808
|
+
"disabled": false,
|
2623
2809
|
"document": "额外的查询条件",
|
2624
2810
|
"example": "action: addData",
|
2625
2811
|
"member": "string",
|
@@ -2629,6 +2815,7 @@
|
|
2629
2815
|
},
|
2630
2816
|
{
|
2631
2817
|
"default": "",
|
2818
|
+
"disabled": false,
|
2632
2819
|
"document": "返回最大的数据条数,默认1000",
|
2633
2820
|
"example": "1000",
|
2634
2821
|
"member": "int64",
|
@@ -2643,6 +2830,7 @@
|
|
2643
2830
|
"document": "DescribeUserList返回参数结构体",
|
2644
2831
|
"members": [
|
2645
2832
|
{
|
2833
|
+
"disabled": false,
|
2646
2834
|
"document": "房间内的用户列表",
|
2647
2835
|
"example": "[]",
|
2648
2836
|
"member": "UserListItem",
|
@@ -2686,6 +2874,7 @@
|
|
2686
2874
|
"document": "DescribeUserStatus返回参数结构体",
|
2687
2875
|
"members": [
|
2688
2876
|
{
|
2877
|
+
"disabled": false,
|
2689
2878
|
"document": "客户的AppId",
|
2690
2879
|
"member": "int64",
|
2691
2880
|
"name": "AppId",
|
@@ -2693,6 +2882,7 @@
|
|
2693
2882
|
"value_allowed_null": false
|
2694
2883
|
},
|
2695
2884
|
{
|
2885
|
+
"disabled": false,
|
2696
2886
|
"document": "是否开通过白板(试用或正式)\n\n0: 从未开通过白板服务\n1: 已经开通过白板服务",
|
2697
2887
|
"member": "int64",
|
2698
2888
|
"name": "IsTiwUser",
|
@@ -2700,6 +2890,7 @@
|
|
2700
2890
|
"value_allowed_null": false
|
2701
2891
|
},
|
2702
2892
|
{
|
2893
|
+
"disabled": false,
|
2703
2894
|
"document": "是否开通过互动课堂(试用或正式)",
|
2704
2895
|
"member": "int64",
|
2705
2896
|
"name": "IsSaaSUser",
|
@@ -2707,6 +2898,7 @@
|
|
2707
2898
|
"value_allowed_null": false
|
2708
2899
|
},
|
2709
2900
|
{
|
2901
|
+
"disabled": false,
|
2710
2902
|
"document": "是否使用白板的课后录制",
|
2711
2903
|
"member": "int64",
|
2712
2904
|
"name": "IsTiwOfflineRecordUser",
|
@@ -2714,6 +2906,7 @@
|
|
2714
2906
|
"value_allowed_null": false
|
2715
2907
|
},
|
2716
2908
|
{
|
2909
|
+
"disabled": false,
|
2717
2910
|
"document": "用户是否实名认证",
|
2718
2911
|
"member": "int64",
|
2719
2912
|
"name": "IsAuthenticated",
|
@@ -2734,6 +2927,7 @@
|
|
2734
2927
|
"members": [
|
2735
2928
|
{
|
2736
2929
|
"default": "",
|
2930
|
+
"disabled": false,
|
2737
2931
|
"document": "应用的SdkAppId",
|
2738
2932
|
"member": "int64",
|
2739
2933
|
"name": "SdkAppId",
|
@@ -2747,6 +2941,7 @@
|
|
2747
2941
|
"document": "DescribeVideoGenerationTaskCallback返回参数结构体",
|
2748
2942
|
"members": [
|
2749
2943
|
{
|
2944
|
+
"disabled": false,
|
2750
2945
|
"document": "录制视频生成回调地址",
|
2751
2946
|
"member": "string",
|
2752
2947
|
"name": "Callback",
|
@@ -2754,6 +2949,7 @@
|
|
2754
2949
|
"value_allowed_null": false
|
2755
2950
|
},
|
2756
2951
|
{
|
2952
|
+
"disabled": false,
|
2757
2953
|
"document": "录制视频生成回调鉴权密钥",
|
2758
2954
|
"member": "string",
|
2759
2955
|
"name": "CallbackKey",
|
@@ -2774,6 +2970,7 @@
|
|
2774
2970
|
"members": [
|
2775
2971
|
{
|
2776
2972
|
"default": "",
|
2973
|
+
"disabled": false,
|
2777
2974
|
"document": "客户的SdkAppId",
|
2778
2975
|
"member": "int64",
|
2779
2976
|
"name": "SdkAppId",
|
@@ -2782,6 +2979,7 @@
|
|
2782
2979
|
},
|
2783
2980
|
{
|
2784
2981
|
"default": "",
|
2982
|
+
"disabled": false,
|
2785
2983
|
"document": "录制视频生成的任务Id",
|
2786
2984
|
"member": "string",
|
2787
2985
|
"name": "TaskId",
|
@@ -2795,6 +2993,7 @@
|
|
2795
2993
|
"document": "DescribeVideoGenerationTask返回参数结构体",
|
2796
2994
|
"members": [
|
2797
2995
|
{
|
2996
|
+
"disabled": false,
|
2798
2997
|
"document": "任务对应的群组Id",
|
2799
2998
|
"member": "string",
|
2800
2999
|
"name": "GroupId",
|
@@ -2802,6 +3001,7 @@
|
|
2802
3001
|
"value_allowed_null": false
|
2803
3002
|
},
|
2804
3003
|
{
|
3004
|
+
"disabled": false,
|
2805
3005
|
"document": "任务对应的房间号",
|
2806
3006
|
"member": "int64",
|
2807
3007
|
"name": "RoomId",
|
@@ -2809,6 +3009,7 @@
|
|
2809
3009
|
"value_allowed_null": false
|
2810
3010
|
},
|
2811
3011
|
{
|
3012
|
+
"disabled": false,
|
2812
3013
|
"document": "任务的Id",
|
2813
3014
|
"member": "string",
|
2814
3015
|
"name": "TaskId",
|
@@ -2816,6 +3017,7 @@
|
|
2816
3017
|
"value_allowed_null": false
|
2817
3018
|
},
|
2818
3019
|
{
|
3020
|
+
"disabled": false,
|
2819
3021
|
"document": "已废弃",
|
2820
3022
|
"member": "int64",
|
2821
3023
|
"name": "Progress",
|
@@ -2823,6 +3025,7 @@
|
|
2823
3025
|
"value_allowed_null": false
|
2824
3026
|
},
|
2825
3027
|
{
|
3028
|
+
"disabled": false,
|
2826
3029
|
"document": "录制视频生成任务状态\n- QUEUED: 正在排队\n- PROCESSING: 正在生成视频\n- FINISHED: 生成视频结束(成功完成或失败结束,可以通过错误码和错误信息进一步判断)",
|
2827
3030
|
"member": "string",
|
2828
3031
|
"name": "Status",
|
@@ -2830,6 +3033,7 @@
|
|
2830
3033
|
"value_allowed_null": false
|
2831
3034
|
},
|
2832
3035
|
{
|
3036
|
+
"disabled": false,
|
2833
3037
|
"document": "回放视频总时长,单位:毫秒",
|
2834
3038
|
"member": "int64",
|
2835
3039
|
"name": "TotalTime",
|
@@ -2837,6 +3041,7 @@
|
|
2837
3041
|
"value_allowed_null": false
|
2838
3042
|
},
|
2839
3043
|
{
|
3044
|
+
"disabled": false,
|
2840
3045
|
"document": "已废弃,请使用`VideoInfoList`参数",
|
2841
3046
|
"member": "VideoInfo",
|
2842
3047
|
"name": "VideoInfos",
|
@@ -2844,6 +3049,7 @@
|
|
2844
3049
|
"value_allowed_null": false
|
2845
3050
|
},
|
2846
3051
|
{
|
3052
|
+
"disabled": false,
|
2847
3053
|
"document": "录制视频生成视频列表",
|
2848
3054
|
"member": "VideoInfo",
|
2849
3055
|
"name": "VideoInfoList",
|
@@ -2863,6 +3069,7 @@
|
|
2863
3069
|
"document": "DescribeWarningCallback请求参数结构体",
|
2864
3070
|
"members": [
|
2865
3071
|
{
|
3072
|
+
"disabled": false,
|
2866
3073
|
"document": "应用的SdkAppId",
|
2867
3074
|
"example": "1400000001",
|
2868
3075
|
"member": "int64",
|
@@ -2877,6 +3084,7 @@
|
|
2877
3084
|
"document": "DescribeWarningCallback返回参数结构体",
|
2878
3085
|
"members": [
|
2879
3086
|
{
|
3087
|
+
"disabled": false,
|
2880
3088
|
"document": "告警事件回调地址,如果未设置回调地址,该字段为空字符串",
|
2881
3089
|
"example": "https://example.com/online/callback",
|
2882
3090
|
"member": "string",
|
@@ -2885,6 +3093,7 @@
|
|
2885
3093
|
"value_allowed_null": false
|
2886
3094
|
},
|
2887
3095
|
{
|
3096
|
+
"disabled": false,
|
2888
3097
|
"document": "告警回调鉴权密钥",
|
2889
3098
|
"example": "6vg9G7Fd",
|
2890
3099
|
"member": "string",
|
@@ -2906,6 +3115,7 @@
|
|
2906
3115
|
"members": [
|
2907
3116
|
{
|
2908
3117
|
"default": "",
|
3118
|
+
"disabled": false,
|
2909
3119
|
"document": "客户的SdkAppId",
|
2910
3120
|
"example": "1400000001",
|
2911
3121
|
"member": "int64",
|
@@ -2915,6 +3125,7 @@
|
|
2915
3125
|
},
|
2916
3126
|
{
|
2917
3127
|
"default": "",
|
3128
|
+
"disabled": false,
|
2918
3129
|
"document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
|
2919
3130
|
"example": "[\"transcode\",\"recording\"]",
|
2920
3131
|
"member": "string",
|
@@ -2924,6 +3135,7 @@
|
|
2924
3135
|
},
|
2925
3136
|
{
|
2926
3137
|
"default": "",
|
3138
|
+
"disabled": false,
|
2927
3139
|
"document": "需要查询配置的SdkAppId列表",
|
2928
3140
|
"example": "[0]",
|
2929
3141
|
"member": "int64",
|
@@ -2938,6 +3150,7 @@
|
|
2938
3150
|
"document": "DescribeWhiteboardApplicationConfig返回参数结构体",
|
2939
3151
|
"members": [
|
2940
3152
|
{
|
3153
|
+
"disabled": false,
|
2941
3154
|
"document": "客户的SdkAppId",
|
2942
3155
|
"example": "1400127140",
|
2943
3156
|
"member": "int64",
|
@@ -2947,6 +3160,7 @@
|
|
2947
3160
|
"value_allowed_null": false
|
2948
3161
|
},
|
2949
3162
|
{
|
3163
|
+
"disabled": false,
|
2950
3164
|
"document": "白板应用任务相关配置",
|
2951
3165
|
"example": "无",
|
2952
3166
|
"member": "WhiteboardApplicationConfig",
|
@@ -2969,6 +3183,7 @@
|
|
2969
3183
|
"members": [
|
2970
3184
|
{
|
2971
3185
|
"default": "",
|
3186
|
+
"disabled": false,
|
2972
3187
|
"document": "客户的SdkAppId",
|
2973
3188
|
"member": "int64",
|
2974
3189
|
"name": "SdkAppId",
|
@@ -2977,6 +3192,7 @@
|
|
2977
3192
|
},
|
2978
3193
|
{
|
2979
3194
|
"default": "",
|
3195
|
+
"disabled": false,
|
2980
3196
|
"document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
|
2981
3197
|
"member": "string",
|
2982
3198
|
"name": "TaskType",
|
@@ -3003,6 +3219,7 @@
|
|
3003
3219
|
"members": [
|
3004
3220
|
{
|
3005
3221
|
"default": "",
|
3222
|
+
"disabled": false,
|
3006
3223
|
"document": "应用的SdkAppId",
|
3007
3224
|
"example": "1400000001",
|
3008
3225
|
"member": "int64",
|
@@ -3017,6 +3234,7 @@
|
|
3017
3234
|
"document": "DescribeWhiteboardPushCallback返回参数结构体",
|
3018
3235
|
"members": [
|
3019
3236
|
{
|
3237
|
+
"disabled": false,
|
3020
3238
|
"document": "白板推流事件回调地址,如果未设置回调地址,该字段为空字符串",
|
3021
3239
|
"example": "https://example.com/online/callback",
|
3022
3240
|
"member": "string",
|
@@ -3026,6 +3244,7 @@
|
|
3026
3244
|
"value_allowed_null": false
|
3027
3245
|
},
|
3028
3246
|
{
|
3247
|
+
"disabled": false,
|
3029
3248
|
"document": "白板推流回调鉴权密钥",
|
3030
3249
|
"example": "6vg9G7Fd",
|
3031
3250
|
"member": "string",
|
@@ -3048,6 +3267,7 @@
|
|
3048
3267
|
"members": [
|
3049
3268
|
{
|
3050
3269
|
"default": "",
|
3270
|
+
"disabled": false,
|
3051
3271
|
"document": "客户的SdkAppId",
|
3052
3272
|
"example": "1400000001",
|
3053
3273
|
"member": "int64",
|
@@ -3057,6 +3277,7 @@
|
|
3057
3277
|
},
|
3058
3278
|
{
|
3059
3279
|
"default": "",
|
3280
|
+
"disabled": false,
|
3060
3281
|
"document": "白板推流任务Id",
|
3061
3282
|
"example": "ghucnligqtgtvk2624mb",
|
3062
3283
|
"member": "string",
|
@@ -3071,6 +3292,7 @@
|
|
3071
3292
|
"document": "DescribeWhiteboardPush返回参数结构体",
|
3072
3293
|
"members": [
|
3073
3294
|
{
|
3295
|
+
"disabled": false,
|
3074
3296
|
"document": "推流结束原因,\n- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流\n- USER_CALL: 主动调用了停止推流接口\n- EXCEPTION: 推流异常结束",
|
3075
3297
|
"example": "USER_CALL",
|
3076
3298
|
"member": "string",
|
@@ -3079,6 +3301,7 @@
|
|
3079
3301
|
"value_allowed_null": false
|
3080
3302
|
},
|
3081
3303
|
{
|
3304
|
+
"disabled": false,
|
3082
3305
|
"document": "需要查询结果的白板推流任务Id",
|
3083
3306
|
"example": "ghucnligqtgtvk2624mb",
|
3084
3307
|
"member": "string",
|
@@ -3087,6 +3310,7 @@
|
|
3087
3310
|
"value_allowed_null": false
|
3088
3311
|
},
|
3089
3312
|
{
|
3313
|
+
"disabled": false,
|
3090
3314
|
"document": "推流任务状态\n- PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)\n- PUSHING: 表示推流已开始\n- STOPPED: 表示推流已停止",
|
3091
3315
|
"example": "STOPPED",
|
3092
3316
|
"member": "string",
|
@@ -3095,6 +3319,7 @@
|
|
3095
3319
|
"value_allowed_null": false
|
3096
3320
|
},
|
3097
3321
|
{
|
3322
|
+
"disabled": false,
|
3098
3323
|
"document": "房间号",
|
3099
3324
|
"example": "12345",
|
3100
3325
|
"member": "int64",
|
@@ -3103,6 +3328,7 @@
|
|
3103
3328
|
"value_allowed_null": false
|
3104
3329
|
},
|
3105
3330
|
{
|
3331
|
+
"disabled": false,
|
3106
3332
|
"document": "白板的群组 Id",
|
3107
3333
|
"example": "12345",
|
3108
3334
|
"member": "string",
|
@@ -3111,6 +3337,7 @@
|
|
3111
3337
|
"value_allowed_null": false
|
3112
3338
|
},
|
3113
3339
|
{
|
3340
|
+
"disabled": false,
|
3114
3341
|
"document": "推流用户Id",
|
3115
3342
|
"example": "tic_push_user_12345_abcde",
|
3116
3343
|
"member": "string",
|
@@ -3119,6 +3346,7 @@
|
|
3119
3346
|
"value_allowed_null": false
|
3120
3347
|
},
|
3121
3348
|
{
|
3349
|
+
"disabled": false,
|
3122
3350
|
"document": "实际开始推流时间,Unix 时间戳,单位秒",
|
3123
3351
|
"example": "1611128339",
|
3124
3352
|
"member": "int64",
|
@@ -3127,6 +3355,7 @@
|
|
3127
3355
|
"value_allowed_null": false
|
3128
3356
|
},
|
3129
3357
|
{
|
3358
|
+
"disabled": false,
|
3130
3359
|
"document": "实际停止推流时间,Unix 时间戳,单位秒",
|
3131
3360
|
"example": "1611128339",
|
3132
3361
|
"member": "int64",
|
@@ -3135,6 +3364,7 @@
|
|
3135
3364
|
"value_allowed_null": false
|
3136
3365
|
},
|
3137
3366
|
{
|
3367
|
+
"disabled": false,
|
3138
3368
|
"document": "推流过程中出现异常的次数",
|
3139
3369
|
"example": "0",
|
3140
3370
|
"member": "int64",
|
@@ -3143,6 +3373,7 @@
|
|
3143
3373
|
"value_allowed_null": false
|
3144
3374
|
},
|
3145
3375
|
{
|
3376
|
+
"disabled": false,
|
3146
3377
|
"document": "白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。",
|
3147
3378
|
"example": "0",
|
3148
3379
|
"member": "int64",
|
@@ -3151,6 +3382,7 @@
|
|
3151
3382
|
"value_allowed_null": false
|
3152
3383
|
},
|
3153
3384
|
{
|
3385
|
+
"disabled": false,
|
3154
3386
|
"document": "备份推流任务结果信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
3155
3387
|
"example": "{}",
|
3156
3388
|
"member": "string",
|
@@ -3176,6 +3408,7 @@
|
|
3176
3408
|
"document": "DescribeWhiteboardPushSearch返回参数结构体",
|
3177
3409
|
"members": [
|
3178
3410
|
{
|
3411
|
+
"disabled": false,
|
3179
3412
|
"document": "推流任务搜索结果集合",
|
3180
3413
|
"example": "无",
|
3181
3414
|
"member": "WhiteboardPushTaskSearchResult",
|
@@ -3185,6 +3418,7 @@
|
|
3185
3418
|
"value_allowed_null": false
|
3186
3419
|
},
|
3187
3420
|
{
|
3421
|
+
"disabled": false,
|
3188
3422
|
"document": "推流总任务数",
|
3189
3423
|
"example": "1",
|
3190
3424
|
"member": "int64",
|
@@ -3207,6 +3441,7 @@
|
|
3207
3441
|
"members": [
|
3208
3442
|
{
|
3209
3443
|
"default": "",
|
3444
|
+
"disabled": false,
|
3210
3445
|
"document": "用量指标",
|
3211
3446
|
"member": "string",
|
3212
3447
|
"name": "TagName",
|
@@ -3216,6 +3451,7 @@
|
|
3216
3451
|
},
|
3217
3452
|
{
|
3218
3453
|
"default": "",
|
3454
|
+
"disabled": false,
|
3219
3455
|
"document": "用量权重",
|
3220
3456
|
"member": "float",
|
3221
3457
|
"name": "Weight",
|
@@ -3225,6 +3461,7 @@
|
|
3225
3461
|
},
|
3226
3462
|
{
|
3227
3463
|
"default": "",
|
3464
|
+
"disabled": false,
|
3228
3465
|
"document": "用量的值",
|
3229
3466
|
"member": "float",
|
3230
3467
|
"name": "Value",
|
@@ -3240,6 +3477,7 @@
|
|
3240
3477
|
"members": [
|
3241
3478
|
{
|
3242
3479
|
"default": "",
|
3480
|
+
"disabled": false,
|
3243
3481
|
"document": "用户ID\n注意:此字段可能返回 null,表示取不到有效值。",
|
3244
3482
|
"example": "tiw_user_634",
|
3245
3483
|
"member": "string",
|
@@ -3250,6 +3488,7 @@
|
|
3250
3488
|
},
|
3251
3489
|
{
|
3252
3490
|
"default": "",
|
3491
|
+
"disabled": false,
|
3253
3492
|
"document": "视频流断流次数\n注意:此字段可能返回 null,表示取不到有效值。",
|
3254
3493
|
"example": "2",
|
3255
3494
|
"member": "int64",
|
@@ -3266,6 +3505,7 @@
|
|
3266
3505
|
"members": [
|
3267
3506
|
{
|
3268
3507
|
"default": "",
|
3508
|
+
"disabled": false,
|
3269
3509
|
"document": "流画面宽,取值范围[2,3000]",
|
3270
3510
|
"member": "int64",
|
3271
3511
|
"name": "Width",
|
@@ -3275,6 +3515,7 @@
|
|
3275
3515
|
},
|
3276
3516
|
{
|
3277
3517
|
"default": "",
|
3518
|
+
"disabled": false,
|
3278
3519
|
"document": "流画面高,取值范围[2,3000]",
|
3279
3520
|
"member": "int64",
|
3280
3521
|
"name": "Height",
|
@@ -3284,6 +3525,7 @@
|
|
3284
3525
|
},
|
3285
3526
|
{
|
3286
3527
|
"default": "",
|
3528
|
+
"disabled": false,
|
3287
3529
|
"document": "当前画面左上角顶点相对于Canvas左上角顶点的x轴偏移量,默认为0,取值范围[0,3000]",
|
3288
3530
|
"member": "int64",
|
3289
3531
|
"name": "X",
|
@@ -3293,6 +3535,7 @@
|
|
3293
3535
|
},
|
3294
3536
|
{
|
3295
3537
|
"default": "",
|
3538
|
+
"disabled": false,
|
3296
3539
|
"document": "当前画面左上角顶点相对于Canvas左上角顶点的y轴偏移量,默认为0, 取值范围[0,3000]",
|
3297
3540
|
"member": "int64",
|
3298
3541
|
"name": "Y",
|
@@ -3302,6 +3545,7 @@
|
|
3302
3545
|
},
|
3303
3546
|
{
|
3304
3547
|
"default": "",
|
3548
|
+
"disabled": false,
|
3305
3549
|
"document": "画面z轴位置,默认为0\nz轴确定了重叠画面的遮盖顺序,z轴值大的画面处于顶层",
|
3306
3550
|
"member": "int64",
|
3307
3551
|
"name": "ZOrder",
|
@@ -3317,6 +3561,7 @@
|
|
3317
3561
|
"members": [
|
3318
3562
|
{
|
3319
3563
|
"default": "",
|
3564
|
+
"disabled": false,
|
3320
3565
|
"document": "是否开启混流",
|
3321
3566
|
"member": "bool",
|
3322
3567
|
"name": "Enabled",
|
@@ -3326,6 +3571,7 @@
|
|
3326
3571
|
},
|
3327
3572
|
{
|
3328
3573
|
"default": "",
|
3574
|
+
"disabled": false,
|
3329
3575
|
"document": "是否禁用音频混流",
|
3330
3576
|
"member": "bool",
|
3331
3577
|
"name": "DisableAudio",
|
@@ -3335,6 +3581,7 @@
|
|
3335
3581
|
},
|
3336
3582
|
{
|
3337
3583
|
"default": "",
|
3584
|
+
"disabled": false,
|
3338
3585
|
"document": "内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明\n在没有填Custom字段时候,ModelId是必填的",
|
3339
3586
|
"member": "int64",
|
3340
3587
|
"name": "ModelId",
|
@@ -3344,6 +3591,7 @@
|
|
3344
3591
|
},
|
3345
3592
|
{
|
3346
3593
|
"default": "",
|
3594
|
+
"disabled": false,
|
3347
3595
|
"document": "老师用户ID\n此字段只有在ModelId填了的情况下生效\n填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中",
|
3348
3596
|
"member": "string",
|
3349
3597
|
"name": "TeacherId",
|
@@ -3353,6 +3601,7 @@
|
|
3353
3601
|
},
|
3354
3602
|
{
|
3355
3603
|
"default": "",
|
3604
|
+
"disabled": false,
|
3356
3605
|
"document": "自定义混流布局参数\n当此字段存在时,ModelId 及 TeacherId 字段将被忽略",
|
3357
3606
|
"member": "CustomLayout",
|
3358
3607
|
"name": "Custom",
|
@@ -3368,6 +3617,7 @@
|
|
3368
3617
|
"members": [
|
3369
3618
|
{
|
3370
3619
|
"default": "",
|
3620
|
+
"disabled": false,
|
3371
3621
|
"document": "应用SdkAppId",
|
3372
3622
|
"member": "int64",
|
3373
3623
|
"name": "SdkAppId",
|
@@ -3376,6 +3626,7 @@
|
|
3376
3626
|
},
|
3377
3627
|
{
|
3378
3628
|
"default": "",
|
3629
|
+
"disabled": false,
|
3379
3630
|
"document": "App名字",
|
3380
3631
|
"member": "string",
|
3381
3632
|
"name": "AppName",
|
@@ -3402,6 +3653,7 @@
|
|
3402
3653
|
"members": [
|
3403
3654
|
{
|
3404
3655
|
"default": "",
|
3656
|
+
"disabled": false,
|
3405
3657
|
"document": "资源Id,从DescribeUserResources接口中获取Level=1的正式月功能费的SubProduct,一般为sp_tiw_package",
|
3406
3658
|
"member": "string",
|
3407
3659
|
"name": "SubProduct",
|
@@ -3410,6 +3662,7 @@
|
|
3410
3662
|
},
|
3411
3663
|
{
|
3412
3664
|
"default": "",
|
3665
|
+
"disabled": false,
|
3413
3666
|
"document": "资源Id,从DescribeUserResources接口中获取Level=1的正式月功能费资源Id",
|
3414
3667
|
"member": "string",
|
3415
3668
|
"name": "ResourceId",
|
@@ -3418,6 +3671,7 @@
|
|
3418
3671
|
},
|
3419
3672
|
{
|
3420
3673
|
"default": "",
|
3674
|
+
"disabled": false,
|
3421
3675
|
"document": "自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置),若业务无续费概念或无需自动续 费,需要设置为0",
|
3422
3676
|
"member": "int64",
|
3423
3677
|
"name": "AutoRenewFlag",
|
@@ -3444,6 +3698,7 @@
|
|
3444
3698
|
"members": [
|
3445
3699
|
{
|
3446
3700
|
"default": "",
|
3701
|
+
"disabled": false,
|
3447
3702
|
"document": "客户的SdkAppId",
|
3448
3703
|
"example": "1400000001",
|
3449
3704
|
"member": "int64",
|
@@ -3453,6 +3708,7 @@
|
|
3453
3708
|
},
|
3454
3709
|
{
|
3455
3710
|
"default": "",
|
3711
|
+
"disabled": false,
|
3456
3712
|
"document": "白板应用任务相关配置",
|
3457
3713
|
"example": "无",
|
3458
3714
|
"member": "WhiteboardApplicationConfig",
|
@@ -3480,6 +3736,7 @@
|
|
3480
3736
|
"members": [
|
3481
3737
|
{
|
3482
3738
|
"default": "",
|
3739
|
+
"disabled": false,
|
3483
3740
|
"document": "客户的SdkAppId",
|
3484
3741
|
"member": "int64",
|
3485
3742
|
"name": "SdkAppId",
|
@@ -3488,6 +3745,7 @@
|
|
3488
3745
|
},
|
3489
3746
|
{
|
3490
3747
|
"default": "",
|
3748
|
+
"disabled": false,
|
3491
3749
|
"document": "需要查询的任务类型\nrecording: 实时录制\ntranscode: 文档转码",
|
3492
3750
|
"member": "string",
|
3493
3751
|
"name": "TaskType",
|
@@ -3496,6 +3754,7 @@
|
|
3496
3754
|
},
|
3497
3755
|
{
|
3498
3756
|
"default": "",
|
3757
|
+
"disabled": false,
|
3499
3758
|
"document": "COS存储桶名字",
|
3500
3759
|
"member": "string",
|
3501
3760
|
"name": "BucketName",
|
@@ -3504,6 +3763,7 @@
|
|
3504
3763
|
},
|
3505
3764
|
{
|
3506
3765
|
"default": "",
|
3766
|
+
"disabled": false,
|
3507
3767
|
"document": "COS存储桶地域",
|
3508
3768
|
"member": "string",
|
3509
3769
|
"name": "BucketLocation",
|
@@ -3512,6 +3772,7 @@
|
|
3512
3772
|
},
|
3513
3773
|
{
|
3514
3774
|
"default": "",
|
3775
|
+
"disabled": false,
|
3515
3776
|
"document": "存储桶里资源前缀",
|
3516
3777
|
"member": "string",
|
3517
3778
|
"name": "BucketPrefix",
|
@@ -3520,6 +3781,7 @@
|
|
3520
3781
|
},
|
3521
3782
|
{
|
3522
3783
|
"default": "",
|
3784
|
+
"disabled": false,
|
3523
3785
|
"document": "返回Url域名",
|
3524
3786
|
"member": "string",
|
3525
3787
|
"name": "ResultDomain",
|
@@ -3546,6 +3808,7 @@
|
|
3546
3808
|
"members": [
|
3547
3809
|
{
|
3548
3810
|
"default": "",
|
3811
|
+
"disabled": false,
|
3549
3812
|
"document": "录制暂停时间戳对应的视频播放时间(单位: 毫秒)",
|
3550
3813
|
"member": "int64",
|
3551
3814
|
"name": "VideoTime",
|
@@ -3555,6 +3818,7 @@
|
|
3555
3818
|
},
|
3556
3819
|
{
|
3557
3820
|
"default": "",
|
3821
|
+
"disabled": false,
|
3558
3822
|
"document": "录制暂停时间戳(单位: 毫秒)",
|
3559
3823
|
"member": "int64",
|
3560
3824
|
"name": "PauseTime",
|
@@ -3564,6 +3828,7 @@
|
|
3564
3828
|
},
|
3565
3829
|
{
|
3566
3830
|
"default": "",
|
3831
|
+
"disabled": false,
|
3567
3832
|
"document": "录制恢复时间戳(单位: 毫秒)",
|
3568
3833
|
"member": "int64",
|
3569
3834
|
"name": "ResumeTime",
|
@@ -3578,6 +3843,7 @@
|
|
3578
3843
|
"document": "PPT错误元素",
|
3579
3844
|
"members": [
|
3580
3845
|
{
|
3846
|
+
"disabled": false,
|
3581
3847
|
"document": "元素名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
3582
3848
|
"example": "Ink 1",
|
3583
3849
|
"member": "string",
|
@@ -3587,6 +3853,7 @@
|
|
3587
3853
|
"value_allowed_null": true
|
3588
3854
|
},
|
3589
3855
|
{
|
3856
|
+
"disabled": false,
|
3590
3857
|
"document": "0: 不支持的墨迹类型,1: 不支持自动翻页,2: 存在已损坏音视频,3: 存在不可访问资源,4: 只读文件\n注意:此字段可能返回 null,表示取不到有效值。",
|
3591
3858
|
"example": "0",
|
3592
3859
|
"member": "int64",
|
@@ -3596,6 +3863,7 @@
|
|
3596
3863
|
"value_allowed_null": true
|
3597
3864
|
},
|
3598
3865
|
{
|
3866
|
+
"disabled": false,
|
3599
3867
|
"document": "错误详情\n注意:此字段可能返回 null,表示取不到有效值。",
|
3600
3868
|
"example": "wps墨迹",
|
3601
3869
|
"member": "string",
|
@@ -3611,6 +3879,7 @@
|
|
3611
3879
|
"document": "PPT错误页面列表",
|
3612
3880
|
"members": [
|
3613
3881
|
{
|
3882
|
+
"disabled": false,
|
3614
3883
|
"document": "异常元素存在的页面,由页面类型+页码组成,页码类型包括:幻灯片、幻灯片母版、幻灯片布局等\n注意:此字段可能返回 null,表示取不到有效值。",
|
3615
3884
|
"example": "幻灯片1",
|
3616
3885
|
"member": "string",
|
@@ -3620,6 +3889,7 @@
|
|
3620
3889
|
"value_allowed_null": true
|
3621
3890
|
},
|
3622
3891
|
{
|
3892
|
+
"disabled": false,
|
3623
3893
|
"document": "错误元素列表\n注意:此字段可能返回 null,表示取不到有效值。",
|
3624
3894
|
"example": "无",
|
3625
3895
|
"member": "PPTErr",
|
@@ -3636,6 +3906,7 @@
|
|
3636
3906
|
"members": [
|
3637
3907
|
{
|
3638
3908
|
"default": "",
|
3909
|
+
"disabled": false,
|
3639
3910
|
"document": "客户的SdkAppId",
|
3640
3911
|
"member": "int64",
|
3641
3912
|
"name": "SdkAppId",
|
@@ -3644,6 +3915,7 @@
|
|
3644
3915
|
},
|
3645
3916
|
{
|
3646
3917
|
"default": "",
|
3918
|
+
"disabled": false,
|
3647
3919
|
"document": "实时录制任务 Id",
|
3648
3920
|
"member": "string",
|
3649
3921
|
"name": "TaskId",
|
@@ -3670,6 +3942,7 @@
|
|
3670
3942
|
"members": [
|
3671
3943
|
{
|
3672
3944
|
"default": "",
|
3945
|
+
"disabled": false,
|
3673
3946
|
"document": "设置是否开启录制控制参数,只有设置为true的时候,录制控制参数才生效。",
|
3674
3947
|
"member": "bool",
|
3675
3948
|
"name": "Enabled",
|
@@ -3679,6 +3952,7 @@
|
|
3679
3952
|
},
|
3680
3953
|
{
|
3681
3954
|
"default": "",
|
3955
|
+
"disabled": false,
|
3682
3956
|
"document": "设置是否禁用录制的全局控制参数。一般与`StreamControls`参数配合使用。\n\ntrue - 所有流都不录制。\nfalse - 所有流都录制。默认为false。\n\n这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。",
|
3683
3957
|
"member": "bool",
|
3684
3958
|
"name": "DisableRecord",
|
@@ -3688,6 +3962,7 @@
|
|
3688
3962
|
},
|
3689
3963
|
{
|
3690
3964
|
"default": "",
|
3965
|
+
"disabled": false,
|
3691
3966
|
"document": "设置是否禁用所有流的音频录制的全局控制参数。一般与`StreamControls`参数配合使用。\n\ntrue - 所有流的录制都不对音频进行录制。\nfalse - 所有流的录制都需要对音频进行录制。默认为false。\n\n这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。",
|
3692
3967
|
"member": "bool",
|
3693
3968
|
"name": "DisableAudio",
|
@@ -3697,6 +3972,7 @@
|
|
3697
3972
|
},
|
3698
3973
|
{
|
3699
3974
|
"default": "",
|
3975
|
+
"disabled": false,
|
3700
3976
|
"document": "设置是否所有流都只录制小画面的全局控制参数。一般与`StreamControls`参数配合使用。\n\ntrue - 所有流都只录制小画面。设置为true时,请确保上行端在推流的时候同时上行了小画面,否则录制视频可能是黑屏。\nfalse - 所有流都录制大画面,默认为false。\n\n这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。",
|
3701
3977
|
"member": "bool",
|
3702
3978
|
"name": "PullSmallVideo",
|
@@ -3706,6 +3982,7 @@
|
|
3706
3982
|
},
|
3707
3983
|
{
|
3708
3984
|
"default": "",
|
3985
|
+
"disabled": false,
|
3709
3986
|
"document": "针对具体流指定控制参数,如果列表为空,则所有流采用全局配置的控制参数进行录制。列表不为空,则列表中指定的流将优先按此列表指定的控制参数进行录制。",
|
3710
3987
|
"member": "StreamControl",
|
3711
3988
|
"name": "StreamControls",
|
@@ -3721,6 +3998,7 @@
|
|
3721
3998
|
"members": [
|
3722
3999
|
{
|
3723
4000
|
"default": "",
|
4001
|
+
"disabled": false,
|
3724
4002
|
"document": "AUTO - 自动停止录制, USER_CALL - 用户主动调用停止录制",
|
3725
4003
|
"member": "string",
|
3726
4004
|
"name": "FinishReason",
|
@@ -3730,6 +4008,7 @@
|
|
3730
4008
|
},
|
3731
4009
|
{
|
3732
4010
|
"default": "",
|
4011
|
+
"disabled": false,
|
3733
4012
|
"document": "异常数",
|
3734
4013
|
"member": "int64",
|
3735
4014
|
"name": "ExceptionCnt",
|
@@ -3739,6 +4018,7 @@
|
|
3739
4018
|
},
|
3740
4019
|
{
|
3741
4020
|
"default": "",
|
4021
|
+
"disabled": false,
|
3742
4022
|
"document": "房间号",
|
3743
4023
|
"member": "int64",
|
3744
4024
|
"name": "RoomId",
|
@@ -3748,6 +4028,7 @@
|
|
3748
4028
|
},
|
3749
4029
|
{
|
3750
4030
|
"default": "",
|
4031
|
+
"disabled": false,
|
3751
4032
|
"document": "分组",
|
3752
4033
|
"member": "string",
|
3753
4034
|
"name": "GroupId",
|
@@ -3757,6 +4038,7 @@
|
|
3757
4038
|
},
|
3758
4039
|
{
|
3759
4040
|
"default": "",
|
4041
|
+
"disabled": false,
|
3760
4042
|
"document": "录制真实开始时间",
|
3761
4043
|
"member": "int64",
|
3762
4044
|
"name": "RecordStartTime",
|
@@ -3766,6 +4048,7 @@
|
|
3766
4048
|
},
|
3767
4049
|
{
|
3768
4050
|
"default": "",
|
4051
|
+
"disabled": false,
|
3769
4052
|
"document": "录制结束时间",
|
3770
4053
|
"member": "int64",
|
3771
4054
|
"name": "RecordStopTime",
|
@@ -3775,6 +4058,7 @@
|
|
3775
4058
|
},
|
3776
4059
|
{
|
3777
4060
|
"default": "",
|
4061
|
+
"disabled": false,
|
3778
4062
|
"document": "录制总时长",
|
3779
4063
|
"member": "int64",
|
3780
4064
|
"name": "TotalTime",
|
@@ -3784,6 +4068,7 @@
|
|
3784
4068
|
},
|
3785
4069
|
{
|
3786
4070
|
"default": "",
|
4071
|
+
"disabled": false,
|
3787
4072
|
"document": "视频信息列表",
|
3788
4073
|
"member": "VideoInfo",
|
3789
4074
|
"name": "VideoInfos",
|
@@ -3793,6 +4078,7 @@
|
|
3793
4078
|
},
|
3794
4079
|
{
|
3795
4080
|
"default": "",
|
4081
|
+
"disabled": false,
|
3796
4082
|
"document": "被忽略的视频时间段",
|
3797
4083
|
"member": "OmittedDuration",
|
3798
4084
|
"name": "OmittedDurations",
|
@@ -3802,6 +4088,7 @@
|
|
3802
4088
|
},
|
3803
4089
|
{
|
3804
4090
|
"default": "",
|
4091
|
+
"disabled": false,
|
3805
4092
|
"document": "详情",
|
3806
4093
|
"member": "string",
|
3807
4094
|
"name": "Details",
|
@@ -3811,6 +4098,7 @@
|
|
3811
4098
|
},
|
3812
4099
|
{
|
3813
4100
|
"default": "",
|
4101
|
+
"disabled": false,
|
3814
4102
|
"document": "任务失败错误码",
|
3815
4103
|
"member": "int64",
|
3816
4104
|
"name": "ErrorCode",
|
@@ -3820,6 +4108,7 @@
|
|
3820
4108
|
},
|
3821
4109
|
{
|
3822
4110
|
"default": "",
|
4111
|
+
"disabled": false,
|
3823
4112
|
"document": "错误信息",
|
3824
4113
|
"member": "string",
|
3825
4114
|
"name": "ErrorMsg",
|
@@ -3835,6 +4124,7 @@
|
|
3835
4124
|
"members": [
|
3836
4125
|
{
|
3837
4126
|
"default": "",
|
4127
|
+
"disabled": false,
|
3838
4128
|
"document": "任务唯一ID",
|
3839
4129
|
"member": "string",
|
3840
4130
|
"name": "TaskId",
|
@@ -3844,6 +4134,7 @@
|
|
3844
4134
|
},
|
3845
4135
|
{
|
3846
4136
|
"default": "",
|
4137
|
+
"disabled": false,
|
3847
4138
|
"document": "实时录制任务状态\n- PAUSED: 录制已暂停\n- PREPARED: 录制在准备阶段\n- RECORDING: 正在录制\n- STOPPED:录制已停止\n- FINISHED: 录制已结束",
|
3848
4139
|
"member": "string",
|
3849
4140
|
"name": "Status",
|
@@ -3853,6 +4144,7 @@
|
|
3853
4144
|
},
|
3854
4145
|
{
|
3855
4146
|
"default": "",
|
4147
|
+
"disabled": false,
|
3856
4148
|
"document": "实时录制房间号",
|
3857
4149
|
"member": "int64",
|
3858
4150
|
"name": "RoomId",
|
@@ -3862,6 +4154,7 @@
|
|
3862
4154
|
},
|
3863
4155
|
{
|
3864
4156
|
"default": "",
|
4157
|
+
"disabled": false,
|
3865
4158
|
"document": "任务创建时间",
|
3866
4159
|
"member": "datetime_iso",
|
3867
4160
|
"name": "CreateTime",
|
@@ -3871,6 +4164,7 @@
|
|
3871
4164
|
},
|
3872
4165
|
{
|
3873
4166
|
"default": "",
|
4167
|
+
"disabled": false,
|
3874
4168
|
"document": "用户应用SdkAppId",
|
3875
4169
|
"member": "int64",
|
3876
4170
|
"name": "SdkAppId",
|
@@ -3880,6 +4174,7 @@
|
|
3880
4174
|
},
|
3881
4175
|
{
|
3882
4176
|
"default": "",
|
4177
|
+
"disabled": false,
|
3883
4178
|
"document": "实时录制结果",
|
3884
4179
|
"member": "RecordTaskResult",
|
3885
4180
|
"name": "Result",
|
@@ -3895,6 +4190,7 @@
|
|
3895
4190
|
"members": [
|
3896
4191
|
{
|
3897
4192
|
"default": "",
|
4193
|
+
"disabled": false,
|
3898
4194
|
"document": "客户的SdkAppId",
|
3899
4195
|
"member": "int64",
|
3900
4196
|
"name": "SdkAppId",
|
@@ -3903,6 +4199,7 @@
|
|
3903
4199
|
},
|
3904
4200
|
{
|
3905
4201
|
"default": "",
|
4202
|
+
"disabled": false,
|
3906
4203
|
"document": "恢复录制的实时录制任务 Id",
|
3907
4204
|
"member": "string",
|
3908
4205
|
"name": "TaskId",
|
@@ -3929,6 +4226,7 @@
|
|
3929
4226
|
"members": [
|
3930
4227
|
{
|
3931
4228
|
"default": "",
|
4229
|
+
"disabled": false,
|
3932
4230
|
"document": "房间ID",
|
3933
4231
|
"example": "100000",
|
3934
4232
|
"member": "string",
|
@@ -3939,6 +4237,7 @@
|
|
3939
4237
|
},
|
3940
4238
|
{
|
3941
4239
|
"default": "",
|
4240
|
+
"disabled": false,
|
3942
4241
|
"document": "房间在查询时间段内最早出现的时间,Unix时间戳,单位毫秒",
|
3943
4242
|
"example": "1614519034000",
|
3944
4243
|
"member": "int64",
|
@@ -3949,6 +4248,7 @@
|
|
3949
4248
|
},
|
3950
4249
|
{
|
3951
4250
|
"default": "",
|
4251
|
+
"disabled": false,
|
3952
4252
|
"document": "房间在查询时间段内最晚出现的时间,Unix时间戳,单位毫秒",
|
3953
4253
|
"example": "1614519034000",
|
3954
4254
|
"member": "int64",
|
@@ -3959,6 +4259,7 @@
|
|
3959
4259
|
},
|
3960
4260
|
{
|
3961
4261
|
"default": "",
|
4262
|
+
"disabled": false,
|
3962
4263
|
"document": "房间里成员数",
|
3963
4264
|
"example": "100",
|
3964
4265
|
"member": "int64",
|
@@ -3975,6 +4276,7 @@
|
|
3975
4276
|
"members": [
|
3976
4277
|
{
|
3977
4278
|
"default": "",
|
4279
|
+
"disabled": false,
|
3978
4280
|
"document": "日期,格式为YYYY-MM-DD",
|
3979
4281
|
"example": "2021-10-01",
|
3980
4282
|
"member": "string",
|
@@ -3985,6 +4287,7 @@
|
|
3985
4287
|
},
|
3986
4288
|
{
|
3987
4289
|
"default": "",
|
4290
|
+
"disabled": false,
|
3988
4291
|
"document": "白板应用SDKAppID",
|
3989
4292
|
"example": "1400000001",
|
3990
4293
|
"member": "int64",
|
@@ -3995,6 +4298,7 @@
|
|
3995
4298
|
},
|
3996
4299
|
{
|
3997
4300
|
"default": "",
|
4301
|
+
"disabled": false,
|
3998
4302
|
"document": "互动白板子产品,请求参数传入的一致\n- sp_tiw_board: 互动白板时长\n- sp_tiw_ric: 实时录制时长",
|
3999
4303
|
"example": "sp_tiw_board",
|
4000
4304
|
"member": "string",
|
@@ -4005,6 +4309,7 @@
|
|
4005
4309
|
},
|
4006
4310
|
{
|
4007
4311
|
"default": "",
|
4312
|
+
"disabled": false,
|
4008
4313
|
"document": "用量值\n- 白板时长、实时录制时长单位为分钟",
|
4009
4314
|
"example": "100000",
|
4010
4315
|
"member": "float",
|
@@ -4015,6 +4320,7 @@
|
|
4015
4320
|
},
|
4016
4321
|
{
|
4017
4322
|
"default": "",
|
4323
|
+
"disabled": false,
|
4018
4324
|
"document": "互动白板房间号",
|
4019
4325
|
"example": "12345",
|
4020
4326
|
"member": "uint64",
|
@@ -4030,6 +4336,7 @@
|
|
4030
4336
|
"document": "正在运行的任务列表项",
|
4031
4337
|
"members": [
|
4032
4338
|
{
|
4339
|
+
"disabled": false,
|
4033
4340
|
"document": "应用SdkAppID",
|
4034
4341
|
"example": "1400000001",
|
4035
4342
|
"member": "int64",
|
@@ -4039,6 +4346,7 @@
|
|
4039
4346
|
"value_allowed_null": false
|
4040
4347
|
},
|
4041
4348
|
{
|
4349
|
+
"disabled": false,
|
4042
4350
|
"document": "任务ID",
|
4043
4351
|
"example": "0agdnligqtgtvkm65emb",
|
4044
4352
|
"member": "string",
|
@@ -4048,6 +4356,7 @@
|
|
4048
4356
|
"value_allowed_null": false
|
4049
4357
|
},
|
4050
4358
|
{
|
4359
|
+
"disabled": false,
|
4051
4360
|
"document": "任务类型\n- TranscodeH5: 动态转码任务,文档转HTML5页面\n- TranscodeJPG: 静态转码任务,文档转图片\n- WhiteboardPush: 白板推流任务\n- OnlineRecord: 实时录制任务",
|
4052
4361
|
"example": "WhiteboardPush",
|
4053
4362
|
"member": "string",
|
@@ -4057,6 +4366,7 @@
|
|
4057
4366
|
"value_allowed_null": false
|
4058
4367
|
},
|
4059
4368
|
{
|
4369
|
+
"disabled": false,
|
4060
4370
|
"document": "任务创建时间",
|
4061
4371
|
"example": "2023-03-14 15:00:00",
|
4062
4372
|
"member": "string",
|
@@ -4066,6 +4376,7 @@
|
|
4066
4376
|
"value_allowed_null": false
|
4067
4377
|
},
|
4068
4378
|
{
|
4379
|
+
"disabled": false,
|
4069
4380
|
"document": "任务取消时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
4070
4381
|
"example": "2023-03-14 20:00:00",
|
4071
4382
|
"member": "string",
|
@@ -4075,6 +4386,7 @@
|
|
4075
4386
|
"value_allowed_null": true
|
4076
4387
|
},
|
4077
4388
|
{
|
4389
|
+
"disabled": false,
|
4078
4390
|
"document": "任务状态\n- QUEUED: 任务正在排队等待执行中\n- PROCESSING: 任务正在执行中 \n- FINISHED: 任务已完成",
|
4079
4391
|
"example": "QUEUED",
|
4080
4392
|
"member": "string",
|
@@ -4084,6 +4396,7 @@
|
|
4084
4396
|
"value_allowed_null": false
|
4085
4397
|
},
|
4086
4398
|
{
|
4399
|
+
"disabled": false,
|
4087
4400
|
"document": "任务当前进度",
|
4088
4401
|
"example": "50",
|
4089
4402
|
"member": "int64",
|
@@ -4093,6 +4406,7 @@
|
|
4093
4406
|
"value_allowed_null": false
|
4094
4407
|
},
|
4095
4408
|
{
|
4409
|
+
"disabled": false,
|
4096
4410
|
"document": "转码任务中转码文件的原始URL\n此参数只有任务类型为TranscodeH5、TranscodeJPG类型时才会有有效值。其他任务类型为空字符串。\n注意:此字段可能返回 null,表示取不到有效值。",
|
4097
4411
|
"example": "http://xxx.pptx",
|
4098
4412
|
"member": "string",
|
@@ -4102,6 +4416,7 @@
|
|
4102
4416
|
"value_allowed_null": true
|
4103
4417
|
},
|
4104
4418
|
{
|
4419
|
+
"disabled": false,
|
4105
4420
|
"document": "房间号\n\n当任务类型为TranscodeH5、TranscodeJPG时,房间号为0。\n注意:此字段可能返回 null,表示取不到有效值。",
|
4106
4421
|
"example": "12345",
|
4107
4422
|
"member": "int64",
|
@@ -4118,6 +4433,7 @@
|
|
4118
4433
|
"members": [
|
4119
4434
|
{
|
4120
4435
|
"default": "",
|
4436
|
+
"disabled": false,
|
4121
4437
|
"document": "客户的SdkAppId",
|
4122
4438
|
"member": "int64",
|
4123
4439
|
"name": "SdkAppId",
|
@@ -4126,6 +4442,7 @@
|
|
4126
4442
|
},
|
4127
4443
|
{
|
4128
4444
|
"default": "",
|
4445
|
+
"disabled": false,
|
4129
4446
|
"document": "课后录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头",
|
4130
4447
|
"member": "string",
|
4131
4448
|
"name": "Callback",
|
@@ -4152,6 +4469,7 @@
|
|
4152
4469
|
"members": [
|
4153
4470
|
{
|
4154
4471
|
"default": "",
|
4472
|
+
"disabled": false,
|
4155
4473
|
"document": "应用的SdkAppId",
|
4156
4474
|
"member": "int64",
|
4157
4475
|
"name": "SdkAppId",
|
@@ -4160,6 +4478,7 @@
|
|
4160
4478
|
},
|
4161
4479
|
{
|
4162
4480
|
"default": "",
|
4481
|
+
"disabled": false,
|
4163
4482
|
"document": "设置实时录制回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257",
|
4164
4483
|
"member": "string",
|
4165
4484
|
"name": "CallbackKey",
|
@@ -4186,6 +4505,7 @@
|
|
4186
4505
|
"members": [
|
4187
4506
|
{
|
4188
4507
|
"default": "",
|
4508
|
+
"disabled": false,
|
4189
4509
|
"document": "客户的SdkAppId",
|
4190
4510
|
"example": "1400000001",
|
4191
4511
|
"member": "int64",
|
@@ -4195,6 +4515,7 @@
|
|
4195
4515
|
},
|
4196
4516
|
{
|
4197
4517
|
"default": "",
|
4518
|
+
"disabled": false,
|
4198
4519
|
"document": "实时录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40258",
|
4199
4520
|
"example": "https://example.com/online/callback",
|
4200
4521
|
"member": "string",
|
@@ -4221,6 +4542,7 @@
|
|
4221
4542
|
"document": "SetPPTCheckCallbackKey请求参数结构体",
|
4222
4543
|
"members": [
|
4223
4544
|
{
|
4545
|
+
"disabled": false,
|
4224
4546
|
"document": "应用的SdkAppId",
|
4225
4547
|
"example": "1400000001",
|
4226
4548
|
"member": "int64",
|
@@ -4229,6 +4551,7 @@
|
|
4229
4551
|
"type": "int"
|
4230
4552
|
},
|
4231
4553
|
{
|
4554
|
+
"disabled": false,
|
4232
4555
|
"document": "设置回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257\t",
|
4233
4556
|
"example": "无",
|
4234
4557
|
"member": "string",
|
@@ -4255,6 +4578,7 @@
|
|
4255
4578
|
"document": "SetPPTCheckCallback请求参数结构体",
|
4256
4579
|
"members": [
|
4257
4580
|
{
|
4581
|
+
"disabled": false,
|
4258
4582
|
"document": "客户的SdkAppId\t",
|
4259
4583
|
"example": "1400000001",
|
4260
4584
|
"member": "int64",
|
@@ -4263,6 +4587,7 @@
|
|
4263
4587
|
"type": "int"
|
4264
4588
|
},
|
4265
4589
|
{
|
4590
|
+
"disabled": false,
|
4266
4591
|
"document": "进度回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持http或https协议,即回调地址以http://或https://开头。 回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40260#c9cbe05f-fe1a-4410-b4dc-40cc301c7b81\t",
|
4267
4592
|
"example": "https://example.com/transcode/callback",
|
4268
4593
|
"member": "string",
|
@@ -4290,6 +4615,7 @@
|
|
4290
4615
|
"members": [
|
4291
4616
|
{
|
4292
4617
|
"default": "",
|
4618
|
+
"disabled": false,
|
4293
4619
|
"document": "应用的SdkAppId",
|
4294
4620
|
"member": "int64",
|
4295
4621
|
"name": "SdkAppId",
|
@@ -4298,6 +4624,7 @@
|
|
4298
4624
|
},
|
4299
4625
|
{
|
4300
4626
|
"default": "",
|
4627
|
+
"disabled": false,
|
4301
4628
|
"document": "设置文档转码回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257",
|
4302
4629
|
"member": "string",
|
4303
4630
|
"name": "CallbackKey",
|
@@ -4324,6 +4651,7 @@
|
|
4324
4651
|
"members": [
|
4325
4652
|
{
|
4326
4653
|
"default": "",
|
4654
|
+
"disabled": false,
|
4327
4655
|
"document": "客户的SdkAppId",
|
4328
4656
|
"example": "1400000001",
|
4329
4657
|
"member": "int64",
|
@@ -4333,6 +4661,7 @@
|
|
4333
4661
|
},
|
4334
4662
|
{
|
4335
4663
|
"default": "",
|
4664
|
+
"disabled": false,
|
4336
4665
|
"document": "文档转码进度回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持http或https协议,即回调地址以http://或https://开头。\n回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40260",
|
4337
4666
|
"example": "https://example.com/transcode/callback",
|
4338
4667
|
"member": "string",
|
@@ -4360,6 +4689,7 @@
|
|
4360
4689
|
"members": [
|
4361
4690
|
{
|
4362
4691
|
"default": "",
|
4692
|
+
"disabled": false,
|
4363
4693
|
"document": "应用的SdkAppId",
|
4364
4694
|
"member": "int64",
|
4365
4695
|
"name": "SdkAppId",
|
@@ -4368,6 +4698,7 @@
|
|
4368
4698
|
},
|
4369
4699
|
{
|
4370
4700
|
"default": "",
|
4701
|
+
"disabled": false,
|
4371
4702
|
"document": "设置视频生成回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥",
|
4372
4703
|
"member": "string",
|
4373
4704
|
"name": "CallbackKey",
|
@@ -4394,6 +4725,7 @@
|
|
4394
4725
|
"members": [
|
4395
4726
|
{
|
4396
4727
|
"default": "",
|
4728
|
+
"disabled": false,
|
4397
4729
|
"document": "客户的SdkAppId",
|
4398
4730
|
"member": "int64",
|
4399
4731
|
"name": "SdkAppId",
|
@@ -4402,6 +4734,7 @@
|
|
4402
4734
|
},
|
4403
4735
|
{
|
4404
4736
|
"default": "",
|
4737
|
+
"disabled": false,
|
4405
4738
|
"document": "课后录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头",
|
4406
4739
|
"member": "string",
|
4407
4740
|
"name": "Callback",
|
@@ -4427,6 +4760,7 @@
|
|
4427
4760
|
"document": "SetWarningCallback请求参数结构体",
|
4428
4761
|
"members": [
|
4429
4762
|
{
|
4763
|
+
"disabled": false,
|
4430
4764
|
"document": "客户的SdkAppId",
|
4431
4765
|
"example": "1400000001",
|
4432
4766
|
"member": "int64",
|
@@ -4435,6 +4769,7 @@
|
|
4435
4769
|
"type": "int"
|
4436
4770
|
},
|
4437
4771
|
{
|
4772
|
+
"disabled": false,
|
4438
4773
|
"document": "告警回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持http或https协议,即回调地址以http://或https://开头。\n回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/90112",
|
4439
4774
|
"example": "https://example.com/transcode/callback",
|
4440
4775
|
"member": "string",
|
@@ -4443,6 +4778,7 @@
|
|
4443
4778
|
"type": "string"
|
4444
4779
|
},
|
4445
4780
|
{
|
4781
|
+
"disabled": false,
|
4446
4782
|
"document": "设置告警回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257",
|
4447
4783
|
"example": "123456",
|
4448
4784
|
"member": "string",
|
@@ -4470,6 +4806,7 @@
|
|
4470
4806
|
"members": [
|
4471
4807
|
{
|
4472
4808
|
"default": "",
|
4809
|
+
"disabled": false,
|
4473
4810
|
"document": "应用的SdkAppId",
|
4474
4811
|
"member": "int64",
|
4475
4812
|
"name": "SdkAppId",
|
@@ -4478,6 +4815,7 @@
|
|
4478
4815
|
},
|
4479
4816
|
{
|
4480
4817
|
"default": "",
|
4818
|
+
"disabled": false,
|
4481
4819
|
"document": "设置白板推流回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257",
|
4482
4820
|
"member": "string",
|
4483
4821
|
"name": "CallbackKey",
|
@@ -4504,6 +4842,7 @@
|
|
4504
4842
|
"members": [
|
4505
4843
|
{
|
4506
4844
|
"default": "",
|
4845
|
+
"disabled": false,
|
4507
4846
|
"document": "客户的SdkAppId",
|
4508
4847
|
"example": "1400000001",
|
4509
4848
|
"member": "int64",
|
@@ -4513,6 +4852,7 @@
|
|
4513
4852
|
},
|
4514
4853
|
{
|
4515
4854
|
"default": "",
|
4855
|
+
"disabled": false,
|
4516
4856
|
"document": "白板推流任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40257",
|
4517
4857
|
"example": "https://example.com/online/callback",
|
4518
4858
|
"member": "string",
|
@@ -4540,6 +4880,7 @@
|
|
4540
4880
|
"members": [
|
4541
4881
|
{
|
4542
4882
|
"default": "",
|
4883
|
+
"disabled": false,
|
4543
4884
|
"document": "cos所在腾讯云帐号uin",
|
4544
4885
|
"example": "100006912345",
|
4545
4886
|
"member": "uint64",
|
@@ -4550,6 +4891,7 @@
|
|
4550
4891
|
},
|
4551
4892
|
{
|
4552
4893
|
"default": "",
|
4894
|
+
"disabled": false,
|
4553
4895
|
"document": "cos所在地区",
|
4554
4896
|
"example": "ap-guangzhou",
|
4555
4897
|
"member": "string",
|
@@ -4560,6 +4902,7 @@
|
|
4560
4902
|
},
|
4561
4903
|
{
|
4562
4904
|
"default": "",
|
4905
|
+
"disabled": false,
|
4563
4906
|
"document": "cos存储桶名称",
|
4564
4907
|
"example": "examplebucket-1250000000",
|
4565
4908
|
"member": "string",
|
@@ -4570,6 +4913,7 @@
|
|
4570
4913
|
},
|
4571
4914
|
{
|
4572
4915
|
"default": "",
|
4916
|
+
"disabled": false,
|
4573
4917
|
"document": "板书文件存储根目录",
|
4574
4918
|
"example": "snapshot",
|
4575
4919
|
"member": "string",
|
@@ -4580,6 +4924,7 @@
|
|
4580
4924
|
},
|
4581
4925
|
{
|
4582
4926
|
"default": "",
|
4927
|
+
"disabled": false,
|
4583
4928
|
"document": "CDN加速域名",
|
4584
4929
|
"example": "xxxx.file.qcloud.com",
|
4585
4930
|
"member": "string",
|
@@ -4596,6 +4941,7 @@
|
|
4596
4941
|
"members": [
|
4597
4942
|
{
|
4598
4943
|
"default": "",
|
4944
|
+
"disabled": false,
|
4599
4945
|
"document": "任务执行错误码\n注意:此字段可能返回 null,表示取不到有效值。",
|
4600
4946
|
"example": "InternalErr",
|
4601
4947
|
"member": "string",
|
@@ -4606,6 +4952,7 @@
|
|
4606
4952
|
},
|
4607
4953
|
{
|
4608
4954
|
"default": "",
|
4955
|
+
"disabled": false,
|
4609
4956
|
"document": "任务执行错误信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
4610
4957
|
"example": "redis connect failed",
|
4611
4958
|
"member": "string",
|
@@ -4616,6 +4963,7 @@
|
|
4616
4963
|
},
|
4617
4964
|
{
|
4618
4965
|
"default": "",
|
4966
|
+
"disabled": false,
|
4619
4967
|
"document": "快照生成图片总数\n注意:此字段可能返回 null,表示取不到有效值。",
|
4620
4968
|
"example": "12",
|
4621
4969
|
"member": "uint64",
|
@@ -4626,6 +4974,7 @@
|
|
4626
4974
|
},
|
4627
4975
|
{
|
4628
4976
|
"default": "",
|
4977
|
+
"disabled": false,
|
4629
4978
|
"document": "快照图片链接列表\n注意:此字段可能返回 null,表示取不到有效值。",
|
4630
4979
|
"example": "无",
|
4631
4980
|
"member": "string",
|
@@ -4642,6 +4991,7 @@
|
|
4642
4991
|
"members": [
|
4643
4992
|
{
|
4644
4993
|
"default": "",
|
4994
|
+
"disabled": false,
|
4645
4995
|
"document": "白板宽度大小,默认为1280,有效取值范围[0,2560]",
|
4646
4996
|
"example": "1280",
|
4647
4997
|
"member": "uint64",
|
@@ -4652,6 +5002,7 @@
|
|
4652
5002
|
},
|
4653
5003
|
{
|
4654
5004
|
"default": "",
|
5005
|
+
"disabled": false,
|
4655
5006
|
"document": "白板高度大小,默认为720,有效取值范围[0,2560]",
|
4656
5007
|
"example": "960",
|
4657
5008
|
"member": "uint64",
|
@@ -4662,6 +5013,7 @@
|
|
4662
5013
|
},
|
4663
5014
|
{
|
4664
5015
|
"default": "",
|
5016
|
+
"disabled": false,
|
4665
5017
|
"document": "白板初始化参数的JSON转义字符串,透传到白板 SDK",
|
4666
5018
|
"example": "{\\\"ratio\\\":\\\"4:3\\\"}",
|
4667
5019
|
"member": "string",
|
@@ -4678,6 +5030,7 @@
|
|
4678
5030
|
"members": [
|
4679
5031
|
{
|
4680
5032
|
"default": "",
|
5033
|
+
"disabled": false,
|
4681
5034
|
"document": "客户的SdkAppId",
|
4682
5035
|
"example": "1400000001",
|
4683
5036
|
"member": "int64",
|
@@ -4687,6 +5040,7 @@
|
|
4687
5040
|
},
|
4688
5041
|
{
|
4689
5042
|
"default": "",
|
5043
|
+
"disabled": false,
|
4690
5044
|
"document": "需要录制的房间号,取值范围: (1, 4294967295)",
|
4691
5045
|
"example": "12345",
|
4692
5046
|
"member": "int64",
|
@@ -4696,6 +5050,7 @@
|
|
4696
5050
|
},
|
4697
5051
|
{
|
4698
5052
|
"default": "",
|
5053
|
+
"disabled": false,
|
4699
5054
|
"document": "用于录制服务进房的用户ID,最大长度不能大于60个字节,格式为`tic_record_user_${RoomId}_${Random}`,其中 `${RoomId} `与录制房间号对应,`${Random}`为一个随机字符串。\n该ID必须是一个单独的未在SDK中使用的ID,录制服务使用这个用户ID进入房间进行音视频与白板录制,若该ID和SDK中使用的ID重复,会导致SDK和录制服务互踢,影响正常录制。",
|
4700
5055
|
"example": "tic_record_user_880528_1258",
|
4701
5056
|
"member": "string",
|
@@ -4705,6 +5060,7 @@
|
|
4705
5060
|
},
|
4706
5061
|
{
|
4707
5062
|
"default": "",
|
5063
|
+
"disabled": false,
|
4708
5064
|
"document": "与RecordUserId对应的签名",
|
4709
5065
|
"example": "eJwtjb0OgjAAhN*lK4a0tcVC4iDGkIg-g7K4NEiLViLUUsFgfHcRmS733eXuDY6b",
|
4710
5066
|
"member": "string",
|
@@ -4714,6 +5070,7 @@
|
|
4714
5070
|
},
|
4715
5071
|
{
|
4716
5072
|
"default": "",
|
5073
|
+
"disabled": false,
|
4717
5074
|
"document": "(已废弃,设置无效)白板的 IM 群组 Id,默认同房间号",
|
4718
5075
|
"example": "12345",
|
4719
5076
|
"member": "string",
|
@@ -4723,6 +5080,7 @@
|
|
4723
5080
|
},
|
4724
5081
|
{
|
4725
5082
|
"default": "",
|
5083
|
+
"disabled": false,
|
4726
5084
|
"document": "录制视频拼接参数",
|
4727
5085
|
"example": "无",
|
4728
5086
|
"member": "Concat",
|
@@ -4732,6 +5090,7 @@
|
|
4732
5090
|
},
|
4733
5091
|
{
|
4734
5092
|
"default": "",
|
5093
|
+
"disabled": false,
|
4735
5094
|
"document": "录制白板参数,例如白板宽高等",
|
4736
5095
|
"example": "无",
|
4737
5096
|
"member": "Whiteboard",
|
@@ -4741,6 +5100,7 @@
|
|
4741
5100
|
},
|
4742
5101
|
{
|
4743
5102
|
"default": "",
|
5103
|
+
"disabled": false,
|
4744
5104
|
"document": "录制混流参数\n特别说明:\n1. 混流功能需要根据额外开通, 请联系腾讯云互动白板客服人员\n2. 使用混流功能,必须提供 Extras 参数,且 Extras 参数中必须包含 \"MIX_STREAM\"",
|
4745
5105
|
"example": "无",
|
4746
5106
|
"member": "MixStream",
|
@@ -4750,6 +5110,7 @@
|
|
4750
5110
|
},
|
4751
5111
|
{
|
4752
5112
|
"default": "",
|
5113
|
+
"disabled": false,
|
4753
5114
|
"document": "使用到的高级功能列表\n可以选值列表:\nMIX_STREAM - 混流功能",
|
4754
5115
|
"example": "[\"MixStream\"]",
|
4755
5116
|
"member": "string",
|
@@ -4759,6 +5120,7 @@
|
|
4759
5120
|
},
|
4760
5121
|
{
|
4761
5122
|
"default": "",
|
5123
|
+
"disabled": false,
|
4762
5124
|
"document": "是否需要在结果回调中返回各路流的纯音频录制文件,文件格式为mp3",
|
4763
5125
|
"example": "false",
|
4764
5126
|
"member": "bool",
|
@@ -4768,6 +5130,7 @@
|
|
4768
5130
|
},
|
4769
5131
|
{
|
4770
5132
|
"default": "",
|
5133
|
+
"disabled": false,
|
4771
5134
|
"document": "录制控制参数,用于更精细地指定需要录制哪些流,某一路流是否禁用音频,是否只录制小画面等",
|
4772
5135
|
"example": "无",
|
4773
5136
|
"member": "RecordControl",
|
@@ -4777,6 +5140,7 @@
|
|
4777
5140
|
},
|
4778
5141
|
{
|
4779
5142
|
"default": "",
|
5143
|
+
"disabled": false,
|
4780
5144
|
"document": "录制模式\n\nREALTIME_MODE - 实时录制模式(默认)\nVIDEO_GENERATION_MODE - 视频生成模式(内测中,需邮件申请开通)",
|
4781
5145
|
"example": "REALTIME_MODE",
|
4782
5146
|
"member": "string",
|
@@ -4786,6 +5150,7 @@
|
|
4786
5150
|
},
|
4787
5151
|
{
|
4788
5152
|
"default": "",
|
5153
|
+
"disabled": false,
|
4789
5154
|
"document": "聊天群组ID,此字段仅适用于`视频生成模式`\n\n在`视频生成模式`下,默认会记录白板群组内的非白板信令消息,如果指定了`ChatGroupId`,则会记录指定群ID的聊天消息。",
|
4790
5155
|
"example": "12345",
|
4791
5156
|
"member": "string",
|
@@ -4795,6 +5160,7 @@
|
|
4795
5160
|
},
|
4796
5161
|
{
|
4797
5162
|
"default": "",
|
5163
|
+
"disabled": false,
|
4798
5164
|
"document": "自动停止录制超时时间,单位秒,取值范围[300, 86400], 默认值为300秒。\n\n当超过设定时间房间内没有音视频上行且没有白板操作的时候,录制服务会自动停止当前录制任务。",
|
4799
5165
|
"example": "300",
|
4800
5166
|
"member": "int64",
|
@@ -4804,6 +5170,7 @@
|
|
4804
5170
|
},
|
4805
5171
|
{
|
4806
5172
|
"default": "",
|
5173
|
+
"disabled": false,
|
4807
5174
|
"document": "内部参数,可忽略",
|
4808
5175
|
"example": "无",
|
4809
5176
|
"member": "string",
|
@@ -4818,6 +5185,7 @@
|
|
4818
5185
|
"document": "StartOnlineRecord返回参数结构体",
|
4819
5186
|
"members": [
|
4820
5187
|
{
|
5188
|
+
"disabled": false,
|
4821
5189
|
"document": "录制任务Id",
|
4822
5190
|
"example": "0c69baivvc3lp8t4f80b",
|
4823
5191
|
"member": "string",
|
@@ -4839,6 +5207,7 @@
|
|
4839
5207
|
"document": "StartWhiteboardPush请求参数结构体",
|
4840
5208
|
"members": [
|
4841
5209
|
{
|
5210
|
+
"disabled": false,
|
4842
5211
|
"document": "客户的SdkAppId",
|
4843
5212
|
"example": "1400000001",
|
4844
5213
|
"member": "int64",
|
@@ -4847,6 +5216,7 @@
|
|
4847
5216
|
"type": "int"
|
4848
5217
|
},
|
4849
5218
|
{
|
5219
|
+
"disabled": false,
|
4850
5220
|
"document": "需要推流的白板房间号,取值范围: (1, 4294967295)。\n\n1. 白板推流默认以RoomId的字符串表达形式作为IM群组的GroupID(比如RoomId为1234,则IM群组的GroupID为\"1234\")加群进行信令同步,请在开始推流前确保相应IM群组已创建完成,否则会导致推流失败。\n2. 在没有指定TRTCRoomId和TRTCRoomIdStr的情况下,默认会以RoomId作为白板流进行推流的TRTC房间号。",
|
4851
5221
|
"example": "12345",
|
4852
5222
|
"member": "int64",
|
@@ -4855,6 +5225,7 @@
|
|
4855
5225
|
"type": "int"
|
4856
5226
|
},
|
4857
5227
|
{
|
5228
|
+
"disabled": false,
|
4858
5229
|
"document": "用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下,这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。\n用户ID最大长度不能大于60个字节,该用户ID必须是一个单独的未同时在其他地方使用的用户ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该用户ID和其他地方同时在使用的用户ID重复,会导致白板推流服务与其他使用场景帐号互踢,影响正常推流。",
|
4859
5230
|
"example": "tic_push_12345_xxx",
|
4860
5231
|
"member": "string",
|
@@ -4863,6 +5234,7 @@
|
|
4863
5234
|
"type": "string"
|
4864
5235
|
},
|
4865
5236
|
{
|
5237
|
+
"disabled": false,
|
4866
5238
|
"document": "与PushUserId对应的IM签名(usersig)。",
|
4867
5239
|
"example": "eJwtjb0OgjAAhN*lK4a0tcVC4iDGkIg-g7K4NEiLViLUUsFgfHcRmS733eXuDY6b",
|
4868
5240
|
"member": "string",
|
@@ -4871,6 +5243,7 @@
|
|
4871
5243
|
"type": "string"
|
4872
5244
|
},
|
4873
5245
|
{
|
5246
|
+
"disabled": false,
|
4874
5247
|
"document": "白板参数,例如白板宽高、背景颜色等",
|
4875
5248
|
"example": "无",
|
4876
5249
|
"member": "Whiteboard",
|
@@ -4879,6 +5252,7 @@
|
|
4879
5252
|
"type": "object"
|
4880
5253
|
},
|
4881
5254
|
{
|
5255
|
+
"disabled": false,
|
4882
5256
|
"document": "自动停止推流超时时间,单位秒,取值范围[300, 259200], 默认值为1800秒。\n\n当白板超过设定时间没有操作的时候,白板推流服务会自动停止白板推流。",
|
4883
5257
|
"example": "300",
|
4884
5258
|
"member": "int64",
|
@@ -4887,6 +5261,7 @@
|
|
4887
5261
|
"type": "int"
|
4888
5262
|
},
|
4889
5263
|
{
|
5264
|
+
"disabled": false,
|
4890
5265
|
"document": "对主白板推流任务进行操作时,是否同时同步操作备份任务",
|
4891
5266
|
"example": "false",
|
4892
5267
|
"member": "bool",
|
@@ -4895,6 +5270,7 @@
|
|
4895
5270
|
"type": "bool"
|
4896
5271
|
},
|
4897
5272
|
{
|
5273
|
+
"disabled": false,
|
4898
5274
|
"document": "备份白板推流相关参数。\n\n指定了备份参数的情况下,白板推流服务会在房间内新增一路白板画面视频流,即同一个房间内会有两路白板画面推流。",
|
4899
5275
|
"example": "无",
|
4900
5276
|
"member": "WhiteboardPushBackupParam",
|
@@ -4903,6 +5279,7 @@
|
|
4903
5279
|
"type": "object"
|
4904
5280
|
},
|
4905
5281
|
{
|
5282
|
+
"disabled": false,
|
4906
5283
|
"document": "TRTC高级权限控制参数,如果在实时音视频开启了高级权限控制功能,必须提供PrivateMapKey才能保证正常推流。",
|
4907
5284
|
"example": "无",
|
4908
5285
|
"member": "string",
|
@@ -4911,6 +5288,7 @@
|
|
4911
5288
|
"type": "string"
|
4912
5289
|
},
|
4913
5290
|
{
|
5291
|
+
"disabled": false,
|
4914
5292
|
"document": "白板推流视频帧率,取值范围[0, 30],默认20fps",
|
4915
5293
|
"example": "15",
|
4916
5294
|
"member": "int64",
|
@@ -4919,6 +5297,7 @@
|
|
4919
5297
|
"type": "int"
|
4920
5298
|
},
|
4921
5299
|
{
|
5300
|
+
"disabled": false,
|
4922
5301
|
"document": "白板推流码率, 取值范围[0, 2000],默认1200kbps。\n\n这里的码率设置是一个参考值,实际推流的时候使用的是动态码率,所以真实码率不会固定为指定值,会在指定值附近波动。",
|
4923
5302
|
"example": "1200",
|
4924
5303
|
"member": "int64",
|
@@ -4927,6 +5306,7 @@
|
|
4927
5306
|
"type": "int"
|
4928
5307
|
},
|
4929
5308
|
{
|
5309
|
+
"disabled": false,
|
4930
5310
|
"document": "在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。\n\n默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下,不会自动进行白板推流录制,如果希望进行白板推流录制,请将此参数设置为true。\n\n如果实时音视频的云端录制模式选择为 `全局自动录制` 模式,可忽略此参数。",
|
4931
5311
|
"example": "false",
|
4932
5312
|
"member": "bool",
|
@@ -4935,6 +5315,7 @@
|
|
4935
5315
|
"type": "bool"
|
4936
5316
|
},
|
4937
5317
|
{
|
5318
|
+
"disabled": false,
|
4938
5319
|
"document": "指定白板推流录制的RecordID,指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 \"userdefinerecordid\" 字段内容,便于您更方便的识别录制回调,以及在点播媒体资源管理中查找相应的录制视频文件。\n\n限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。\n\n此字段设置后,不管`AutoRecord`字段取值如何,都将自动进行白板推流录制。\n\n默认RecordId生成规则如下:\nurlencode(SdkAppID_RoomID_PushUserID)\n\n例如:\nSdkAppID = 12345678,RoomID = 12345,PushUserID = push_user_1\n那么:RecordId = 12345678_12345_push_user_1",
|
4939
5320
|
"example": "12345678_12345_push_user_1",
|
4940
5321
|
"member": "string",
|
@@ -4943,6 +5324,7 @@
|
|
4943
5324
|
"type": "string"
|
4944
5325
|
},
|
4945
5326
|
{
|
5327
|
+
"disabled": false,
|
4946
5328
|
"document": "在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候,是否自动旁路白板推流。\n\n默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下,不会自动旁路白板推流,如果希望旁路白板推流,请将此参数设置为true。\n\n如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式,可忽略此参数。",
|
4947
5329
|
"example": "false",
|
4948
5330
|
"member": "bool",
|
@@ -4951,6 +5333,7 @@
|
|
4951
5333
|
"type": "bool"
|
4952
5334
|
},
|
4953
5335
|
{
|
5336
|
+
"disabled": false,
|
4954
5337
|
"document": "指定实时音视频在旁路白板推流时的StreamID,设置之后,您就可以在腾讯云直播 CDN 上通过标准直播方案(FLV或HLS)播放该用户的音视频流。\n\n限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。\n\n此字段设置后,不管`AutoPublish`字段取值如何,都将自动旁路白板推流。\n\n默认StreamID生成规则如下:\nurlencode(SdkAppID_RoomID_PushUserID_main)\n\n例如:\nSdkAppID = 12345678,RoomID = 12345,PushUserID = push_user_1\n那么:StreamID = 12345678_12345_push_user_1_main",
|
4955
5338
|
"example": "12345678_12345_push_user_1_main",
|
4956
5339
|
"member": "string",
|
@@ -4959,6 +5342,7 @@
|
|
4959
5342
|
"type": "string"
|
4960
5343
|
},
|
4961
5344
|
{
|
5345
|
+
"disabled": false,
|
4962
5346
|
"document": "内部参数,不需要关注此参数",
|
4963
5347
|
"example": "无",
|
4964
5348
|
"member": "string",
|
@@ -4967,6 +5351,7 @@
|
|
4967
5351
|
"type": "string"
|
4968
5352
|
},
|
4969
5353
|
{
|
5354
|
+
"disabled": false,
|
4970
5355
|
"document": "TRTC数字类型房间号,取值范围: (1, 4294967295)。\n\n在同时指定了RoomId与TRTCRoomId的情况下,优先使用TRTCRoomId作为白板流进行推流的TRTC房间号。\n\n当指定了TRTCRoomIdStr的情况下,此字段将被忽略。",
|
4971
5356
|
"example": "12345",
|
4972
5357
|
"member": "int64",
|
@@ -4975,6 +5360,7 @@
|
|
4975
5360
|
"type": "int"
|
4976
5361
|
},
|
4977
5362
|
{
|
5363
|
+
"disabled": false,
|
4978
5364
|
"document": "TRTC字符串类型房间号。\n\n在指定了TRTCRoomIdStr的情况下,会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。",
|
4979
5365
|
"example": "wbpush-12345",
|
4980
5366
|
"member": "string",
|
@@ -4983,6 +5369,7 @@
|
|
4983
5369
|
"type": "string"
|
4984
5370
|
},
|
4985
5371
|
{
|
5372
|
+
"disabled": false,
|
4986
5373
|
"document": "IM鉴权信息参数,用于IM鉴权。\n当白板信令所使用的IM应用与白板应用的SdkAppId不一致时,可以通过此参数提供对应IM应用鉴权信息。\n\n如果提供了此参数,白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道,否则使用公共参数中的SdkAppId作为白板信令的传输通道。",
|
4987
5374
|
"example": "无",
|
4988
5375
|
"member": "AuthParam",
|
@@ -4991,6 +5378,7 @@
|
|
4991
5378
|
"type": "object"
|
4992
5379
|
},
|
4993
5380
|
{
|
5381
|
+
"disabled": false,
|
4994
5382
|
"document": "TRTC鉴权信息参数,用于TRTC进房推流鉴权。\n当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时,可以通过此参数提供对应的TRTC应用鉴权信息。\n\n如果提供了此参数,白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用,否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。",
|
4995
5383
|
"example": "无",
|
4996
5384
|
"member": "AuthParam",
|
@@ -4999,6 +5387,7 @@
|
|
4999
5387
|
"type": "object"
|
5000
5388
|
},
|
5001
5389
|
{
|
5390
|
+
"disabled": false,
|
5002
5391
|
"document": "内测参数,需要提前申请白名单进行体验。\n\n指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall\n\nTRTCAppSceneVideoCall - 视频通话场景,即绝大多数时间都是两人或两人以上视频通话的场景,内部编码器和网络协议优化侧重流畅性,降低通话延迟和卡顿率。\nTRTCAppSceneLIVE - 直播场景,即绝大多数时间都是一人直播,偶尔有多人视频互动的场景,内部编码器和网络协议优化侧重性能和兼容性,性能和清晰度表现更佳。",
|
5003
5392
|
"example": "TRTCAppSceneVideoCall",
|
5004
5393
|
"member": "string",
|
@@ -5013,6 +5402,7 @@
|
|
5013
5402
|
"document": "StartWhiteboardPush返回参数结构体",
|
5014
5403
|
"members": [
|
5015
5404
|
{
|
5405
|
+
"disabled": false,
|
5016
5406
|
"document": "推流任务Id",
|
5017
5407
|
"example": "0c69baivvc3lp8t4f80b",
|
5018
5408
|
"member": "string",
|
@@ -5021,6 +5411,7 @@
|
|
5021
5411
|
"value_allowed_null": false
|
5022
5412
|
},
|
5023
5413
|
{
|
5414
|
+
"disabled": false,
|
5024
5415
|
"document": "备份任务结果参数\n注意:此字段可能返回 null,表示取不到有效值。",
|
5025
5416
|
"example": "无",
|
5026
5417
|
"member": "string",
|
@@ -5042,6 +5433,7 @@
|
|
5042
5433
|
"members": [
|
5043
5434
|
{
|
5044
5435
|
"default": "",
|
5436
|
+
"disabled": false,
|
5045
5437
|
"document": "客户的SdkAppId",
|
5046
5438
|
"member": "int64",
|
5047
5439
|
"name": "SdkAppId",
|
@@ -5050,6 +5442,7 @@
|
|
5050
5442
|
},
|
5051
5443
|
{
|
5052
5444
|
"default": "",
|
5445
|
+
"disabled": false,
|
5053
5446
|
"document": "需要停止录制的任务 Id",
|
5054
5447
|
"member": "string",
|
5055
5448
|
"name": "TaskId",
|
@@ -5076,6 +5469,7 @@
|
|
5076
5469
|
"members": [
|
5077
5470
|
{
|
5078
5471
|
"default": "",
|
5472
|
+
"disabled": false,
|
5079
5473
|
"document": "客户的SdkAppId",
|
5080
5474
|
"member": "int64",
|
5081
5475
|
"name": "SdkAppId",
|
@@ -5084,6 +5478,7 @@
|
|
5084
5478
|
},
|
5085
5479
|
{
|
5086
5480
|
"default": "",
|
5481
|
+
"disabled": false,
|
5087
5482
|
"document": "需要停止的白板推流任务 Id",
|
5088
5483
|
"member": "string",
|
5089
5484
|
"name": "TaskId",
|
@@ -5097,6 +5492,7 @@
|
|
5097
5492
|
"document": "StopWhiteboardPush返回参数结构体",
|
5098
5493
|
"members": [
|
5099
5494
|
{
|
5495
|
+
"disabled": false,
|
5100
5496
|
"document": "备份任务相关参数\n注意:此字段可能返回 null,表示取不到有效值。",
|
5101
5497
|
"member": "string",
|
5102
5498
|
"name": "Backup",
|
@@ -5117,6 +5513,7 @@
|
|
5117
5513
|
"members": [
|
5118
5514
|
{
|
5119
5515
|
"default": "",
|
5516
|
+
"disabled": false,
|
5120
5517
|
"document": "视频流ID\n视频流ID的取值含义如下:\n1. tic_record_user - 表示白板视频流\n2. tic_substream - 表示辅路视频流\n3. 特定用户ID - 表示指定用户的视频流\n\n在实际录制过程中,视频流ID的匹配规则为前缀匹配,只要真实流ID的前缀与指定的流ID一致就认为匹配成功。",
|
5121
5518
|
"member": "string",
|
5122
5519
|
"name": "StreamId",
|
@@ -5126,6 +5523,7 @@
|
|
5126
5523
|
},
|
5127
5524
|
{
|
5128
5525
|
"default": "",
|
5526
|
+
"disabled": false,
|
5129
5527
|
"document": "设置是否对此路流开启录制。\n\ntrue - 表示不对这路流进行录制,录制结果将不包含这路流的视频。\nfalse - 表示需要对这路流进行录制,录制结果会包含这路流的视频。\n\n默认为 false。",
|
5130
5528
|
"member": "bool",
|
5131
5529
|
"name": "DisableRecord",
|
@@ -5135,6 +5533,7 @@
|
|
5135
5533
|
},
|
5136
5534
|
{
|
5137
5535
|
"default": "",
|
5536
|
+
"disabled": false,
|
5138
5537
|
"document": "设置是否禁用这路流的音频录制。\n\ntrue - 表示不对这路流的音频进行录制,录制结果里这路流的视频将会没有声音。\nfalse - 录制视频会保留音频,如果设置为true,则录制视频会丢弃这路流的音频。\n\n默认为 false。",
|
5139
5538
|
"member": "bool",
|
5140
5539
|
"name": "DisableAudio",
|
@@ -5144,6 +5543,7 @@
|
|
5144
5543
|
},
|
5145
5544
|
{
|
5146
5545
|
"default": "",
|
5546
|
+
"disabled": false,
|
5147
5547
|
"document": "设置当前流录制视频是否只录制小画面。\n\ntrue - 录制小画面。设置为true时,请确保上行端同时上行了小画面,否则录制视频可能是黑屏。\nfalse - 录制大画面。\n\n默认为 false。",
|
5148
5548
|
"member": "bool",
|
5149
5549
|
"name": "PullSmallVideo",
|
@@ -5159,6 +5559,7 @@
|
|
5159
5559
|
"members": [
|
5160
5560
|
{
|
5161
5561
|
"default": "",
|
5562
|
+
"disabled": false,
|
5162
5563
|
"document": "流布局配置参数",
|
5163
5564
|
"member": "LayoutParams",
|
5164
5565
|
"name": "LayoutParams",
|
@@ -5168,6 +5569,7 @@
|
|
5168
5569
|
},
|
5169
5570
|
{
|
5170
5571
|
"default": "",
|
5572
|
+
"disabled": false,
|
5171
5573
|
"document": "视频流ID\n流ID的取值含义如下:\n1. tic_record_user - 表示当前画面用于显示白板视频流\n2. tic_substream - 表示当前画面用于显示辅路视频流\n3. 特定用户ID - 表示当前画面用于显示指定用户的视频流\n4. 不填 - 表示当前画面用于备选,当有新的视频流加入时,会从这些备选的空位中选择一个没有被占用的位置来显示新的视频流画面",
|
5172
5574
|
"member": "string",
|
5173
5575
|
"name": "InputStreamId",
|
@@ -5177,6 +5579,7 @@
|
|
5177
5579
|
},
|
5178
5580
|
{
|
5179
5581
|
"default": "",
|
5582
|
+
"disabled": false,
|
5180
5583
|
"document": "背景颜色,默认为黑色,格式为RGB格式,如红色为\"#FF0000\"",
|
5181
5584
|
"member": "string",
|
5182
5585
|
"name": "BackgroundColor",
|
@@ -5186,6 +5589,7 @@
|
|
5186
5589
|
},
|
5187
5590
|
{
|
5188
5591
|
"default": "",
|
5592
|
+
"disabled": false,
|
5189
5593
|
"document": "视频画面填充模式。\n\n0 - 自适应模式,对视频画面进行等比例缩放,在指定区域内显示完整的画面。此模式可能存在黑边。\n1 - 全屏模式,对视频画面进行等比例缩放,让画面填充满整个指定区域。此模式不会存在黑边,但会将超出区域的那一部分画面裁剪掉。",
|
5190
5594
|
"member": "int64",
|
5191
5595
|
"name": "FillMode",
|
@@ -5201,6 +5605,7 @@
|
|
5201
5605
|
"members": [
|
5202
5606
|
{
|
5203
5607
|
"default": "",
|
5608
|
+
"disabled": false,
|
5204
5609
|
"document": "标签键",
|
5205
5610
|
"member": "string",
|
5206
5611
|
"name": "TagKey",
|
@@ -5210,6 +5615,7 @@
|
|
5210
5615
|
},
|
5211
5616
|
{
|
5212
5617
|
"default": "",
|
5618
|
+
"disabled": false,
|
5213
5619
|
"document": "标签值",
|
5214
5620
|
"member": "string",
|
5215
5621
|
"name": "TagValue",
|
@@ -5225,6 +5631,7 @@
|
|
5225
5631
|
"members": [
|
5226
5632
|
{
|
5227
5633
|
"default": "",
|
5634
|
+
"disabled": false,
|
5228
5635
|
"document": "Unix时间戳,单位秒",
|
5229
5636
|
"example": "1617883200",
|
5230
5637
|
"member": "uint64",
|
@@ -5235,6 +5642,7 @@
|
|
5235
5642
|
},
|
5236
5643
|
{
|
5237
5644
|
"default": "",
|
5645
|
+
"disabled": false,
|
5238
5646
|
"document": "查询指标对应当前时间的值",
|
5239
5647
|
"example": "100",
|
5240
5648
|
"member": "float",
|
@@ -5251,6 +5659,7 @@
|
|
5251
5659
|
"members": [
|
5252
5660
|
{
|
5253
5661
|
"default": "",
|
5662
|
+
"disabled": false,
|
5254
5663
|
"document": "转码结果地址",
|
5255
5664
|
"member": "string",
|
5256
5665
|
"name": "ResultUrl",
|
@@ -5260,6 +5669,7 @@
|
|
5260
5669
|
},
|
5261
5670
|
{
|
5262
5671
|
"default": "",
|
5672
|
+
"disabled": false,
|
5263
5673
|
"document": "分辨率",
|
5264
5674
|
"member": "string",
|
5265
5675
|
"name": "Resolution",
|
@@ -5269,6 +5679,7 @@
|
|
5269
5679
|
},
|
5270
5680
|
{
|
5271
5681
|
"default": "",
|
5682
|
+
"disabled": false,
|
5272
5683
|
"document": "标题(一般为文件名)",
|
5273
5684
|
"member": "string",
|
5274
5685
|
"name": "Title",
|
@@ -5278,6 +5689,7 @@
|
|
5278
5689
|
},
|
5279
5690
|
{
|
5280
5691
|
"default": "",
|
5692
|
+
"disabled": false,
|
5281
5693
|
"document": "转码页数",
|
5282
5694
|
"member": "int64",
|
5283
5695
|
"name": "Pages",
|
@@ -5287,6 +5699,7 @@
|
|
5287
5699
|
},
|
5288
5700
|
{
|
5289
5701
|
"default": "",
|
5702
|
+
"disabled": false,
|
5290
5703
|
"document": "缩略图URL前缀,比如,该URL前缀为http://example.com/g0jb42ps49vtebjshilb/,那么动态PPT第1页的缩略图URL为\nhttp://example.com/g0jb42ps49vtebjshilb/1.jpg,其它页以此类推\n\n如果发起文档转码请求参数中带了ThumbnailResolution参数,并且转码类型为动态转码,该参数不为空,其余情况该参数为空字符串",
|
5291
5704
|
"member": "string",
|
5292
5705
|
"name": "ThumbnailUrl",
|
@@ -5296,6 +5709,7 @@
|
|
5296
5709
|
},
|
5297
5710
|
{
|
5298
5711
|
"default": "",
|
5712
|
+
"disabled": false,
|
5299
5713
|
"document": "动态转码缩略图生成分辨率",
|
5300
5714
|
"member": "string",
|
5301
5715
|
"name": "ThumbnailResolution",
|
@@ -5305,6 +5719,7 @@
|
|
5305
5719
|
},
|
5306
5720
|
{
|
5307
5721
|
"default": "",
|
5722
|
+
"disabled": false,
|
5308
5723
|
"document": "转码压缩文件下载的URL,如果发起文档转码请求参数中CompressFileType为空或者不是支持的压缩格式,该参数为空字符串",
|
5309
5724
|
"member": "string",
|
5310
5725
|
"name": "CompressFileUrl",
|
@@ -5314,6 +5729,7 @@
|
|
5314
5729
|
},
|
5315
5730
|
{
|
5316
5731
|
"default": "",
|
5732
|
+
"disabled": false,
|
5317
5733
|
"document": "任务失败错误码",
|
5318
5734
|
"member": "int64",
|
5319
5735
|
"name": "ErrorCode",
|
@@ -5323,6 +5739,7 @@
|
|
5323
5739
|
},
|
5324
5740
|
{
|
5325
5741
|
"default": "",
|
5742
|
+
"disabled": false,
|
5326
5743
|
"document": "任务失败错误信息",
|
5327
5744
|
"member": "string",
|
5328
5745
|
"name": "ErrorMsg",
|
@@ -5338,6 +5755,7 @@
|
|
5338
5755
|
"members": [
|
5339
5756
|
{
|
5340
5757
|
"default": "",
|
5758
|
+
"disabled": false,
|
5341
5759
|
"document": "任务创建时间",
|
5342
5760
|
"member": "datetime_iso",
|
5343
5761
|
"name": "CreateTime",
|
@@ -5347,6 +5765,7 @@
|
|
5347
5765
|
},
|
5348
5766
|
{
|
5349
5767
|
"default": "",
|
5768
|
+
"disabled": false,
|
5350
5769
|
"document": "任务唯一ID",
|
5351
5770
|
"member": "string",
|
5352
5771
|
"name": "TaskId",
|
@@ -5356,6 +5775,7 @@
|
|
5356
5775
|
},
|
5357
5776
|
{
|
5358
5777
|
"default": "",
|
5778
|
+
"disabled": false,
|
5359
5779
|
"document": "任务的当前状态\n- QUEUED: 正在排队等待转换\n- PROCESSING: 转换中\n- FINISHED: 转换完成",
|
5360
5780
|
"member": "string",
|
5361
5781
|
"name": "Status",
|
@@ -5365,6 +5785,7 @@
|
|
5365
5785
|
},
|
5366
5786
|
{
|
5367
5787
|
"default": "",
|
5788
|
+
"disabled": false,
|
5368
5789
|
"document": "转码文件原始名称",
|
5369
5790
|
"member": "string",
|
5370
5791
|
"name": "OriginalFilename",
|
@@ -5374,6 +5795,7 @@
|
|
5374
5795
|
},
|
5375
5796
|
{
|
5376
5797
|
"default": "",
|
5798
|
+
"disabled": false,
|
5377
5799
|
"document": "用户应用SdkAppId",
|
5378
5800
|
"member": "int64",
|
5379
5801
|
"name": "SdkAppId",
|
@@ -5383,6 +5805,7 @@
|
|
5383
5805
|
},
|
5384
5806
|
{
|
5385
5807
|
"default": "",
|
5808
|
+
"disabled": false,
|
5386
5809
|
"document": "转码任务结果",
|
5387
5810
|
"member": "TranscodeTaskResult",
|
5388
5811
|
"name": "Result",
|
@@ -5392,6 +5815,7 @@
|
|
5392
5815
|
},
|
5393
5816
|
{
|
5394
5817
|
"default": "",
|
5818
|
+
"disabled": false,
|
5395
5819
|
"document": "是否静态转码",
|
5396
5820
|
"member": "bool",
|
5397
5821
|
"name": "IsStatic",
|
@@ -5407,6 +5831,7 @@
|
|
5407
5831
|
"members": [
|
5408
5832
|
{
|
5409
5833
|
"default": "",
|
5834
|
+
"disabled": false,
|
5410
5835
|
"document": "日期,格式为YYYY-MM-DD",
|
5411
5836
|
"example": "2021-10-01",
|
5412
5837
|
"member": "string",
|
@@ -5417,6 +5842,7 @@
|
|
5417
5842
|
},
|
5418
5843
|
{
|
5419
5844
|
"default": "",
|
5845
|
+
"disabled": false,
|
5420
5846
|
"document": "白板应用SDKAppID",
|
5421
5847
|
"example": "1400000001",
|
5422
5848
|
"member": "int64",
|
@@ -5427,6 +5853,7 @@
|
|
5427
5853
|
},
|
5428
5854
|
{
|
5429
5855
|
"default": "",
|
5856
|
+
"disabled": false,
|
5430
5857
|
"document": "互动白板子产品,请求参数传入的一致\n- sp_tiw_board: 互动白板时长\n- sp_tiw_dt: 动态转码页数\n- sp_tiw_st: 静态转码页数\n- sp_tiw_ric: 实时录制时长",
|
5431
5858
|
"example": "sp_tiw_board",
|
5432
5859
|
"member": "string",
|
@@ -5437,6 +5864,7 @@
|
|
5437
5864
|
},
|
5438
5865
|
{
|
5439
5866
|
"default": "",
|
5867
|
+
"disabled": false,
|
5440
5868
|
"document": "用量值\n- 静态转码、动态转码单位为页\n- 白板时长、实时录制时长单位为分钟",
|
5441
5869
|
"example": "100000",
|
5442
5870
|
"member": "float",
|
@@ -5453,6 +5881,7 @@
|
|
5453
5881
|
"members": [
|
5454
5882
|
{
|
5455
5883
|
"default": "",
|
5884
|
+
"disabled": false,
|
5456
5885
|
"document": "房间内的用户ID",
|
5457
5886
|
"example": "100000",
|
5458
5887
|
"member": "string",
|
@@ -5463,6 +5892,7 @@
|
|
5463
5892
|
},
|
5464
5893
|
{
|
5465
5894
|
"default": "",
|
5895
|
+
"disabled": false,
|
5466
5896
|
"document": "用户在查询时间段内最早出现的时间,Unix时间戳,单位毫秒",
|
5467
5897
|
"example": "1614519034000",
|
5468
5898
|
"member": "int64",
|
@@ -5473,6 +5903,7 @@
|
|
5473
5903
|
},
|
5474
5904
|
{
|
5475
5905
|
"default": "",
|
5906
|
+
"disabled": false,
|
5476
5907
|
"document": "用户在查询时间段内最晚出现的时间,Unix时间戳,单位毫秒",
|
5477
5908
|
"example": "1614519034000",
|
5478
5909
|
"member": "int64",
|
@@ -5489,6 +5920,7 @@
|
|
5489
5920
|
"members": [
|
5490
5921
|
{
|
5491
5922
|
"default": "",
|
5923
|
+
"disabled": false,
|
5492
5924
|
"document": "视频开始播放的时间(单位:毫秒)",
|
5493
5925
|
"member": "int64",
|
5494
5926
|
"name": "VideoPlayTime",
|
@@ -5498,6 +5930,7 @@
|
|
5498
5930
|
},
|
5499
5931
|
{
|
5500
5932
|
"default": "",
|
5933
|
+
"disabled": false,
|
5501
5934
|
"document": "视频大小(字节)",
|
5502
5935
|
"member": "int64",
|
5503
5936
|
"name": "VideoSize",
|
@@ -5507,6 +5940,7 @@
|
|
5507
5940
|
},
|
5508
5941
|
{
|
5509
5942
|
"default": "",
|
5943
|
+
"disabled": false,
|
5510
5944
|
"document": "视频格式",
|
5511
5945
|
"member": "string",
|
5512
5946
|
"name": "VideoFormat",
|
@@ -5516,6 +5950,7 @@
|
|
5516
5950
|
},
|
5517
5951
|
{
|
5518
5952
|
"default": "",
|
5953
|
+
"disabled": false,
|
5519
5954
|
"document": "视频播放时长(单位:毫秒)",
|
5520
5955
|
"member": "int64",
|
5521
5956
|
"name": "VideoDuration",
|
@@ -5525,6 +5960,7 @@
|
|
5525
5960
|
},
|
5526
5961
|
{
|
5527
5962
|
"default": "",
|
5963
|
+
"disabled": false,
|
5528
5964
|
"document": "视频文件URL",
|
5529
5965
|
"member": "string",
|
5530
5966
|
"name": "VideoUrl",
|
@@ -5534,6 +5970,7 @@
|
|
5534
5970
|
},
|
5535
5971
|
{
|
5536
5972
|
"default": "",
|
5973
|
+
"disabled": false,
|
5537
5974
|
"document": "视频文件Id",
|
5538
5975
|
"member": "string",
|
5539
5976
|
"name": "VideoId",
|
@@ -5543,6 +5980,7 @@
|
|
5543
5980
|
},
|
5544
5981
|
{
|
5545
5982
|
"default": "",
|
5983
|
+
"disabled": false,
|
5546
5984
|
"document": "视频流类型 \n- 0:摄像头视频 \n- 1:屏幕分享视频\n- 2:白板视频 \n- 3:混流视频\n- 4:纯音频(mp3)",
|
5547
5985
|
"member": "int64",
|
5548
5986
|
"name": "VideoType",
|
@@ -5552,6 +5990,7 @@
|
|
5552
5990
|
},
|
5553
5991
|
{
|
5554
5992
|
"default": "",
|
5993
|
+
"disabled": false,
|
5555
5994
|
"document": "摄像头/屏幕分享视频所属用户的 Id(白板视频为空、混流视频tic_mixstream_房间号_混流布局类型、辅路视频tic_substream_用户Id)",
|
5556
5995
|
"member": "string",
|
5557
5996
|
"name": "UserId",
|
@@ -5561,6 +6000,7 @@
|
|
5561
6000
|
},
|
5562
6001
|
{
|
5563
6002
|
"default": "",
|
6003
|
+
"disabled": false,
|
5564
6004
|
"document": "视频分辨率的宽",
|
5565
6005
|
"member": "int64",
|
5566
6006
|
"name": "Width",
|
@@ -5570,6 +6010,7 @@
|
|
5570
6010
|
},
|
5571
6011
|
{
|
5572
6012
|
"default": "",
|
6013
|
+
"disabled": false,
|
5573
6014
|
"document": "视频分辨率的高",
|
5574
6015
|
"member": "int64",
|
5575
6016
|
"name": "Height",
|
@@ -5585,6 +6026,7 @@
|
|
5585
6026
|
"members": [
|
5586
6027
|
{
|
5587
6028
|
"default": "",
|
6029
|
+
"disabled": false,
|
5588
6030
|
"document": "实时录制结果里白板视频宽,取值必须大于等于2,默认为1280",
|
5589
6031
|
"example": "1280",
|
5590
6032
|
"member": "int64",
|
@@ -5595,6 +6037,7 @@
|
|
5595
6037
|
},
|
5596
6038
|
{
|
5597
6039
|
"default": "",
|
6040
|
+
"disabled": false,
|
5598
6041
|
"document": "实时录制结果里白板视频高,取值必须大于等于2,默认为960",
|
5599
6042
|
"example": "960",
|
5600
6043
|
"member": "int64",
|
@@ -5605,6 +6048,7 @@
|
|
5605
6048
|
},
|
5606
6049
|
{
|
5607
6050
|
"default": "",
|
6051
|
+
"disabled": false,
|
5608
6052
|
"document": "白板初始化参数,透传到白板 SDK",
|
5609
6053
|
"example": "无",
|
5610
6054
|
"member": "string",
|
@@ -5621,6 +6065,7 @@
|
|
5621
6065
|
"members": [
|
5622
6066
|
{
|
5623
6067
|
"default": "",
|
6068
|
+
"disabled": false,
|
5624
6069
|
"document": "任务类型\n\nrecording: 实时录制\ntranscode: 文档转码",
|
5625
6070
|
"member": "string",
|
5626
6071
|
"name": "TaskType",
|
@@ -5630,6 +6075,7 @@
|
|
5630
6075
|
},
|
5631
6076
|
{
|
5632
6077
|
"default": "",
|
6078
|
+
"disabled": false,
|
5633
6079
|
"document": "存储桶名字",
|
5634
6080
|
"member": "string",
|
5635
6081
|
"name": "BucketName",
|
@@ -5639,6 +6085,7 @@
|
|
5639
6085
|
},
|
5640
6086
|
{
|
5641
6087
|
"default": "",
|
6088
|
+
"disabled": false,
|
5642
6089
|
"document": "存储桶地域",
|
5643
6090
|
"member": "string",
|
5644
6091
|
"name": "BucketLocation",
|
@@ -5648,6 +6095,7 @@
|
|
5648
6095
|
},
|
5649
6096
|
{
|
5650
6097
|
"default": "",
|
6098
|
+
"disabled": false,
|
5651
6099
|
"document": "资源在存储桶中的前缀",
|
5652
6100
|
"member": "string",
|
5653
6101
|
"name": "BucketPrefix",
|
@@ -5657,6 +6105,7 @@
|
|
5657
6105
|
},
|
5658
6106
|
{
|
5659
6107
|
"default": "",
|
6108
|
+
"disabled": false,
|
5660
6109
|
"document": "目标CDN域名",
|
5661
6110
|
"member": "string",
|
5662
6111
|
"name": "ResultDomain",
|
@@ -5666,6 +6115,7 @@
|
|
5666
6115
|
},
|
5667
6116
|
{
|
5668
6117
|
"default": "",
|
6118
|
+
"disabled": false,
|
5669
6119
|
"document": "回调地址",
|
5670
6120
|
"member": "string",
|
5671
6121
|
"name": "Callback",
|
@@ -5675,6 +6125,7 @@
|
|
5675
6125
|
},
|
5676
6126
|
{
|
5677
6127
|
"default": "",
|
6128
|
+
"disabled": false,
|
5678
6129
|
"document": "回调鉴权密钥",
|
5679
6130
|
"member": "string",
|
5680
6131
|
"name": "CallbackKey",
|
@@ -5684,6 +6135,7 @@
|
|
5684
6135
|
},
|
5685
6136
|
{
|
5686
6137
|
"default": "",
|
6138
|
+
"disabled": false,
|
5687
6139
|
"document": "配置的应用SdkAppId",
|
5688
6140
|
"member": "int64",
|
5689
6141
|
"name": "SdkAppId",
|
@@ -5693,6 +6145,7 @@
|
|
5693
6145
|
},
|
5694
6146
|
{
|
5695
6147
|
"default": "",
|
6148
|
+
"disabled": false,
|
5696
6149
|
"document": "IM管理员UserId",
|
5697
6150
|
"member": "string",
|
5698
6151
|
"name": "AdminUserId",
|
@@ -5702,6 +6155,7 @@
|
|
5702
6155
|
},
|
5703
6156
|
{
|
5704
6157
|
"default": "",
|
6158
|
+
"disabled": false,
|
5705
6159
|
"document": "IM管理员UserSig",
|
5706
6160
|
"member": "string",
|
5707
6161
|
"name": "AdminUserSig",
|
@@ -5717,6 +6171,7 @@
|
|
5717
6171
|
"members": [
|
5718
6172
|
{
|
5719
6173
|
"default": "",
|
6174
|
+
"disabled": false,
|
5720
6175
|
"document": "用于白板推流服务进房的用户ID,\n该ID必须是一个单独的未在SDK中使用的ID,白板推流服务将使用这个用户ID进入房间进行白板推流,若该ID和SDK中使用的ID重复,会导致SDK和录制服务互踢,影响正常推流。",
|
5721
6176
|
"member": "string",
|
5722
6177
|
"name": "PushUserId",
|
@@ -5726,6 +6181,7 @@
|
|
5726
6181
|
},
|
5727
6182
|
{
|
5728
6183
|
"default": "",
|
6184
|
+
"disabled": false,
|
5729
6185
|
"document": "与PushUserId对应的签名",
|
5730
6186
|
"member": "string",
|
5731
6187
|
"name": "PushUserSig",
|
@@ -5741,6 +6197,7 @@
|
|
5741
6197
|
"members": [
|
5742
6198
|
{
|
5743
6199
|
"default": "",
|
6200
|
+
"disabled": false,
|
5744
6201
|
"document": "AUTO - 自动停止推流, USER_CALL - 用户主动调用停止推流",
|
5745
6202
|
"member": "string",
|
5746
6203
|
"name": "FinishReason",
|
@@ -5750,6 +6207,7 @@
|
|
5750
6207
|
},
|
5751
6208
|
{
|
5752
6209
|
"default": "",
|
6210
|
+
"disabled": false,
|
5753
6211
|
"document": "异常数",
|
5754
6212
|
"member": "int64",
|
5755
6213
|
"name": "ExceptionCnt",
|
@@ -5759,6 +6217,7 @@
|
|
5759
6217
|
},
|
5760
6218
|
{
|
5761
6219
|
"default": "",
|
6220
|
+
"disabled": false,
|
5762
6221
|
"document": "房间号",
|
5763
6222
|
"member": "int64",
|
5764
6223
|
"name": "RoomId",
|
@@ -5768,6 +6227,7 @@
|
|
5768
6227
|
},
|
5769
6228
|
{
|
5770
6229
|
"default": "",
|
6230
|
+
"disabled": false,
|
5771
6231
|
"document": "IM群组ID",
|
5772
6232
|
"member": "string",
|
5773
6233
|
"name": "GroupId",
|
@@ -5777,6 +6237,7 @@
|
|
5777
6237
|
},
|
5778
6238
|
{
|
5779
6239
|
"default": "",
|
6240
|
+
"disabled": false,
|
5780
6241
|
"document": "推流真实开始时间",
|
5781
6242
|
"member": "int64",
|
5782
6243
|
"name": "PushStartTime",
|
@@ -5786,6 +6247,7 @@
|
|
5786
6247
|
},
|
5787
6248
|
{
|
5788
6249
|
"default": "",
|
6250
|
+
"disabled": false,
|
5789
6251
|
"document": "推流结束时间",
|
5790
6252
|
"member": "int64",
|
5791
6253
|
"name": "PushStopTime",
|
@@ -5795,6 +6257,7 @@
|
|
5795
6257
|
},
|
5796
6258
|
{
|
5797
6259
|
"default": "",
|
6260
|
+
"disabled": false,
|
5798
6261
|
"document": "白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。",
|
5799
6262
|
"member": "int64",
|
5800
6263
|
"name": "IMSyncTime",
|
@@ -5804,6 +6267,7 @@
|
|
5804
6267
|
},
|
5805
6268
|
{
|
5806
6269
|
"default": "",
|
6270
|
+
"disabled": false,
|
5807
6271
|
"document": "任务失败错误码",
|
5808
6272
|
"member": "int64",
|
5809
6273
|
"name": "ErrorCode",
|
@@ -5813,6 +6277,7 @@
|
|
5813
6277
|
},
|
5814
6278
|
{
|
5815
6279
|
"default": "",
|
6280
|
+
"disabled": false,
|
5816
6281
|
"document": "错误信息",
|
5817
6282
|
"member": "string",
|
5818
6283
|
"name": "ErrorMsg",
|
@@ -5828,6 +6293,7 @@
|
|
5828
6293
|
"members": [
|
5829
6294
|
{
|
5830
6295
|
"default": "",
|
6296
|
+
"disabled": false,
|
5831
6297
|
"document": "任务唯一ID",
|
5832
6298
|
"member": "string",
|
5833
6299
|
"name": "TaskId",
|
@@ -5837,6 +6303,7 @@
|
|
5837
6303
|
},
|
5838
6304
|
{
|
5839
6305
|
"default": "",
|
6306
|
+
"disabled": false,
|
5840
6307
|
"document": "白板推流任务状态\n- PREPARED: 推流在准备阶段\n- PUSHING: 正在推流\n- STOPPED:推流已停止",
|
5841
6308
|
"member": "string",
|
5842
6309
|
"name": "Status",
|
@@ -5846,6 +6313,7 @@
|
|
5846
6313
|
},
|
5847
6314
|
{
|
5848
6315
|
"default": "",
|
6316
|
+
"disabled": false,
|
5849
6317
|
"document": "白板推流房间号",
|
5850
6318
|
"member": "int64",
|
5851
6319
|
"name": "RoomId",
|
@@ -5855,6 +6323,7 @@
|
|
5855
6323
|
},
|
5856
6324
|
{
|
5857
6325
|
"default": "",
|
6326
|
+
"disabled": false,
|
5858
6327
|
"document": "任务创建时间",
|
5859
6328
|
"member": "datetime_iso",
|
5860
6329
|
"name": "CreateTime",
|
@@ -5864,6 +6333,7 @@
|
|
5864
6333
|
},
|
5865
6334
|
{
|
5866
6335
|
"default": "",
|
6336
|
+
"disabled": false,
|
5867
6337
|
"document": "用户应用SdkAppId",
|
5868
6338
|
"member": "int64",
|
5869
6339
|
"name": "SdkAppId",
|
@@ -5873,6 +6343,7 @@
|
|
5873
6343
|
},
|
5874
6344
|
{
|
5875
6345
|
"default": "",
|
6346
|
+
"disabled": false,
|
5876
6347
|
"document": "白板推流结果",
|
5877
6348
|
"member": "WhiteboardPushResult",
|
5878
6349
|
"name": "Result",
|
@@ -5882,6 +6353,7 @@
|
|
5882
6353
|
},
|
5883
6354
|
{
|
5884
6355
|
"default": "",
|
6356
|
+
"disabled": false,
|
5885
6357
|
"document": "白板推流用户ID",
|
5886
6358
|
"member": "string",
|
5887
6359
|
"name": "PushUserId",
|