tencentcloud-sdk-nodejs-lcic 4.1.189 → 4.1.198

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-lcic",
3
- "version": "4.1.189",
3
+ "version": "4.1.198",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -140,6 +140,10 @@ export interface CreateRoomRequest {
140
140
  * <p>录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效</p>
141
141
  */
142
142
  RecordMerge?: number;
143
+ /**
144
+ * <p>转推开关</p><p>枚举值:</p><ul><li>0: 关闭</li><li>1: 开启</li></ul>
145
+ */
146
+ EnableLiveRelay?: number;
143
147
  }
144
148
  /**
145
149
  * 转存配置
@@ -906,11 +910,11 @@ export interface DescribeRoomForbiddenUserRequest {
906
910
  */
907
911
  export interface DescribeRoomRequest {
908
912
  /**
909
- * 课堂Id
913
+ * <p>课堂Id。</p>
910
914
  */
911
915
  RoomId: number;
912
916
  /**
913
- * 请求RTMP推流链接,0:否,1:是,默认为0
917
+ * <p>请求RTMP推流链接,0:否,1:是,默认为0。</p>
914
918
  */
915
919
  RTMPStreamingURL?: number;
916
920
  }
@@ -2359,165 +2363,153 @@ export interface DescribeUserDetailResponse {
2359
2363
  */
2360
2364
  export interface DescribeRoomResponse {
2361
2365
  /**
2362
- * 课堂名称。
2366
+ * <p>课堂名称。</p>
2363
2367
  */
2364
2368
  Name?: string;
2365
2369
  /**
2366
- * 预定的课堂开始时间,unix时间戳(秒)。
2370
+ * <p>预定的课堂开始时间,unix时间戳(秒)。</p>
2367
2371
  */
2368
2372
  StartTime?: number;
2369
2373
  /**
2370
- * 预定的课堂结束时间,unix时间戳(秒)。
2374
+ * <p>预定的课堂结束时间,unix时间戳(秒)。</p>
2371
2375
  */
2372
2376
  EndTime?: number;
2373
2377
  /**
2374
- * 老师的UserId
2378
+ * <p>老师的UserId。</p>
2375
2379
  */
2376
2380
  TeacherId?: string;
2377
2381
  /**
2378
- * 低代码互动课堂的SdkAppId
2382
+ * <p>低代码互动课堂的SdkAppId。</p>
2379
2383
  */
2380
2384
  SdkAppId?: number;
2381
2385
  /**
2382
- * 观看类型。互动观看 (默认)
2386
+ * <p>观看类型。互动观看 (默认)</p>
2383
2387
  */
2384
2388
  AudienceType?: number;
2385
2389
  /**
2386
- * 头像区域,摄像头视频画面的分辨率。可以有如下取值:
2387
- 1 标清
2388
- 2 高清
2389
- 3 全高清
2390
+ * <p>头像区域,摄像头视频画面的分辨率。可以有如下取值:<br>1 标清<br>2 高清<br>3 全高清</p>
2390
2391
  */
2391
2392
  Resolution?: number;
2392
2393
  /**
2393
- * 设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
2394
+ * <p>设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。</p>
2394
2395
  */
2395
2396
  MaxMicNumber?: number;
2396
2397
  /**
2397
- * 进入课堂时是否自动连麦。可以有以下取值:
2398
- 0 不自动连麦(需要手动申请上麦,默认值)
2399
- 1 自动连麦
2398
+ * <p>进入课堂时是否自动连麦。可以有以下取值:<br>0 不自动连麦(需要手动申请上麦,默认值)<br>1 自动连麦</p>
2400
2399
  */
2401
2400
  AutoMic?: number;
2402
2401
  /**
2403
- * 高音质模式。可以有以下取值:
2404
- 0 不开启高音质(默认值)
2405
- 1 开启高音质
2402
+ * <p>高音质模式。可以有以下取值:<br>0 不开启高音质(默认值)<br>1 开启高音质</p>
2406
2403
  */
2407
2404
  AudioQuality?: number;
2408
2405
  /**
2409
- * 课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频
2406
+ * <p>课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频</p>
2410
2407
  */
2411
2408
  SubType?: string;
2412
2409
  /**
2413
- * 上课后是否禁止自动录制。可以有以下取值:
2414
- 0 不禁止录制(自动开启录制,默认值)
2415
- 1 禁止录制
2416
- 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
2410
+ * <p>录制方式。</p><p>枚举值:</p><ul><li>0: 开启自动录制</li><li>1: 禁止录制</li><li>2: 开启手动录制。(仅支持页面录制,需通过startRecord、stopRecord接口控制录制的开始和结束。)</li><li>3: 信令录制。</li></ul>
2417
2411
  */
2418
2412
  DisableRecord?: number;
2419
2413
  /**
2420
- * 助教UserId列表。
2414
+ * <p>助教UserId列表。</p>
2421
2415
  */
2422
2416
  Assistants?: Array<string>;
2423
2417
  /**
2424
- * 录制地址(协议为https)。仅在房间结束后存在。
2418
+ * <p>录制地址(协议为https)。仅在房间结束后存在。</p>
2425
2419
  */
2426
2420
  RecordUrl?: string;
2427
2421
  /**
2428
- * 课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。
2422
+ * <p>课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。</p>
2429
2423
  */
2430
2424
  Status?: number;
2431
2425
  /**
2432
- * 课堂绑定的群组ID
2426
+ * <p>课堂绑定的群组ID</p>
2433
2427
  */
2434
2428
  GroupId?: string;
2435
2429
  /**
2436
- * 打开学生麦克风/摄像头的授权开关
2430
+ * <p>打开学生麦克风/摄像头的授权开关</p>
2437
2431
  */
2438
2432
  EnableDirectControl?: number;
2439
2433
  /**
2440
- * 开启专注模式。
2441
- 0 收看全部角色音视频(默认)
2442
- 1 只看老师和助教
2434
+ * <p>开启专注模式。<br>0 收看全部角色音视频(默认)<br>1 只看老师和助教</p>
2443
2435
  */
2444
2436
  InteractionMode?: number;
2445
2437
  /**
2446
- * 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
2438
+ * <p>横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型</p>
2447
2439
  */
2448
2440
  VideoOrientation?: number;
2449
2441
  /**
2450
- * 该课堂是否开启了课后评分功能。0:未开启 1:开启
2442
+ * <p>该课堂是否开启了课后评分功能。0:未开启 1:开启</p>
2451
2443
  */
2452
2444
  IsGradingRequiredPostClass?: number;
2453
2445
  /**
2454
- * 课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏
2446
+ * <p>课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏</p>
2455
2447
  */
2456
2448
  RoomType?: number;
2457
2449
  /**
2458
- * 录制时长
2450
+ * <p>录制时长</p>
2459
2451
  */
2460
2452
  VideoDuration?: number;
2461
2453
  /**
2462
- * 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
2454
+ * <p>拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟</p>
2463
2455
  */
2464
2456
  EndDelayTime?: number;
2465
2457
  /**
2466
- * 直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播
2458
+ * <p>直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播</p>
2467
2459
  */
2468
2460
  LiveType?: number;
2469
2461
  /**
2470
- * 伪直播链接
2462
+ * <p>伪直播链接</p>
2471
2463
  */
2472
2464
  RecordLiveUrl?: string;
2473
2465
  /**
2474
- * 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
2466
+ * <p>是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效</p>
2475
2467
  */
2476
2468
  EnableAutoStart?: number;
2477
2469
  /**
2478
- * 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
2470
+ * <p>录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道</p>
2479
2471
  */
2480
2472
  RecordBackground?: string;
2481
2473
  /**
2482
- * RTMP推流链接
2474
+ * <p>RTMP推流链接</p>
2483
2475
  */
2484
2476
  RTMPStreamingURL?: string;
2485
2477
  /**
2486
- * 录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。
2478
+ * <p>录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。</p>
2487
2479
  */
2488
2480
  RecordScene?: string;
2489
2481
  /**
2490
- * 录制自定义语言,仅recordlayout=9的时候此参数有效
2482
+ * <p>录制自定义语言,仅recordlayout=9的时候此参数有效</p>
2491
2483
  */
2492
2484
  RecordLang?: string;
2493
2485
  /**
2494
- * 录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0
2486
+ * <p>录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0</p>
2495
2487
  */
2496
2488
  RecordStream?: number;
2497
2489
  /**
2498
- * 录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
2490
+ * <p>录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744</p>
2499
2491
  */
2500
2492
  RecordLayout?: number;
2501
2493
  /**
2502
- * 板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式
2494
+ * <p>板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式</p>
2503
2495
  */
2504
2496
  WhiteBoardSnapshotMode?: number;
2505
2497
  /**
2506
- * 字幕转写功能开关。可以有以下取值:
2507
- 0 不开启字幕转写功能(默认值)
2508
- 1 自动转写模式:上课自动开启,下课自动停止
2509
- 2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写
2510
- 设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关
2498
+ * <p>字幕转写功能开关。可以有以下取值:<br>0 不开启字幕转写功能(默认值)<br>1 自动转写模式:上课自动开启,下课自动停止<br>2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写<br>设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关</p>
2511
2499
  */
2512
2500
  SubtitlesTranscription?: number;
2513
2501
  /**
2514
- * 嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效
2502
+ * <p>嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效</p>
2515
2503
  */
2516
2504
  Guests?: Array<string>;
2517
2505
  /**
2518
- * 录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效
2506
+ * <p>录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效</p>
2519
2507
  */
2520
2508
  RecordMerge?: number;
2509
+ /**
2510
+ * <p>转推开关</p><p>枚举值:</p><ul><li>0: 关闭</li><li>1: 开启</li></ul>
2511
+ */
2512
+ EnableLiveRelay?: number;
2521
2513
  /**
2522
2514
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2523
2515
  */
@@ -3171,7 +3163,7 @@ export interface RoomInfo {
3171
3163
  */
3172
3164
  AudioQuality?: number;
3173
3165
  /**
3174
- * <p>上课后是否禁止自动录制。可以有以下取值: 0 不禁止录制(自动开启录制,默认值) 1 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。</p>
3166
+ * <p>录制方式。</p><p>枚举值:</p><ul><li>0 开启自动录制</li><li>1 禁止录制</li><li>2: 开启手动录制。(仅支持页面录制,需通过startRecord、stopRecord接口控制录制的开始和结束。)</li><li>3: 信令录制</li></ul>
3175
3167
  */
3176
3168
  DisableRecord?: number;
3177
3169
  /**
@@ -3264,6 +3256,10 @@ export interface RoomInfo {
3264
3256
  * <p>录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效</p>
3265
3257
  */
3266
3258
  RecordMerge?: number;
3259
+ /**
3260
+ * <p>转推开关</p><p>枚举值:</p><ul><li>0: 关闭</li><li>1: 开启</li></ul>
3261
+ */
3262
+ EnableLiveRelay?: number;
3267
3263
  }
3268
3264
  /**
3269
3265
  * DescribeMarquee返回参数结构体
@@ -4046,7 +4042,7 @@ export interface ModifyRoomRequest {
4046
4042
  */
4047
4043
  SubType?: string;
4048
4044
  /**
4049
- * <p>禁止录制。可以有以下取值:<br>0 不禁止录制(默认值)<br>1 禁止录制<br>直播开始后不允许修改。</p>
4045
+ * <p>录制方式。</p><p>枚举值:</p><ul><li>0 开启自动录制</li><li>1 禁止录制</li><li>2: 开启手动录制。(仅支持页面录制,需通过startRecord、stopRecord接口控制录制的开始和结束。)</li><li>3: 信令录制</li></ul>
4050
4046
  */
4051
4047
  DisableRecord?: number;
4052
4048
  /**
@@ -4122,6 +4118,10 @@ export interface ModifyRoomRequest {
4122
4118
  * <p>录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效</p>
4123
4119
  */
4124
4120
  RecordMerge?: number;
4121
+ /**
4122
+ * <p>转推开关</p><p>枚举值:</p><ul><li>0: 关闭</li><li>1: 开启</li></ul>
4123
+ */
4124
+ EnableLiveRelay?: number;
4125
4125
  }
4126
4126
  /**
4127
4127
  * 自定义录制信息