TRTCTypeDef.h
51.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
/*
* Module: TRTC 关键类型定义
*
* Function: 分辨率、质量等级等枚举和常量值的定义
*
*/
#ifndef __TRTCTYPEDEF_H__
#define __TRTCTYPEDEF_H__
#include "ITXDeviceManager.h"
#include <stdint.h>
#include <memory>
#ifdef _WIN32
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <windows.h>
#ifdef TRTC_EXPORTS
#define TRTC_API __declspec(dllexport)
#else
#define TRTC_API __declspec(dllimport)
#endif
#elif __APPLE__
#include <TargetConditionals.h>
#define TRTC_API __attribute__((visibility("default")))
#elif __ANDROID__
#define TRTC_API __attribute__((visibility("default")))
#else
#define TRTC_API
#endif
#define TARGET_PLATFORM_DESKTOP (__APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE) || _WIN32
#define TARGET_PLATFORM_PHONE __ANDROID__ || (__APPLE__ && TARGET_OS_IOS)
namespace trtc {
/**
* 渲染控件
* TXView根据编译平台的不同,做不同的类型转换,来保证兼容性
*
*/
#ifdef _WIN32
typedef HWND TXView;
#else
typedef void * TXView;
#endif
/**
* 窗口尺寸和位置结构体
*/
#ifndef _WIN32
struct RECT {
int left = 0;
int top = 0;
int right = 0;
int bottom = 0;
};
struct SIZE
{
long width = 0;
long height = 0;
};
#endif
/// @defgroup TRTCTypeDef_cplusplus 关键类型定义
/// 腾讯云视频通话功能的关键类型定义
/// @{
/////////////////////////////////////////////////////////////////////////////////
//
// 【(一)视频相关枚举值定义】
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 1.1 视频分辨率
*
* 此处仅定义横屏分辨率,如需使用竖屏分辨率(例如360 × 640),需要同时指定 TRTCVideoResolutionMode 为 Portrait。
*/
enum TRTCVideoResolution
{
// 宽高比1:1
TRTCVideoResolution_120_120 = 1, ///< [C] 建议码率80kbps
TRTCVideoResolution_160_160 = 3, ///< [C] 建议码率100kbps
TRTCVideoResolution_270_270 = 5, ///< [C] 建议码率200kbps
TRTCVideoResolution_480_480 = 7, ///< [C] 建议码率350kbps
// 宽高比4:3
TRTCVideoResolution_160_120 = 50, ///< [C] 建议码率100kbps
TRTCVideoResolution_240_180 = 52, ///< [C] 建议码率150kbps
TRTCVideoResolution_280_210 = 54, ///< [C] 建议码率200kbps
TRTCVideoResolution_320_240 = 56, ///< [C] 建议码率250kbps
TRTCVideoResolution_400_300 = 58, ///< [C] 建议码率300kbps
TRTCVideoResolution_480_360 = 60, ///< [C] 建议码率400kbps
TRTCVideoResolution_640_480 = 62, ///< [C] 建议码率600kbps
TRTCVideoResolution_960_720 = 64, ///< [C] 建议码率1000kbps
// 宽高比16:9
TRTCVideoResolution_160_90 = 100, ///< [C] 建议码率150kbps
TRTCVideoResolution_256_144 = 102, ///< [C] 建议码率200kbps
TRTCVideoResolution_320_180 = 104, ///< [C] 建议码率250kbps
TRTCVideoResolution_480_270 = 106, ///< [C] 建议码率350kbps
TRTCVideoResolution_640_360 = 108, ///< [C] 建议码率550kbps
TRTCVideoResolution_960_540 = 110, ///< [C] 建议码率850kbps
TRTCVideoResolution_1280_720 = 112, ///< [C] 摄像头采集 - 建议码率1200kbps
///< [S] 屏幕分享 - 建议码率:低清:1000kbps 高清:1600kbps
TRTCVideoResolution_1920_1080 = 114, ///< [S] 屏幕分享 - 建议码率2000kbps
};
/**
* 1.2 视频分辨率模式
*
* - 横屏分辨率:TRTCVideoResolution_640_360 + TRTCVideoResolutionModeLandscape = 640 × 360
* - 竖屏分辨率:TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640
*/
enum TRTCVideoResolutionMode
{
TRTCVideoResolutionModeLandscape = 0, ///< 横屏分辨率
TRTCVideoResolutionModePortrait = 1, ///< 竖屏分辨率
};
/**
* 1.3 视频流类型
*
* TRTC 内部有三种不同的音视频流,分别为:
* - 主画面:最常用的一条线路,一般用来传输摄像头的视频数据。
* - 小画面:跟主画面的内容相同,但是分辨率和码率更低。
* - 辅流画面:一般用于屏幕分享或远程播片(例如老师播放视频给学生观看)。
*
* @note - 如果主播的上行网络和性能比较好,则可以同时送出大小两路画面。
* @note - SDK 不支持单独开启小画面,小画面必须依附于主画面而存在。
*/
enum TRTCVideoStreamType
{
TRTCVideoStreamTypeBig = 0, ///< 主画面视频流
TRTCVideoStreamTypeSmall = 1, ///< 小画面视频流
TRTCVideoStreamTypeSub = 2, ///< 辅流(屏幕分享)
};
/**
* 1.4 视频画面填充模式
*
* 如果画面的显示分辨率不等于画面的原始分辨率,就需要您设置画面的填充模式:
* - TRTCVideoFillMode_Fill,图像铺满屏幕,超出显示视窗的视频部分将被裁剪,画面显示可能不完整。
* - TRTCVideoFillMode_Fit,图像长边填满屏幕,短边区域会被填充黑色,但画面的内容肯定是完整的。
*/
enum TRTCVideoFillMode
{
/// 图像铺满屏幕,超出显示视窗的视频部分将被裁剪
TRTCVideoFillMode_Fill = 0,
/// 图像长边填满屏幕,短边区域会被填充黑色
TRTCVideoFillMode_Fit = 1,
};
/**
* 1.5 视频画面旋转方向
*
* TRTC SDK 提供了对本地和远程画面的旋转角度设置 API,下列的旋转角度都是指顺时针方向的。
*
*/
enum TRTCVideoRotation
{
TRTCVideoRotation0 = 0, ///< 顺时针旋转0度
TRTCVideoRotation90 = 1, ///< 顺时针旋转90度
TRTCVideoRotation180 = 2, ///< 顺时针旋转180度
TRTCVideoRotation270 = 3, ///< 顺时针旋转270度
};
/**
* 1.6 美颜(磨皮)算法
*
* TRTC SDK 内置多种不同的磨皮算法,您可以选择最适合您产品定位的方案。
*/
enum TRTCBeautyStyle
{
TRTCBeautyStyleSmooth = 0, ///< 光滑,适用于美女秀场,效果比较明显。
TRTCBeautyStyleNature = 1, ///< 自然,磨皮算法更多地保留了面部细节,主观感受上会更加自然。
};
/**
* 1.7 视频像素格式
*
* TRTC SDK 提供针对视频的自定义采集和自定义渲染功能,在自定义采集功能中,您可以用下列枚举值描述您采集的视频像素格式。
* 在自定义渲染功能中,您可以指定您期望 SDK 回调的视频像素格式。
*/
enum TRTCVideoPixelFormat
{
TRTCVideoPixelFormat_Unknown = 0,
TRTCVideoPixelFormat_I420 = 1, ///< I420
TRTCVideoPixelFormat_Texture_2D = 2, ///< OpenGL 2D 纹理
TRTCVideoPixelFormat_BGRA32 = 3, ///< BGRA32
};
/**
* 1.8 视频数据包装格式
*/
enum TRTCVideoBufferType
{
TRTCVideoBufferType_Unknown = 0,
TRTCVideoBufferType_Buffer = 1, ///< 二进制Buffer类型
TRTCVideoBufferType_Texture = 3, ///< 纹理类型
};
/**
* 1.9 画面渲染镜像类型
*
* TRTC 的画面镜像提供下列设置模式
*/
enum TRTCVideoMirrorType
{
#if TARGET_PLATFORM_PHONE
TRTCVideoMirrorType_Auto = 0, ///< 只适用于移动端,本地预览时,前置摄像头镜像,后置摄像头不镜像
#endif
TRTCVideoMirrorType_Enable = 1, ///< 所有画面均镜像
TRTCVideoMirrorType_Disable = 2, ///< 所有画面均不镜像
};
/**
* 1.10 视频截图来源
*/
enum TRTCSnapshotSourceType
{
TRTCSnapshotSourceTypeStream = 0, ///< 从视频流上截取视频画面
TRTCSnapshotSourceTypeView = 1, ///< 从渲染 View 上截取视频画面
};
/////////////////////////////////////////////////////////////////////////////////
//
// 【(二)网络相关枚举值定义】
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 2.1 应用场景
*
* TRTC 可用于视频会议和在线直播等多种应用场景,针对不同的应用场景,TRTC SDK 的内部会进行不同的优化配置:
* - TRTCAppSceneVideoCall :视频通话场景,适合[1对1视频通话]、[300人视频会议]、[在线问诊]、[视频聊天]、[远程面试]等。
* - TRTCAppSceneLIVE :视频互动直播,适合[视频低延时直播]、[十万人互动课堂]、[视频直播 PK]、[视频相亲房]、[互动课堂]、[远程培训]、[超大型会议]等。
* - TRTCAppSceneAudioCall :语音通话场景,适合[1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀]等。
* - TRTCAppSceneVoiceChatRoom:语音互动直播,适合:[语音低延时直播]、[语音直播连麦]、[语聊房]、[K 歌房]、[FM 电台]等。
*/
enum TRTCAppScene
{
/// 视频通话场景,支持720P、1080P高清画质,单个房间最多支持300人同时在线,最高支持50人同时发言。<br>
/// 适合:[1对1视频通话]、[300人视频会议]、[在线问诊]、[视频聊天]、[远程面试]等。
TRTCAppSceneVideoCall = 0,
/// 视频互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。<br>
/// 适合:[视频低延时直播]、[十万人互动课堂]、[视频直播 PK]、[视频相亲房]、[互动课堂]、[远程培训]、[超大型会议]等。<br>
/// 注意:此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。
TRTCAppSceneLIVE = 1,
/// 语音通话场景,支持 48kHz,支持双声道。单个房间最多支持300人同时在线,最高支持50人同时发言。<br>
/// 适合:[1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀]等。
TRTCAppSceneAudioCall = 2,
/// 语音互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。<br>
/// 适合:[语音低延时直播]、[语音直播连麦]、[语聊房]、[K 歌房]、[FM 电台]等。<br>
/// 注意:此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。
TRTCAppSceneVoiceChatRoom = 3,
};
/**
* 2.2 角色,仅适用于直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom)
*
* 在直播场景中,多数用户仅为观众,个别用户是主播,这种角色区分有利于 TRTC 进行更好的定向优化。
*
* - Anchor:主播,可以上行视频和音频,一个房间里最多支持50个主播同时上行音视频。
* - Audience:观众,只能观看,不能上行视频和音频,一个房间里的观众人数没有上限。
*/
enum TRTCRoleType
{
TRTCRoleAnchor = 20, ///< 主播
TRTCRoleAudience = 21, ///< 观众
};
/**
* 2.3 流控模式
*
* TRTC SDK 内部需要时刻根据网络情况调整内部的编解码器和网络模块,以便能够对网络的变化做出反应。
* 为了支持快速算法升级,SDK 内部设置了两种不同的流控模式:
* - ModeServer:云端控制,默认模式,推荐选择。
* - ModeClient:本地控制,用于 SDK 开发内部调试,客户请勿使用。
*
* @note 推荐您使用云端控制,这样每当我们升级 Qos 算法时,您无需升级 SDK 即可体验更好的效果。
*/
enum TRTCQosControlMode
{
TRTCQosControlModeClient, ///< 客户端控制(用于 SDK 开发内部调试,客户请勿使用)
TRTCQosControlModeServer, ///< 云端控制 (默认)
};
/**
* 2.4 画质偏好
*
* 指当 TRTC SDK 在遇到弱网络环境时,您期望“保清晰”或“保流畅”:
*
* - Smooth:弱网下保流畅。即在遭遇弱网环境时首先确保声音的流畅和优先发送,画面会变得模糊且会有较多马赛克,但可以保持流畅不卡顿。
* - Clear:弱网下保清晰。即在遭遇弱网环境时,画面会尽可能保持清晰,但可能会更容易出现卡顿。
*/
enum TRTCVideoQosPreference
{
TRTCVideoQosPreferenceSmooth = 1, ///< 弱网下保流畅
TRTCVideoQosPreferenceClear = 2, ///< 弱网下保清晰
};
/**
* 2.5 网络质量
*
* TRTC SDK 对网络质量定义了六种不同的级别,Excellent 表示最好,Down 表示不可用。
*/
enum TRTCQuality
{
TRTCQuality_Unknown = 0, ///< 未定义
TRTCQuality_Excellent = 1, ///< 最好
TRTCQuality_Good = 2, ///< 好
TRTCQuality_Poor = 3, ///< 一般
TRTCQuality_Bad = 4, ///< 差
TRTCQuality_Vbad = 5, ///< 很差
TRTCQuality_Down = 6, ///< 不可用
};
/////////////////////////////////////////////////////////////////////////////////
//
// 【(三)声音相关枚举值定义】
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 3.1 音频帧的格式
*
*/
enum TRTCAudioFrameFormat
{
TRTCAudioFrameFormatNone = 0,
TRTCAudioFrameFormatPCM, ///< PCM,每个采样点占16bit数据量。
};
/**
* 3.2 声音音质
*
* 音频音质用来衡量声音的保真程度,TRTCAudioQualitySpeech 适用于通话场景,TRTCAudioQualityMusic 适用于高音质音乐场景。
*/
enum TRTCAudioQuality
{
/// 流畅音质:采样率:16k;单声道;音频裸码率:16kbps;适合语音通话为主的场景,比如在线会议,语音通话。
TRTCAudioQualitySpeech = 1,
/// 默认音质:采样率:48k;单声道;音频裸码率:50kbps;SDK 默认的音频质量,如无特殊需求推荐选择之。
TRTCAudioQualityDefault = 2,
/// 高音质:采样率:48k;双声道 + 全频带;音频裸码率:128kbps;适合需要高保真传输音乐的场景,比如K歌、音乐直播等。
TRTCAudioQualityMusic = 3,
};
/////////////////////////////////////////////////////////////////////////////////
//
// 【(四)更多枚举值定义】
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 4.1 Log 级别
*/
enum TRTCLogLevel
{
TRTCLogLevelVerbose = 0, ///< 输出所有级别的 Log
TRTCLogLevelDebug = 1, ///< 输出 DEBUG,INFO,WARNING,ERROR 和 FATAL 级别的 Log
TRTCLogLevelInfo = 2, ///< 输出 INFO,WARNING,ERROR 和 FATAL 级别的 Log
TRTCLogLevelWarn = 3, ///< 只输出WARNING,ERROR 和 FATAL 级别的 Log
TRTCLogLevelError = 4, ///< 只输出ERROR 和 FATAL 级别的 Log
TRTCLogLevelFatal = 5, ///< 只输出 FATAL 级别的 Log
TRTCLogLevelNone = 6, ///< 不输出任何 SDK Log
};
/**
* 4.2 设备操作
*/
enum TRTCDeviceState
{
TRTCDeviceStateAdd = 0, ///< 添加设备
TRTCDeviceStateRemove = 1, ///< 移除设备
TRTCDeviceStateActive = 2, ///< 设备已启用
};
/**
* 4.3 设备类型
*
* 以下定义仅用于兼容原有接口,具体定义参见 ITXDeviceManager.h 文件
*/
typedef TXMediaDeviceType TRTCDeviceType;
#define TRTCDeviceTypeUnknow TXMediaDeviceTypeUnknown
#define TRTCDeviceTypeMic TXMediaDeviceTypeMic
#define TRTCDeviceTypeSpeaker TXMediaDeviceTypeSpeaker
#define TRTCDeviceTypeCamera TXMediaDeviceTypeCamera
/**
* 4.4 水印图片的源类型
*/
enum TRTCWaterMarkSrcType
{
TRTCWaterMarkSrcTypeFile = 0, ///< 图片文件路径,支持 BMP、GIF、JPEG、PNG、TIFF、Exif、WMF 和 EMF 文件格式
TRTCWaterMarkSrcTypeBGRA32 = 1, ///< BGRA32格式内存块
TRTCWaterMarkSrcTypeRGBA32 = 2, ///< RGBA32格式内存块
};
/**
* 4.5 屏幕分享目标信息
*/
enum TRTCScreenCaptureSourceType
{
TRTCScreenCaptureSourceTypeUnknown = -1,
TRTCScreenCaptureSourceTypeWindow = 0, ///< 该分享目标是某一个窗口
TRTCScreenCaptureSourceTypeScreen = 1, ///< 该分享目标是整个桌面
TRTCScreenCaptureSourceTypeCustom = 2,
};
/////////////////////////////////////////////////////////////////////////////////
//
// 【(五)TRTC 核心类型定义】
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 5.1 进房相关参数
*
* 只有该参数填写正确,才能顺利调用 enterRoom 进入 roomId 所指定的音视频房间。
*/
struct TRTCParams
{
///【字段含义】应用标识(必填),腾讯视频云基于 sdkAppId 完成计费统计。
///【推荐取值】在 [实时音视频控制台](https://console.cloud.tencent.com/rav/) 创建应用后可在帐号信息页面中得到该 ID。
uint32_t sdkAppId;
///【字段含义】用户标识(必填),当前用户的 userId,相当于用户名,使用 UTF-8 编码。
///【推荐取值】如果一个用户在您的帐号系统中的 ID 为“abc”,则 userId 即可设置为“abc”。
const char * userId;
///【字段含义】用户签名(必填),当前 userId 对应的验证签名,相当于登录密码。
///【推荐取值】具体计算方法请参见 [如何计算UserSig](https://cloud.tencent.com/document/product/647/17275)。
const char * userSig;
///【字段含义】房间号码(必填),在同一个房间内的用户可以看到彼此并进行视频通话。
///【推荐取值】您可以自定义设置该参数值,但不可重复。如果您的用户帐号 ID (userId)为数字类型,可直接使用创建者的用户 ID 作为 roomId。
uint32_t roomId;
///【字段含义】字符串房间号码,在同一个房间里的用户(userId)可以彼此看到对方并进行视频通话。
///【推荐取值】限制长度为64字节。以下为支持的字符集范围(共 89 个字符):
/// -大小写英文字母(a-zA-Z);
/// -数字(0-9);
/// -空格、"!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、" {"、"}"、"|"、"~"、","。
///【特殊说明】roomId 与 strRoomId 必填一个,若您选用 strRoomId,则 roomId 需要填写为0。若两者都填,将优先选用 roomId。
const char* strRoomId;
///【字段含义】直播场景下的角色,仅适用于直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom),视频通话场景下指定无效。
///【推荐取值】默认值:主播(TRTCRoleAnchor)
TRTCRoleType role;
///【字段含义】绑定腾讯云直播 CDN 流 ID[非必填],设置之后,您就可以在腾讯云直播 CDN 上通过标准直播方案(FLV或HLS)播放该用户的音视频流。
///【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用 “sdkappid_roomid_userid_main” 作为 streamid,这样比较好辨认且不会在您的多个应用中发生冲突。
///【特殊说明】要使用腾讯云直播 CDN,您需要先在[控制台](https://console.cloud.tencent.com/trtc/) 中的功能配置页开启“启动自动旁路直播”开关。
///【参考文档】[CDN 旁路直播](https://cloud.tencent.com/document/product/647/16826)。
const char * streamId;
///【字段含义】设置云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容,便于您更方便的识别录制回调。
///【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
///【参考文档】[云端录制](https://cloud.tencent.com/document/product/647/16823)。
const char * userDefineRecordId;
///【字段含义】房间签名(非必填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。
///【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 [进房权限保护](https://cloud.tencent.com/document/product/647/32240)。
const char * privateMapKey;
///【字段含义】业务数据(非必填),部分高级特性才需要使用该字段。
///【推荐取值】不建议使用
const char * businessInfo;
TRTCParams()
: sdkAppId(0)
, roomId(0)
, strRoomId(nullptr)
, userId(nullptr)
, userSig(nullptr)
, role(TRTCRoleAnchor)
, privateMapKey(nullptr)
, businessInfo(nullptr)
, userDefineRecordId(nullptr)
, streamId(nullptr)
{
}
};
/**
* 5.2 视频编码参数
*
* 该设置决定了远端用户看到的画面质量(同时也是云端录制出的视频文件的画面质量)。
*/
struct TRTCVideoEncParam
{
///【字段含义】 视频分辨率
///【推荐取值】
/// - 视频通话建议选择360 × 640及以下分辨率,resMode 选择 Portrait。
/// - 手机直播建议选择540 × 960,resMode 选择 Portrait。
/// - Window 和 iMac 建议选择640 × 360及以上分辨率,resMode 选择 Landscape。
///【特别说明】
/// TRTCVideoResolution 默认只能横屏模式的分辨率,例如640 × 360。
/// 如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如640 × 360结合 Portrait 则为360 × 640。
TRTCVideoResolution videoResolution;
///【字段含义】分辨率模式(横屏分辨率 - 竖屏分辨率)
///【推荐取值】手机直播建议选择 Portrait,Window 和 Mac 建议选择 Landscape。
///【特别说明】如果 videoResolution 指定分辨率 640 × 360,resMode 指定模式为 Portrait,则最终编码出的分辨率为360 × 640。
TRTCVideoResolutionMode resMode;
///【字段含义】视频采集帧率
///【推荐取值】15fps 或 20fps。5fps以下,卡顿感明显。10fps以下,会有轻微卡顿感。20fps以上,则过于浪费(电影的帧率为24fps)。
///【特别说明】很多 Android 手机的前置摄像头并不支持15fps以上的采集帧率,部分过于突出美颜功能的 Android 手机前置摄像头的采集帧率可能低于10fps。
uint32_t videoFps;
///【字段含义】视频上行码率
///【推荐取值】推荐设置请参考本文件前半部分 TRTCVideoResolution 定义处的注释说明
///【特别说明】码率太低会导致视频中出现大量马赛克
uint32_t videoBitrate;
///【字段含义】最低视频码率,SDK 会在网络不佳的情况下主动降低视频码率,最低会降至
/// minVideoBitrate 所设定的数值。 【推荐取值】
/// - 如果您追求“允许卡顿但要保持清晰”的效果,可以设置 minVideoBitrate 为 videoBitrate 的
/// 60%;
/// - 如果您追求“允许模糊但要保持流畅”的效果,可以设置 minVideoBitrate 为 200kbps;
/// - 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK
/// 的自适应调节能力;
/// - 默认值:0,此时最低码率由 SDK 根据分辨率情况,自动设置合适的数值。
///【特别说明】
/// - 当您把分辨率设置的比较高时,minVideoBitrate
/// 不适合设置的太低,否则会出现画面模糊和大范围的马赛克宏块。
/// 比如把分辨率设置为 720p,把码率设置为
/// 200kbps,那么编码出的画面将会出现大范围区域性马赛克。
uint32_t minVideoBitrate;
///【字段含义】是否允许调整分辨率
///【推荐取值】
/// - 手机直播建议选择 false。
/// - 视频通话模式,若更关注流畅性,建议选择 true,此时若遇到带宽有限的弱网,SDK 会自动降低分辨率以保障更好的流畅度(仅针对 TRTCVideoStreamTypeBig 生效)。
/// - 默认值:false。
///【特别说明】若有录制需求,选择 true 时,请确保通话过程中,调整分辨率不会影响您的录制效果。
bool enableAdjustRes;
TRTCVideoEncParam()
: videoResolution(TRTCVideoResolution_640_360)
, resMode(TRTCVideoResolutionModeLandscape)
, videoFps(15)
, videoBitrate(550)
, enableAdjustRes(false)
, minVideoBitrate(0)
{
}
};
/**
* 5.3 画面渲染参数
*
* 您可以通过设置此参数来控制画面的旋转、填充、镜像模式
*/
struct TRTCRenderParams {
TRTCVideoRotation rotation; ///< 视频画面旋转方向,默认值为 TRTCVideoRotation0
TRTCVideoFillMode fillMode; ///< 视频画面填充模式,默认值为 TRTCVideoFillMode_Fit
TRTCVideoMirrorType mirrorType; ///< 视频画面镜像模式,默认值为 TRTCVideoMirrorType_Disable
TRTCRenderParams()
: rotation(TRTCVideoRotation0)
, fillMode(TRTCVideoFillMode_Fit)
, mirrorType(TRTCVideoMirrorType_Disable) {
}
};
/**
* 5.4 网络流控相关参数
*
* 网络流控相关参数,该设置决定了SDK在各种网络环境下的调控方向(比如弱网下是“保清晰”或“保流畅”)
*/
struct TRTCNetworkQosParam
{
///【字段含义】弱网下是“保清晰”或“保流畅”
///【特别说明】
/// - 弱网下保流畅:在遭遇弱网环境时,画面会变得模糊,且出现较多马赛克,但可以保持流畅不卡顿。
/// - 弱网下保清晰:在遭遇弱网环境时,画面会尽可能保持清晰,但可能容易出现卡顿
TRTCVideoQosPreference preference;
///【字段含义】视频分辨率(云端控制 - 客户端控制)
///【推荐取值】云端控制
///【特别说明】
/// - Server 模式(默认):云端控制模式,若无特殊原因,请直接使用该模式
/// - Client 模式:客户端控制模式,用于 SDK 开发内部调试,客户请勿使用
TRTCQosControlMode controlMode;
TRTCNetworkQosParam()
: preference(TRTCVideoQosPreferenceClear)
, controlMode(TRTCQosControlModeServer)
{
}
};
/**
* 5.5 网络质量
*
* 表示网络质量的好坏,通过这个数值,您可以在 UI 界面上用图标表征 userId 的通话线路质量
*/
struct TRTCQualityInfo
{
const char * userId; ///< 用户标识
TRTCQuality quality; ///< 网络质量
TRTCQualityInfo()
: userId(nullptr)
, quality(TRTCQuality_Unknown)
{
}
};
/**
* 5.6 音量大小
*
* 表示语音音量的评估大小,通过这个数值,您可以在 UI 界面上用图标表征 userId 是否有在说话。
*/
struct TRTCVolumeInfo
{
/// 说话者的 userId,字符编码格式为 UTF-8
const char * userId;
/// 说话者的音量, 取值范围0 - 100
uint32_t volume;
TRTCVolumeInfo()
: userId(nullptr)
, volume(0)
{
}
};
/**
* 5.7 视频帧数据
*
*/
struct TRTCVideoFrame
{
TRTCVideoPixelFormat videoFormat; ///< 视频帧的格式
TRTCVideoBufferType bufferType; ///< 视频数据结构类型
char * data; ///< 视频数据,字段bufferType是LiteAVVideoBufferType_Buffer时生效
int textureId; ///< 视频纹理ID,字段bufferType是LiteAVVideoBufferType_Texture时生效
uint32_t length; ///< 视频数据的长度,单位是字节,对于i420而言, length = width * height * 3 / 2,对于BGRA32而言, length = width * height * 4
uint32_t width; ///< 画面的宽度
uint32_t height; ///< 画面的高度
uint64_t timestamp; ///< 时间戳,单位ms
TRTCVideoRotation rotation; ///< 画面旋转角度
TRTCVideoFrame()
: videoFormat(TRTCVideoPixelFormat_Unknown)
, data(nullptr)
, textureId(-1)
, length(0)
, width(640)
, height(360)
, timestamp(0)
, rotation(TRTCVideoRotation0)
{
}
};
/**
* 5.8 音频帧数据
*
*/
struct TRTCAudioFrame
{
TRTCAudioFrameFormat audioFormat; ///< 音频帧的格式
char * data; ///< 音频数据
uint32_t length; ///< 音频数据的长度
uint32_t sampleRate; ///< 采样率
uint32_t channel; ///< 声道数
uint64_t timestamp; ///< 时间戳,单位ms
TRTCAudioFrame()
: audioFormat(TRTCAudioFrameFormatNone)
, data(nullptr)
, length(0)
, sampleRate(48000)
, channel(1)
, timestamp(0)
{
}
};
/**
* 5.9 网络测速结果
*
* 您可以在用户进入房间前通过 TRTCCloud 的 startSpeedTest 接口进行测速 (注意:请不要在通话中调用),
* 测速结果会每2 - 3秒钟返回一次,每次返回一个 IP 地址的测试结果。
*
* @note - quality 是内部通过评估算法测算出的网络质量,loss 越低,rtt 越小,得分便越高。
* @note - upLostRate 是指上行丢包率。例如,0.3表示每向服务器发送10个数据包可能会在中途丢失3个。
* @note - downLostRate 是指下行丢包率。例如,0.2表示每从服务器收取10个数据包可能会在中途丢失2个。
* @note - rtt 是指当前设备到腾讯云服务器的一次网络往返时间,该值越小越好,正常数值范围是10ms - 100ms
*/
struct TRTCSpeedTestResult
{
/// 服务器 IP 地址
const char * ip;
/// 网络质量,内部通过评估算法测算出的网络质量,loss 越低,rtt 越小,得分便越高
TRTCQuality quality;
/// 上行丢包率,范围是0 - 1.0,例如,0.3表示每向服务器发送10个数据包可能会在中途丢失3个。
float upLostRate;
/// 下行丢包率,范围是0 - 1.0,例如,0.2表示每从服务器收取10个数据包可能会在中途丢失2个。
float downLostRate;
/// 延迟(毫秒),指当前设备到腾讯云服务器的一次网络往返时间,该值越小越好,正常数值范围是10ms - 100ms
int rtt;
TRTCSpeedTestResult()
: ip(nullptr)
, upLostRate(0.0f)
, downLostRate(0.0f)
, rtt(0)
{
}
};
/**
* 5.10 云端混流中每一路子画面的位置信息
*
* TRTCMixUser 用于指定每一路(即每一个 userId)视频画面的具体摆放位置
*/
struct TRTCMixUser
{
/// 参与混流的 userId
const char * userId;
/// 参与混流的 roomId,跨房流传入的实际 roomId,当前房间流传入 roomId = nullptr
const char * roomId;
/// 图层位置坐标以及大小,左上角为坐标原点(0,0) (绝对像素值)
RECT rect;
/// 图层层次(1 - 15)不可重复
int zOrder;
/// 该用户是不是只开启了音频
bool pureAudio;
/// 参与混合的是主路画面(TRTCVideoStreamTypeBig)或屏幕分享(TRTCVideoStreamTypeSub)画面
TRTCVideoStreamType streamType;
TRTCMixUser()
: userId(nullptr)
, roomId(nullptr)
, rect()
, zOrder(0)
, pureAudio(false)
, streamType(TRTCVideoStreamTypeBig)
{
rect.left = 0;
rect.top = 0;
rect.right = 0;
rect.bottom = 0;
}
};
/**
* 5.11 混流参数配置模式
*
*/
enum TRTCTranscodingConfigMode {
/// 非法值
TRTCTranscodingConfigMode_Unknown = 0,
/// 全手动模式,灵活性最高,可以自由组合出各种混流方案,但易用性最差。
/// 此模式下,您需要填写 TRTCTranscodingConfig 中的所有参数,并需要监听 TRTCCloudDelegate 中的 onUserVideoAvailable() 和 onUserAudioAvailable() 回调,
/// 以便根据当前房间中各个上麦用户的音视频状态不断地调整 mixUsers 参数,否则会导致混流失败。
TRTCTranscodingConfigMode_Manual = 1,
/// 纯音频模式,适用于语音通话(AudioCall)和语音聊天室(VoiceChatRoom)等纯音频场景。
/// 只需要在进房后通过 setMixTranscodingConfig() 接口设置一次,之后 SDK 就会自动把房间内所有上麦用户的声音混流到当前用户的直播流上。
/// 此模式下,您无需设置 TRTCTranscodingConfig 中的 mixUsers 参数,只需设置 audioSampleRate、audioBitrate 和 audioChannels 等参数。
TRTCTranscodingConfigMode_Template_PureAudio = 2,
/// 预排版模式,通过占位符提前对各路画面进行排布
/// 此模式下,您依然需要设置 mixUsers 参数,但可以将 userId 设置为占位符,可选的占位符有:
/// - "$PLACE_HOLDER_REMOTE$" : 指代远程用户的画面,可以设置多个。
/// - "$PLACE_HOLDER_LOCAL_MAIN$" : 指代本地摄像头画面,只允许设置一个。
/// - "$PLACE_HOLDER_LOCAL_SUB$" : 指代本地屏幕分享画面,只允许设置一个。
/// 但是您可以不需要监听 TRTCCloudDelegate 中的 onUserVideoAvailable() 和 onUserAudioAvailable() 回调进行实时调整,
/// 只需要在进房成功后调用一次 setMixTranscodingConfig() 即可,之后 SDK 会自动将真实的 userId 补位到您设置的占位符上。
TRTCTranscodingConfigMode_Template_PresetLayout = 3,
/// 屏幕分享模式,适用于在线教育场景等以屏幕分享为主的应用场景,仅支持 Windows 和 Mac 两个平台的 SDK。
/// SDK 会先根据您(通过 videoWidth 和 videoHeight 参数)设置的目标分辨率构建一张画布,
/// 当老师未开启屏幕分享时,SDK 会将摄像头画面等比例拉伸绘制到该画布上;当老师开启屏幕分享之后,SDK 会将屏幕分享画面绘制到同样的画布上。
/// 这样操作的目的是为了确保混流模块的输出分辨率一致,避免课程回放和网页观看的花屏问题(网页播放器不支持可变分辨率)。
///
/// 由于教学模式下的视频内容以屏幕分享为主,因此同时传输摄像头画面和屏幕分享画面是非常浪费带宽的。
/// 推荐的做法是直接将摄像头画面通过 setLocalVideoRenderCallback 接口自定义绘制到当前屏幕上。
/// 在该模式下,您无需设置 TRTCTranscodingConfig 中的 mixUsers 参数,SDK 不会混合学生的画面,以免干扰屏幕分享的效果。
///
/// 您可以将 TRTCTranscodingConfig 中的 width × height 设为 0px × 0px,SDK 会自动根据用户当前屏幕的宽高比计算出一个合适的分辨率:
/// - 如果老师当前屏幕宽度 <= 1920px,SDK 会使用老师当前屏幕的实际分辨率。
/// - 如果老师当前屏幕宽度 > 1920px,SDK 会根据当前屏幕宽高比,选择 1920x1080(16:9)、1920x1200(16:10)、1920x1440(4:3) 三种分辨率中的一种。
TRTCTranscodingConfigMode_Template_ScreenSharing = 4,
};
/**
* 5.12 云端混流(转码)配置
*
* 包括最终编码质量和各路画面的摆放位置
*/
struct TRTCTranscodingConfig
{
///【字段含义】转码 config 模式
TRTCTranscodingConfigMode mode;
///【字段含义】腾讯云直播 AppID
///【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用,单击【帐号信息】后,在“直播信息”中获取
uint32_t appId;
///【字段含义】腾讯云直播 bizid
///【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用,单击【帐号信息】后,在“直播信息”中获取
uint32_t bizId;
///【字段含义】最终转码后的视频分辨率的宽度。
///【推荐取值】推荐值:360px ,如果你是纯音频推流,请将 width × height 设为 0px × 0px,否则混流后会携带一条画布背景的视频流。
uint32_t videoWidth;
///【字段含义】最终转码后的视频分辨率的高度。
///【推荐取值】推荐值:640px ,如果你是纯音频推流,请将 width × height 设为 0px × 0px,否则混流后会携带一条画布背景的视频流。
uint32_t videoHeight;
///【字段含义】最终转码后的视频分辨率的码率(kbps)。
///【推荐取值】如果填0,后台会根据videoWidth和videoHeight来估算码率,您也可以参考枚举定义TRTCVideoResolution_640_480的注释。
uint32_t videoBitrate;
///【字段含义】最终转码后的视频分辨率的帧率(FPS)。
///【推荐取值】默认值:15fps,取值范围是 (0,30]。
uint32_t videoFramerate;
///【字段含义】最终转码后的视频分辨率的关键帧间隔(又称为 GOP)。
///【推荐取值】默认值:2,单位为秒,取值范围是 [1,8]。
uint32_t videoGOP;
///【字段含义】混合后画面的底色颜色,默认为黑色,格式为十六进制数字,比如:“0x61B9F1” 代表 RGB 分别为(97,158,241)。
///【推荐取值】默认值:0x000000,黑色
uint32_t backgroundColor;
///【字段含义】混合后画面的背景图。
///【推荐取值】默认值:null,即不设置背景图
///【特别说明】背景图需要您事先在 “[控制台](https://console.cloud.tencent.com/trtc) => 应用管理 => 功能配置 => 素材管理” 中上传, <br>
/// 上传成功后可以获得对应的“图片ID”,然后将“图片ID”转换成字符串类型并设置到 backgroundImage 里即可。 <br>
/// 例如:假设“图片ID” 为 63,可以设置 backgroundImage = "63"; <br>
const char * backgroundImage;
///【字段含义】最终转码后的音频采样率。
///【推荐取值】默认值:48000Hz。支持12000HZ、16000HZ、22050HZ、24000HZ、32000HZ、44100HZ、48000HZ。
uint32_t audioSampleRate;
///【字段含义】最终转码后的音频码率。
///【推荐取值】默认值:64kbps,取值范围是 [32,192]。
uint32_t audioBitrate;
///【字段含义】最终转码后的音频声道数
///【推荐取值】默认值:1。取值范围为 [1,2] 中的整型。
uint32_t audioChannels;
///【字段含义】每一路子画面的位置信息
TRTCMixUser * mixUsersArray;
///【字段含义】 数组 mixUsersArray 的大小
uint32_t mixUsersArraySize;
///【字段含义】输出到 CDN 上的直播流 ID
/// 如不设置该参数,SDK 会执行默认逻辑,即房间里的多路流会混合到该接口调用者的视频流上,也就是 A+B =>A;
/// 如果设置该参数,SDK 会将房间里的多路流混合到您指定的直播流 ID 上,也就是 A+B =>C。
///【推荐取值】默认值:null,即房间里的多路流会混合到该接口调用者的视频流上。
const char * streamId;
TRTCTranscodingConfig()
: mode(TRTCTranscodingConfigMode_Unknown)
, videoWidth(0)
, videoHeight(0)
, videoBitrate(0)
, videoFramerate(15)
, videoGOP(2)
, audioSampleRate(64)
, audioBitrate(48000)
, audioChannels(1)
, mixUsersArray(nullptr)
, mixUsersArraySize(0)
, backgroundColor(0)
, backgroundImage(nullptr)
, streamId(nullptr)
{}
};
/**
* 5.13 CDN 旁路推流参数
*/
struct TRTCPublishCDNParam
{
/// 腾讯云 AppID,请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用,单击【帐号信息】,在“直播信息”中获取
uint32_t appId;
/// 腾讯云直播 bizid,请在 [实时音视频控制台](https://console.cloud.tencent.com/rav) 选择已经创建的应用,单击【帐号信息】,在“直播信息”中获取
uint32_t bizId;
/// 旁路转推的 URL
const char * url;
TRTCPublishCDNParam()
: url(nullptr)
, appId(0)
, bizId(0)
{
}
};
/**
* 5.14 录音参数
*
* 请正确填写参数,确保录音文件顺利生成。
*/
struct TRTCAudioRecordingParams {
///【字段含义】文件路径(必填),录音文件的保存路径。该路径需要用户自行指定,请确保路径存在且可写。
///【特别说明】该路径需精确到文件名及格式后缀,格式后缀决定录音文件的格式,目前支持的格式有 PCM、WAV 和 AAC。
/// 例如,指定路径为 path/to/audio.aac,则会生成一个 AAC 格式的文件。
/// 请指定一个有读写权限的合法路径,否则录音文件无法生成。
const char * filePath;
TRTCAudioRecordingParams()
: filePath(nullptr)
{
}
};
/**
* 5.15 音效
*/
struct TRTCAudioEffectParam {
///【字段含义】音效 ID,
///【特殊说明】SDK 允许播放多路音效,因此需要音效 ID 进行标记,用于控制音效的开始、停止、音量等
int effectId;
///【字段含义】音效路径,支持的文件格式:aac, mp3。
const char * path;
///【字段含义】循环播放次数
///【推荐取值】取值范围为0 - 任意正整数,默认值:0。0表示播放音效一次;1表示播放音效两次;以此类推
int loopCount;
///【字段含义】音效是否上行
///【推荐取值】YES:音效在本地播放的同时,会上行至云端,因此远端用户也能听到该音效;NO:音效不会上行至云端,因此只能在本地听到该音效。默认值:NO
bool publish;
///【字段含义】音效音量
///【推荐取值】取值范围为0 - 100;默认值:100
int volume;
TRTCAudioEffectParam(const int _effectId, const char *_path)
: loopCount(0)
, publish(false)
, volume(100)
{
effectId = _effectId;
path = _path;
}
};
/**
* 5.16 切换房间参数
*/
struct TRTCSwitchRoomConfig {
///【字段含义】数字房间号码 [选填],在同一个房间内的用户可以看到彼此并进行视频通话。
///【推荐取值】取值范围:1 - 4294967294。
///【特别说明】roomId 和 strRoomId 必须并且只能填一个。若两者都填,则优先选择 roomId。
uint32_t roomId;
///【字段含义】字符串房间号码 [选填],在同一个房间内的用户可以看到彼此并进行视频通话。
///【特别说明】roomId 和 strRoomId 必须并且只能填一个。若两者都填,则优先选择 roomId。
const char *strRoomId;
///【字段含义】用户签名 [选填],当前 userId 对应的验证签名,相当于登录密码。不填时,SDK 会继续使用旧的 userSig,
/// 但用户必须保证旧的 userSig 仍在有效期内,否则会造成进房失败等后果。
///【推荐取值】具体计算方法请参见 [如何计算UserSig](https://cloud.tencent.com/document/product/647/17275)。
const char *userSig;
///【字段含义】房间签名 [选填],当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。
///【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 [进房权限保护](https://cloud.tencent.com/document/product/647/32240)。
const char *privateMapKey;
TRTCSwitchRoomConfig()
: roomId(0)
, strRoomId(nullptr)
, userSig(nullptr)
, privateMapKey(nullptr)
{
}
};
/**
* 5.17 自己本地的音视频统计信息
*/
struct TRTCLocalStatistics
{
uint32_t width; ///< 视频宽度
uint32_t height; ///< 视频高度
uint32_t frameRate; ///< 帧率(fps)
uint32_t videoBitrate; ///< 视频发送码率(Kbps)
uint32_t audioSampleRate; ///< 音频采样率(Hz)
uint32_t audioBitrate; ///< 音频发送码率(Kbps)
TRTCVideoStreamType streamType; ///< 流类型(大画面 | 小画面 | 辅路画面)
TRTCLocalStatistics()
: width(0)
, height(0)
, frameRate(0)
, videoBitrate(0)
, audioSampleRate(0)
, audioBitrate(0)
, streamType(TRTCVideoStreamTypeBig)
{
}
};
/**
* 5.18 远端成员的音视频统计信息
*/
struct TRTCRemoteStatistics
{
const char * userId; ///< 用户 ID,指定是哪个用户的视频流
/** 该线路的总丢包率(%)
*
* 这个值越小越好,例如,丢包率为0表示网络很好。
* 丢包率是该线路的 userId 从上行到服务器再到下行的总丢包率。
* 如果 downLoss 为0,但是 finalLoss 不为0,说明该 userId 上行时出现了无法恢复的丢包。
*/
uint32_t finalLoss;
uint32_t width; ///< 视频宽度
uint32_t height; ///< 视频高度
uint32_t frameRate; ///< 接收帧率(fps)
uint32_t videoBitrate; ///< 视频码率(Kbps)
uint32_t audioSampleRate; ///< 音频采样率(Hz)
uint32_t audioBitrate; ///< 音频码率(Kbps)
uint32_t jitterBufferDelay; ///< 播放时延(ms)
uint32_t audioTotalBlockTime; ///< 音频播放卡顿累计时长(ms)
uint32_t audioBlockRate; ///< 音频播放卡顿率,音频卡顿累计时长占音频总播放时长的百分比 (%)
uint32_t videoTotalBlockTime; ///< 视频播放卡顿累计时长(ms)
uint32_t videoBlockRate; ///< 视频播放卡顿率,视频卡顿累计时长占音频总播放时长的百分比(%)
TRTCVideoStreamType streamType; ///< 流类型(大画面 | 小画面 | 辅路画面)
TRTCRemoteStatistics()
: userId(nullptr)
, finalLoss(0)
, width(0)
, height(0)
, frameRate(0)
, videoBitrate(0)
, audioSampleRate(0)
, audioBitrate(0)
, jitterBufferDelay(0)
, audioTotalBlockTime(0)
, audioBlockRate(0)
, videoTotalBlockTime(0)
, videoBlockRate(0)
, streamType(TRTCVideoStreamTypeBig)
{
}
};
/**
* 5.19 统计数据
*/
struct TRTCStatistics
{
/** C -> S 上行丢包率(%),
* 该值越小越好,例如,丢包率为0表示网络很好,
* 丢包率为30@%则意味着 SDK 向服务器发送的数据包中会有30@%丢失在上行传输中。
*/
uint32_t upLoss;
/** S -> C 下行丢包率(%),
* 该值越小越好,例如,丢包率为0表示网络很好,
* 丢包率为30@%则意味着 SDK 向服务器发送的数据包中会有30@%丢失在下行传输中。
*/
uint32_t downLoss;
///当前 App 的 CPU 使用率(%)
uint32_t appCpu;
/// 当前系统的 CPU 使用率(%)
uint32_t systemCpu;
/// 延迟(毫秒),
/// 指 SDK 到腾讯云服务器的一次网络往返时间,该值越小越好。
/// 一般低于50ms的 rtt 相对理想,而高于100ms的 rtt 会引入较大的通话延时。
/// 由于数据上下行共享一条网络连接,所以 local 和 remote 的 rtt 相同。
uint32_t rtt;
/// 总接收字节数(包含信令和音视频)
uint32_t receivedBytes;
/// 总发送字节总数(包含信令和音视频)
uint32_t sentBytes;
/// 本地的音视频统计信息,可能有主画面、小画面以及辅路画面等多路的情况,因此是一个数组
TRTCLocalStatistics * localStatisticsArray;
/// 数组 localStatisticsArray 的大小
uint32_t localStatisticsArraySize;
/// 远端成员的音视频统计信息,可能有主画面、小画面以及辅路画面等多路的情况,因此是一个数组
TRTCRemoteStatistics * remoteStatisticsArray;
/// 数组 remoteStatisticsArray 的大小
uint32_t remoteStatisticsArraySize;
TRTCStatistics()
: upLoss(0)
, downLoss(0)
, appCpu(0)
, systemCpu(0)
, rtt(0)
, receivedBytes(0)
, sentBytes(0)
, localStatisticsArray(nullptr)
, localStatisticsArraySize(0)
, remoteStatisticsArray(nullptr)
, remoteStatisticsArraySize(0)
{
}
};
/**
* 5.20 用于存储屏幕分享窗口缩略图和图标的结构体
*/
struct TRTCImageBuffer
{
const char * buffer; ///< 图内容
uint32_t length; ///< 图缓存大小
uint32_t width; ///< 图宽
uint32_t height; ///< 图高
TRTCImageBuffer()
: buffer(nullptr)
, length(0)
, width(0)
, height(0)
{};
};
/**
* 5.21 屏幕分享窗口信息
*
* 您可以通过 getScreenCaptureSources() 枚举可共享的窗口列表,列表通过 ITRTCScreenCaptureSourceList 返回
*/
struct TRTCScreenCaptureSourceInfo {
TRTCScreenCaptureSourceType type; ///< 采集源类型
TXView sourceId; ///< 采集源ID;对于窗口,该字段指示窗口句柄;对于屏幕,该字段指示屏幕ID
const char * sourceName; ///< 采集源名称,UTF8编码
TRTCImageBuffer thumbBGRA; ///< 缩略图内容
TRTCImageBuffer iconBGRA; ///< 图标内容
TRTCScreenCaptureSourceInfo()
: type(TRTCScreenCaptureSourceTypeUnknown)
, sourceId(nullptr)
, sourceName(nullptr)
{};
};
/**
* 5.22 屏幕分享窗口列表
*/
class ITRTCScreenCaptureSourceList
{
protected:
virtual ~ITRTCScreenCaptureSourceList() {}
public:
/**
* @return 窗口个数
*/
virtual uint32_t getCount() = 0;
/**
* @return 窗口信息
*/
virtual TRTCScreenCaptureSourceInfo getSourceInfo(uint32_t index) = 0;
/**
* @brief 遍历完窗口列表后,调用release释放资源。
*/
virtual void release() = 0;
};
/**
* 5.23 屏幕分享参数
*
* 您可以通过设置结构体内的参数控制屏幕分享边框的颜色、宽度、是否采集鼠标等参数
*/
struct TRTCScreenCaptureProperty {
bool enableCaptureMouse; ///< 是否采集目标内容时顺带采集鼠标,默认为 true
bool enableHighLight; ///< 是否高亮正在共享的窗口,默认为 true
bool enableHighPerformance; ///< 是否开启高性能模式(只会在分享屏幕时会生效),开启后屏幕采集性能最佳,但无法过滤远端的高亮边框,默认为 true
int highLightColor; ///< 指定高亮边框颜色,RGB格式,传入0时采用默认颜色,默认颜色为 #8CBF26
int highLightWidth; ///< 指定高亮边框的宽度,传入0时采用默认描边宽度,默认宽度为 5,最大值为 50
bool enableCaptureChildWindow; ///< 窗口采集时是否采集子窗口(与采集窗口具有 Owner 或 Popup 属性),默认为 false
TRTCScreenCaptureProperty()
: enableCaptureMouse(true)
, enableHighLight(true)
, enableHighPerformance(true)
, highLightColor(0)
, highLightWidth(0)
, enableCaptureChildWindow(false)
{
}
};
/**
* 5.24 设备列表和设备 Item 信息
*
* 以下定义仅用于兼容原有接口,具体定义参见 ITXDeviceManager.h 文件
*/
typedef ITXDeviceCollection ITRTCDeviceCollection;
typedef ITXDeviceInfo ITRTCDeviceInfo;
/// @}
}
#ifdef _WIN32
using namespace trtc;
#endif
#endif / * __TRTCCLOUDDEF_H__ */