TRTCCloud.h
51 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
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
/*
* Module: TRTCCloud @ TXLiteAVSDK
*
* Function: 腾讯云视频通话功能的主要接口类
*
* Version: 6.6.7460
*/
#import <Foundation/Foundation.h>
#import <VideoToolbox/VideoToolbox.h>
#import "TRTCCloudDelegate.h"
#import "TRTCCloudDef.h"
/// 腾讯云视频通话功能的主要接口类
@interface TRTCCloud : NSObject
// 请使用 +sharedIntance 方法
+ (instancetype)new __attribute__((unavailable("Use +sharedInstance instead")));
- (instancetype)init __attribute__((unavailable("Use +sharedInstance instead")));
/////////////////////////////////////////////////////////////////////////////////
//
// SDK 基础函数
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 创建与销毁
/// @{
/**
* 创建 TRTCCloud 单例
*/
+ (instancetype)sharedInstance;
/**
* 销毁 TRTCCloud 单例
*/
+ (void)destroySharedIntance;
/**
* 设置回调接口 TRTCCloudDelegate
*
* 您可以通过 TRTCCloudDelegate 获得来自 SDK 的各种状态通知,详见 TRTCCloudDelegate.h 中的定义
*/
@property (nonatomic, weak) id<TRTCCloudDelegate> delegate;
/**
* 设置驱动 TRTCCloudDelegate 回调的队列
*
* SDK 默认会采用 Main Queue 作为驱动 TRTCCloudDelegate,也就是说,如果您不指定自己的 delegateQueue,
* SDK 的 TRTCCloudDelegate 回调都将由 Main Queue 来调用。此时您在 TRTCCloudDelegate 的回调函数里操作 UI 是线程安全的。
*/
@property (nonatomic, strong) dispatch_queue_t delegateQueue;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (一)房间相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 房间相关接口函数
/// @name 房间相关接口函数
/// @{
/**
* 1.1 进入房间
*
* 如果加入成功,您会收到来自 TRTCCloudDelegate 中的 onEnterRoom(result) 回调:
* 如果加入成功,result 会是一个正数(result > 0),代表加入房间的时间消耗,单位是毫秒(ms)。
* 如果加入失败,result 会是一个负数(result < 0),代表进房失败的错误码。
* 进房失败的错误码含义请查阅[错误码表](https://cloud.tencent.com/document/product/647/32257)。
*
* @param param 进房参数,请参考 TRTCParams
* @param scene 应用场景,目前支持视频通话(VideoCall)和在线直播(Live)两种场景
* @note 不管进房是否成功,都必须与 exitRoom 配对使用,在调用 exitRoom 前再次调用 enterRoom 函数会导致不可预期的错误问题。
*/
- (void)enterRoom:(TRTCParams *)param appScene:(TRTCAppScene)scene;
/**
* 1.2 离开房间
*
* 调用 exitRoom() 接口会执行退出房间的相关逻辑,比如释放音视频设备资源和编解码器资源等。
* 待资源释放完毕之后,SDK 会通过 TRTCCloudDelegate 中的 onExitRoom() 回调通知到您。
*
* 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK,请等待 onExitRoom() 回调到来之后再执行相关操作。
* 否则可能会遇到摄像头或麦克风(比如 iOS 里的 AudioSession)被占用等各种异常问题。
*/
- (void)exitRoom;
/**
* 1.3 切换角色,仅适用于直播场景(TRTCAppSceneLIVE)
*
* 在直播场景下,一个用户可能需要在“观众”和“主播”之间来回切换。
* 您可以在进房前通过 TRTCParams 中的 role 字段确定角色,也可以通过 switchRole 在进房后切换角色。
*
* @param role 目标角色。
*/
-(void) switchRole:(TRTCRoleType)role;
/**
* 1.4 请求跨房通话(主播 PK)
*
* TRTC 中两个不同音视频房间中的主播,可以通过“跨房通话”功能拉通连麦通话功能。这样一来,
* 两个主播可以不用退出各自原来的直播间就能进行“连麦 PK”。
*
* 例如:当房间“001”中的主播 A 通过 connectOtherRoom() 跟房间“002”中的主播 B 拉通跨房通话后,
* 房间“001”中的用户都会收到主播 B 的 onUserEnter(B) 回调和 onUserVideoAvailable(B,YES) 回调。
* 房间“002”中的用户都会收到主播 A 的 onUserEnter(A) 回调和 onUserVideoAvailable(A,YES) 回调。
*
* 简言之,跨房通话的本质,就是把两个不同房间中的主播相互分享,让每个房间里的观众都能看到两个主播。
*
* <pre>
* 房间 001 房间 002
* ------------- ------------
* 跨房通话前:| 主播 A | | 主播 B |
* | 观众 U V W | | 观众 X Y Z |
* ------------- ------------
*
* 房间 001 房间 002
* ------------- ------------
* 跨房通话后:| 主播 A B | | 主播 B A |
* | 观众 U V W | | 观众 X Y Z |
* ------------- ------------
* </pre>
*
* 跨房通话的参数考虑到后续扩展字段的兼容性问题,暂时采用了 JSON 格式的参数,要求至少包含两个字段:
* - roomId:房间“001”中的主播 A 要跟房间“002”中的主播 B 连麦,主播 A 调用 connectOtherRoom() 时 roomId 应指定为“002”。
* - userId:房间“001”中的主播 A 要跟房间“002”中的主播 B 连麦,主播 A 调用 connectOtherRoom() 时 userId 应指定为 B 的 userId。
*
* 跨房通话的请求结果会通过 TRTCCloudDelegate 中的 onConnectOtherRoom() 回调通知给您。
*
* <pre>
* NSMutableDictionary * jsonDict = [[NSMutableDictionary alloc] init];
* [jsonDict setObject:@(002) forKey:@"roomId"];
* [jsonDict setObject:@"userB" forKey:@"userId"];
* NSData* jsonData = [NSJSONSerialization dataWithJSONObject:jsonDict options:NSJSONWritingPrettyPrinted error:nil];
* NSString* jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
* [trtc connectOtherRoom:jsonString];
* </pre>
*
* @param param JSON 字符串连麦参数,roomId 代表目标房间号,userId 代表目标用户 ID。
*
**/
- (void)connectOtherRoom:(NSString *)param;
/**
* 1.5 退出跨房通话
*
* 跨房通话的退出结果会通过 TRTCCloudDelegate 中的 onDisconnectOtherRoom() 回调通知给您。
**/
- (void)disconnectOtherRoom;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (二)视频相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 视频相关接口函数
/// @name 视频相关接口函数
/// @{
#if TARGET_OS_IPHONE
/**
* 2.1 开启本地视频的预览画面 (iOS 版本)
*
* 当开始渲染首帧摄像头画面时,您会收到 TRTCCloudDelegate 中的 onFirstVideoFrame(nil) 回调。
*
* @param frontCamera YES:前置摄像头;NO:后置摄像头。
* @param view 承载视频画面的控件
*/
- (void)startLocalPreview:(BOOL)frontCamera view:(TXView *)view;
#elif TARGET_OS_MAC
/**
* 2.1 开启本地视频的预览画面 (Mac 版本)
*
* 在调用该方法前,可以先调用 setCurrentCameraDevice 选择使用 Mac 自带的摄像头还是外接摄像头。
* 当开始渲染首帧摄像头画面时,您会收到 TRTCCloudDelegate 中的 onFirstVideoFrame(nil) 回调。
*
* @param view 承载视频画面的控件
*/
- (void)startLocalPreview:(TXView *)view;
#endif
/**
* 2.2 停止本地视频采集及预览
*/
- (void)stopLocalPreview;
/**
* 2.3 是否屏蔽自己的视频画面
*
* 当屏蔽本地视频后,房间里的其它成员将会收到 onUserVideoAvailable 回调通知
*
* @param mute YES:屏蔽;NO:开启
*/
- (void)muteLocalVideo:(BOOL)mute;
/**
* 2.4 开始显示远端视频画面
*
* 在收到 SDK 的 onUserVideoAvailable(userid, YES) 通知时,可以获知该远程用户开启了视频,
* 之后调用 startRemoteView(userid) 接口加载该用户的远程画面,此时可以用 loading 动画优化加载过程中的等待体验。
* 待该用户的首帧画面开始显示时,您还会收到 onFirstVideoFrame(userid) 事件回调。
*
* @param userId 对方的用户标识
* @param view 承载视频画面的控件
*/
- (void)startRemoteView:(NSString *)userId view:(TXView *)view;
/**
* 2.5 停止显示远端视频画面
*
* 调用此接口后,SDK 会停止接收该用户的远程视频流,同时会清理相关的视频显示资源。
*
* @param userId 对方的用户标识
*/
- (void)stopRemoteView:(NSString *)userId;
/**
* 2.6 停止显示所有远端视频画面
*
* @note 如果有屏幕分享的画面在显示,则屏幕分享的画面也会一并被关闭。
*/
- (void)stopAllRemoteView;
/**
* 2.7 暂停接收指定的远端视频流
*
* 该接口仅停止接收远程用户的视频流,但并不释放显示资源,所以视频画面会冻屏在 mute 前的最后一帧。
*
* @param userId 对方的用户标识
* @param mute 是否停止接收
*/
- (void)muteRemoteVideoStream:(NSString*)userId mute:(BOOL)mute;
/**
* 2.8 停止接收所有远端视频流
*
* @param mute 是否停止接收
*/
- (void)muteAllRemoteVideoStreams:(BOOL)mute;
/**
* 2.9 设置视频编码器相关参数
*
* 该设置决定了远端用户看到的画面质量(同时也是云端录制出的视频文件的画面质量)
*
* @param param 视频编码参数,详情请参考 TRTCCloudDef.h 中的 TRTCVideoEncParam 定义
*/
- (void)setVideoEncoderParam:(TRTCVideoEncParam*)param;
/**
* 2.10 设置网络流控相关参数
*
* 该设置决定了 SDK 在各种网络环境下的调控策略(比如弱网下是“保清晰”还是“保流畅”)
*
* @param param 网络流控参数,详情请参考 TRTCCloudDef.h 中的 TRTCNetworkQosParam 定义
*/
- (void)setNetworkQosParam:(TRTCNetworkQosParam*)param;
/**
* 2.11 设置本地图像的渲染模式
*
* @param mode 填充(画面可能会被拉伸裁剪)或适应(画面可能会有黑边)
*/
- (void)setLocalViewFillMode:(TRTCVideoFillMode)mode;
/**
* 2.12 设置远端图像的渲染模式
*
* @param userId 用户 ID
* @param mode 填充(画面可能会被拉伸裁剪)或适应(画面可能会有黑边)
*/
- (void)setRemoteViewFillMode:(NSString*)userId mode:(TRTCVideoFillMode)mode;
/**
* 2.13 设置本地图像的顺时针旋转角度
*
* @param rotation 支持90、180、270旋转角度
*/
- (void)setLocalViewRotation:(TRTCVideoRotation)rotation;
/**
* 2.14 设置远端图像的顺时针旋转角度
*
* @param userId 用户 ID
* @param rotation 支持90、180、270旋转角度
*/
- (void)setRemoteViewRotation:(NSString*)userId rotation:(TRTCVideoRotation)rotation;
/**
* 2.15 设置视频编码输出的(也就是远端用户观看到的,以及服务器录制下来的)画面方向
*
* 在 iPad、iPhone 等设备180度旋转时,由于摄像头的采集方向没有变,所以另一边的用户看到的画面是上下颠倒的,
* 在这种情况下,您可以通过该接口将 SDK 输出到对方的画面旋转180度,这样可以可以确保对方看到的画面依然正常。
*
* @param rotation 目前支持0和180两个旋转角度
*/
- (void)setVideoEncoderRotation:(TRTCVideoRotation)rotation;
#if TARGET_OS_IPHONE
/**
* 2.16 设置本地摄像头预览画面的镜像模式(iOS)
*
* @param mirror 镜像模式
*/
- (void)setLocalViewMirror:(TRTCLocalVideoMirrorType)mirror;
#elif TARGET_OS_MAC
/**
* 2.17 设置本地摄像头预览画面的镜像模式(Mac)
*
* @param mirror 镜像模式
*/
- (void)setLocalViewMirror:(BOOL)mirror;
#endif
/**
* 2.18 设置编码器输出的画面镜像模式
*
* 该接口不改变本地摄像头的预览画面,但会改变另一端用户看到的(以及服务器录制下来的)画面效果。
*
* @param mirror 是否开启远端镜像,YES:开启远端画面镜像;NO:关闭远端画面镜像;默认值:NO。
*/
- (void)setVideoEncoderMirror:(BOOL)mirror;
/**
* 2.19 设置重力感应的适应模式
*
* @param mode 重力感应模式,详情请参考 TRTCGSensorMode 的定义
*/
- (void)setGSensorMode:(TRTCGSensorMode) mode;
/**
* 2.20 开启大小画面双路编码模式
*
* 如果当前用户是房间中的主要角色(比如主播、老师、主持人等),并且使用 PC 或者 Mac 环境,可以开启该模式。
* 开启该模式后,当前用户会同时输出【高清】和【低清】两路视频流(但只有一路音频流)。
* 对于开启该模式的当前用户,会占用更多的网络带宽,并且会更加消耗 CPU 计算资源。
*
* 对于同一房间的远程观众而言:
* - 如果有些人的下行网络很好,可以选择观看【高清】画面
* - 如果有些人的下行网络不好,可以选择观看【低清】画面
*
* @note 双路编码开启后,会消耗更多的 CPU 和 网络带宽,所以对于 iMac、Windows 或者高性能 Pad 可以考虑开启,但请不要在手机端开启。
*
* @param enable 是否开启小画面编码
* @param smallVideoEncParam 小流的视频参数
* @return 0:成功;-1:大画面已经是最低画质
*/
- (int)enableEncSmallVideoStream:(BOOL)enable withQuality:(TRTCVideoEncParam*)smallVideoEncParam;
/**
* 2.21 选定观看指定 uid 的大画面还是小画面
*
* 此功能需要该 uid 通过 enableEncSmallVideoStream 提前开启双路编码模式。
* 如果该 uid 没有开启双路编码模式,则此操作将无任何反应。
*
* @param userId 用户 ID
* @param type 视频流类型,即选择看大画面还是小画面
*/
- (void)setRemoteVideoStreamType:(NSString*)userId type:(TRTCVideoStreamType)type;
/**
* 2.22 设定观看方优先选择的视频质量
*
* 低端设备推荐优先选择低清晰度的小画面。
* 如果对方没有开启双路视频模式,则此操作无效。
*
* @param type 默认观看大画面还是小画面
*/
- (void)setPriorRemoteVideoStreamType:(TRTCVideoStreamType)type;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (三)音频相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 音频相关接口函数
/// @name 音频相关接口函数
/// @{
/**
* 3.1 开启本地音频的采集和上行
*
* 该函数会启动麦克风采集,并将音频数据传输给房间里的其他用户。
* SDK 并不会默认开启本地的音频上行,也就说,如果您不调用这个函数,房间里的其他用户就听不到您的声音。
*
* @note 该函数会检查麦克风的使用权限,如果当前 App 没有麦克风权限,SDK 会向用户申请开启。
*/
- (void)startLocalAudio;
/**
* 3.2 关闭本地音频的采集和上行
*
* 当关闭本地音频的采集和上行,房间里的其它成员会收到 onUserAudioAvailable(NO) 回调通知。
*/
- (void)stopLocalAudio;
/**
* 3.3 静音本地的音频
*
* 当静音本地音频后,房间里的其它成员会收到 onUserAudioAvailable(NO) 回调通知。
*
* 与 stopLocalAudio 不同之处在于,muteLocalAudio 并不会停止发送音视频数据,而是会继续发送码率极低的静音包。
* 在对录制质量要求很高的场景中,选择 muteLocalAudio 是更好的选择,能录制出兼容性更好的 MP4 文件。
* 这是由于 MP4 等视频文件格式,对于音频的连续性是要求很高的,简单粗暴地 stopLocalAudio 会导致录制出的 MP4 不易播放。
*
* @param mute YES:屏蔽;NO:开启
*/
- (void)muteLocalAudio:(BOOL)mute;
/**
* 3.4 设置音频路由
*
* 微信和手机 QQ 里的视频通话功能,都有一个免提模式,开启后就不用把手机贴在耳朵上,这个功能就是基于音频路由实现的。
* 一般手机都有两个扬声器,一个是位于顶部的听筒扬声器,声音偏小;一个是位于底部的立体声扬声器,声音偏大。
* 设置音频路由的作用就是要决定声音从哪个扬声器播放出来。
*
* @param route 音频路由,即声音由哪里输出(扬声器、听筒)
*/
- (void)setAudioRoute:(TRTCAudioRoute)route;
/**
* 3.5 静音掉某一个用户的声音
*
* @param userId 对方的用户 ID
* @param mute YES:静音;NO:非静音
*/
- (void)muteRemoteAudio:(NSString *)userId mute:(BOOL)mute;
/**
* 3.6 静音掉所有用户的声音
*
* @param mute YES:静音;NO:非静音
*/
- (void)muteAllRemoteAudio:(BOOL)mute;
/**
* 3.7 设置某个远程用户的播放音量
*
* @param userId 远程用户 ID
* @param volume 音量大小,取值0 - 100
*/
- (void)setRemoteAudioVolume:(NSString *)userId volume:(int)volume;
/**
* 3.8 启用音量大小提示
*
* 开启此功能后,SDK 会在 onUserVoiceVolume() 中反馈对每一路声音音量大小值的评估。
* 我们在 Demo 中有一个音量大小的提示条,就是基于这个接口实现的。
* 如希望打开此功能,请在 startLocalAudio() 之前调用。
*
* @param interval 设置 onUserVoiceVolume 回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于0则会关闭回调,建议设置为300ms;
*/
- (void)enableAudioVolumeEvaluation:(NSUInteger)interval;
/**
* 3.9 开始录音
*
* 该方法调用后, SDK 会将通话过程中的所有音频(包括本地音频,远端音频,BGM等)录制到一个文件里。
* 无论是否进房,调用该接口都生效。
* 如果调用 exitRoom 时还在录音,录音会自动停止。
*
* @param TRTCAudioRecordingParams 录音参数,请参考TRTCAudioRecordingParams
* @return 0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持
*/
- (int)startAudioRecording:(TRTCAudioRecordingParams*) param;
/**
* 3.10 停止录音
*
* 如果调用 exitRoom 时还在录音,录音会自动停止。
*/
- (void)stopAudioRecording;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (四)摄像头相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 摄像头相关接口函数
/// @name 摄像头相关接口函数
/// @{
#if TARGET_OS_IPHONE
/**
* 4.1 切换摄像头
*/
- (void)switchCamera;
/**
* 4.2 查询当前摄像头是否支持缩放
*/
- (BOOL)isCameraZoomSupported;
/**
* 4.3 设置摄像头缩放因子(焦距)
*
* 取值范围1 - 5,当为1的时候为最远视角(正常镜头),当为5的时候为最近视角(放大镜头)。
* 这里最大值推荐为5,超过5后视频数据会变得模糊不清。
*
* @param distance 取值范围为1 - 5,数值越大,焦距越远
*/
- (void)setZoom:(CGFloat)distance;
/**
* 4.4 查询是否支持开关闪光灯(手电筒模式)
*/
- (BOOL)isCameraTorchSupported;
/**
* 4.5 开关闪光灯
*
* @param enable YES:开启;NO:关闭
*/
- (BOOL)enbaleTorch:(BOOL)enable;
/**
* 4.6 查询是否支持设置焦点
*/
- (BOOL)isCameraFocusPositionInPreviewSupported;
/**
* 4.7 设置摄像头焦点
*
* @param touchPoint 对焦位置
*/
- (void)setFocusPosition:(CGPoint)touchPoint;
/**
* 4.8 查询是否支持自动识别人脸位置
*/
- (BOOL)isCameraAutoFocusFaceModeSupported;
/**
* 4.9 自动识别人脸位置
*
* @param enable YES:开启;NO:关闭
*/
- (void)enableAutoFaceFoucs:(BOOL)enable;
#elif TARGET_OS_MAC
/**
* 4.10 获取摄像头设备列表
*
* Mac 主机本身自带一个质量很好的摄像头,但它也允许插入 USB 摄像头。
* 如果您希望用户选择自己外接的摄像头,可以提供一个多摄像头选择的功能。
*
* @return 摄像头设备列表,第一项为当前系统默认设备
*/
- (NSArray<TRTCMediaDeviceInfo*>*)getCameraDevicesList;
/**
* 4.11 获取当前使用的摄像头
*/
- (TRTCMediaDeviceInfo*)getCurrentCameraDevice;
/**
* 4.12 设置要使用的摄像头
*
* @param deviceId 从 getCameraDevicesList 中得到的设备 ID
* @return 0:成功;-1:失败
*/
- (int)setCurrentCameraDevice:(NSString*)deviceId;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (五)音频设备相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 音频设备相关接口函数
/// @name 音频设备相关接口函数
/// @{
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
/**
* 5.1 获取麦克风设备列表
*
* Mac 主机本身自带一个质量很好的麦克风,但它也允许用户外接其他的麦克风,而且很多 USB 摄像头上也自带麦克风。
* 如果您希望用户选择自己外接的麦克风,可以提供一个多麦克风选择的功能。
*
* @return 麦克风设备列表,第一项为当前系统默认设备
*/
- (NSArray<TRTCMediaDeviceInfo*>*)getMicDevicesList;
/**
* 5.2 获取当前的麦克风设备
*
* @return 当前麦克风设备信息
*/
- (TRTCMediaDeviceInfo*)getCurrentMicDevice;
/**
* 5.3 设置要使用的麦克风
*
* @param deviceId 从 getMicDevicesList 中得到的设备 ID
* @return 0:成功;<0:失败
*/
- (int)setCurrentMicDevice:(NSString*)deviceId;
/**
* 5.4 获取当前麦克风设备音量
*
* @return 麦克风音量
*/
- (float)getCurrentMicDeviceVolume;
/**
* 5.5 设置麦克风设备的音量
*
* @param volume 麦克风音量值,范围0 - 100
*/
- (void)setCurrentMicDeviceVolume:(NSInteger)volume;
/**
* 5.6 获取扬声器设备列表
*
* @return 扬声器设备列表,第一项为当前系统默认设备
*/
- (NSArray<TRTCMediaDeviceInfo*>*)getSpeakerDevicesList;
/**
* 5.7 获取当前的扬声器设备
*
* @return 当前扬声器设备信息
*/
- (TRTCMediaDeviceInfo*)getCurrentSpeakerDevice;
/**
* 5.8 设置要使用的扬声器
*
* @param deviceId 从 getSpeakerDevicesList 中得到的设备 ID
* @return 0:成功;<0:失败
*/
- (int)setCurrentSpeakerDevice:(NSString*)deviceId;
/**
* 5.9 当前扬声器设备音量
*
* @return 扬声器音量
*/
- (float)getCurrentSpeakerDeviceVolume;
/**
* 5.10 设置当前扬声器音量
*
* @param volume 设置的扬声器音量,范围0 - 100
* @return 0:成功;<0:失败
*/
- (int)setCurrentSpeakerDeviceVolume:(NSInteger)volume;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (六)美颜滤镜相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 美颜滤镜相关接口函数
/// @name 美颜滤镜相关接口函数
/// @{
/**
* 6.1 设置美颜、美白、红润效果级别
*
* SDK 内部集成了两套风格不同的磨皮算法,一套我们取名叫“光滑”,适用于美女秀场,效果比较明显。
* 另一套我们取名“自然”,磨皮算法更多地保留了面部细节,主观感受上会更加自然。
*
* @param beautyStyle 美颜风格,光滑或者自然,光滑风格磨皮更加明显,适合娱乐场景。
* @param beautyLevel 美颜级别,取值范围0 - 9; 0表示关闭,1 - 9值越大,效果越明显。
* @param whitenessLevel 美白级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
* @param ruddinessLevel 红润级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
*/
- (void)setBeautyStyle:(TRTCBeautyStyle)beautyStyle beautyLevel:(NSInteger)beautyLevel
whitenessLevel:(NSInteger)whitenessLevel ruddinessLevel:(NSInteger)ruddinessLevel;
/**
* 6.2 设置指定素材滤镜特效
*
* @param image 指定素材,即颜色查找表图片。**必须使用 png 格式**
*/
- (void)setFilter:(TXImage *)image;
/**
* 6.3 设置滤镜浓度
*
* 在美女秀场等应用场景里,滤镜浓度的要求会比较高,以便更加突显主播的差异。
* 我们默认的滤镜浓度是0.5,如果您觉得滤镜效果不明显,可以使用下面的接口进行调节。
*
* @param concentration 从0到1,越大滤镜效果越明显,默认值为0.5。
*/
- (void)setFilterConcentration:(float)concentration;
/**
* 6.4 添加水印
*
* 水印的位置是通过 rect 来指定的,rect 的格式为 (x,y,width,height)
* - x:水印的坐标,取值范围为0 - 1的浮点数。
* - y:水印的坐标,取值范围为0 - 1的浮点数。
* - width:水印的宽度,取值范围为0 - 1的浮点数。
* - height:是不用设置的,SDK 内部会根据水印图片的宽高比自动计算一个合适的高度。
*
* 举例:如果当前编码分辨率是540 × 960,rect 设置为(0.1,0.1,0.2,0.0)
* 那么:水印的左上坐标点就是 (540 × 0.1,960 × 0.1),也就是 (54,96),水印的宽度是 540 × 0.2 = 108px,高度自动计算。
*
* @param image 水印图片,**必须使用透明底的 png 格式**
* @param streamType 如果要给屏幕分享的一路也设置水印,需要调用两次的 setWatermark。
* @param rect 水印相对于编码分辨率的归一化坐标,x,y,width,height 取值范围0 - 1。
*/
- (void)setWatermark:(TXImage*)image streamType:(TRTCVideoStreamType)streamType rect:(CGRect)rect;
#if TARGET_OS_IPHONE
/**
* 6.5 设置大眼级别(商用企业版有效,其它版本设置此参数无效)
*
* @param eyeScaleLevel 大眼级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
*/
- (void)setEyeScaleLevel:(float)eyeScaleLevel;
/**
* 6.6 设置瘦脸级别(商用企业版有效,其它版本设置此参数无效)
*
* @param faceScaleLevel 瘦脸级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
*/
- (void)setFaceScaleLevel:(float)faceScaleLevel;
/**
* 6.7 设置V脸级别(商用企业版有效,其它版本设置此参数无效)
*
* @param faceVLevel V脸级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
*/
- (void)setFaceVLevel:(float)faceVLevel;
/**
* 6.8 设置下巴拉伸或收缩(商用企业版有效,其它版本设置此参数无效)
*
* @param chinLevel 下巴拉伸或收缩级别,取值范围 -9 - 9;0 表示关闭,小于0表示收缩,大于0表示拉伸。
*/
- (void)setChinLevel:(float)chinLevel;
/**
* 6.9 设置短脸级别(商用企业版有效,其它版本设置此参数无效)
*
* @param faceShortlevel 短脸级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
*/
- (void)setFaceShortLevel:(float)faceShortlevel;
/**
* 6.10 设置瘦鼻级别(商用企业版有效,其它版本设置此参数无效)
*
* @param noseSlimLevel 瘦鼻级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
*/
- (void)setNoseSlimLevel:(float)noseSlimLevel;
/**
* 6.11 设置绿幕背景视频(商用企业版有效,其它版本设置此参数无效)
*
* 此处的绿幕功能并非智能抠背,它需要被拍摄者的背后有一块绿色的幕布来辅助产生特效
*
* @param file 视频文件路径。支持 MP4; nil 表示关闭特效。
*/
- (void)setGreenScreenFile:(NSURL *)file;
/**
* 6.12 选择使用哪一款 AI 动效挂件(商用企业版有效,其它版本设置此参数无效)
*
* @param tmplPath 动效文件路径
*/
- (void)selectMotionTmpl:(NSString *)tmplPath;
/**
* 6.12 设置动效静音(商用企业版有效,其它版本设置此参数无效)
*
* 有些挂件本身会有声音特效,通过此 API 可以关闭这些特效播放时所带的声音效果。
*
* @param motionMute YES:静音;NO:不静音。
*/
- (void)setMotionMute:(BOOL)motionMute;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (七)屏幕共享(辅流)相关函数(MAC)
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 屏幕共享接口函数(MAC)
/// @name 辅流相关接口函数(MAC)
/// @{
/**
* 7.1 开始显示远端用户的屏幕分享画面
*
* 对应于 startRemoteView() 用于显示主画面,该接口只能用于显示辅路(屏幕分享、远程播片)画面。
*
* @param userId 对方的用户标识
* @param view 渲染控件
* @note 请在 onUserSubStreamAvailable 回调后再调用这个接口。
*/
- (void)startRemoteSubStreamView:(NSString *)userId view:(TXView *)view;
/**
* 7.2 停止显示远端用户的屏幕分享画面。
*
* @param userId 对方的用户标识
*/
- (void)stopRemoteSubStreamView:(NSString *)userId;
/**
* 7.3 设置屏幕分享画面的显示模式
*
* 对应于 setRemoteViewFillMode() 于设置主画面的显示模式,该接口用于设置远端的辅路(屏幕分享、远程播片)画面。
*
* @param userId 用户的 ID
* @param mode 填充(画面可能会被拉伸裁剪)或适应(画面可能会有黑边)
*/
- (void)setRemoteSubStreamViewFillMode:(NSString *)userId mode:(TRTCVideoFillMode)mode;
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
/**
* 7.4 枚举可分享的屏幕窗口
*
* 如果您要给您的 App 增加屏幕分享功能,一般需要先显示一个窗口选择界面,这样用户可以选择希望分享的窗口。
* 通过如下函数,您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
* 拿到这些信息后,您就可以实现一个窗口选择界面,当然,您也可以使用我们在 Demo 源码中已经实现好的一个界面。
*
* @note 返回的列表中包括屏幕和应用窗口,屏幕会在列表的前面几个元素中。
*
* @param thumbnailSize 指定要获取的窗口缩略图大小,缩略图可用于绘制在窗口选择界面上
* @param iconSize 指定要获取的窗口图标大小
* @return 窗口列表包括屏幕
*/
- (NSArray<TRTCScreenCaptureSourceInfo*>*)getScreenCaptureSourcesWithThumbnailSize:(CGSize)thumbnailSize iconSize:(CGSize)iconSize;
/**
* 7.5 设置屏幕共享参数,该方法在屏幕共享过程中也可以调用
*
* 如果您期望在屏幕分享的过程中,切换想要分享的窗口,可以再次调用这个函数而不需要重新开启屏幕分享。
*
* @param screenSource 指定分享源
* @param rect 指定捕获的区域(传 CGRectZero 则默认分享全屏)
* @param capturesCursor 是否捕获鼠标光标
* @param highlight 是否高亮正在分享的窗口
*
*/
- (void)selectScreenCaptureTarget:(TRTCScreenCaptureSourceInfo *)screenSource
rect:(CGRect)rect
capturesCursor:(BOOL)capturesCursor
highlight:(BOOL)highlight;
/**
* 7.6 启动屏幕分享
*
* @param view 渲染控件所在的父控件
*/
- (void)startScreenCapture:(NSView *)view;
/**
* 7.7 停止屏幕采集
*
* @return 0:成功;<0:失败
*/
- (int)stopScreenCapture;
/**
* 7.8 暂停屏幕分享
*
* @return 0:成功;<0:失败
*/
- (int)pauseScreenCapture;
/**
* 7.9 恢复屏幕分享
*
* @return 0:成功;<0:失败
*/
- (int)resumeScreenCapture;
/**
* 7.10 设置屏幕分享的编码器参数
*
* 对应于 setVideoEncoderParam() 设置主画面的编码参数,该函数仅用于设置辅路(屏幕分享、远程播片)的编码参数。
* 该设置决定了远端用户看到的画面质量,同时也是云端录制出的视频文件的画面质量。
*
* @param param 辅流编码参数,详情请参考 TRTCCloudDef.h 中的 TRTCVideoEncParam 定义
*/
- (void)setSubStreamEncoderParam:(TRTCVideoEncParam *)param;
/**
* 7.11 设置屏幕分享的混音音量大小
*
* 这个数值越高,辅路音量的占比就约高,麦克风音量占比就越小,所以不推荐设置得太大,否则麦克风的声音就被压制了。
*
* @param volume 设置的音量大小,范围0 - 100
*/
- (void)setSubStreamMixVolume:(NSInteger)volume;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (八)自定义采集和渲染
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 自定义采集和渲染
/// @name 自定义采集和渲染
/// @{
/**
* 8.1 启用视频自定义采集模式
*
* 开启该模式后,SDK 不在运行原有的视频采集流程,只保留编码和发送能力。
* 您需要用 sendCustomVideoData() 不断地向 SDK 塞入自己采集的视频画面。
*
* @param enable 是否启用
*/
- (void)enableCustomVideoCapture:(BOOL)enable;
/**
* 8.2 向 SDK 投送自己采集的视频数据
*
* TRTCVideoFrame 推荐如下填写方式(其他字段不需要填写):
* - pixelFormat:推荐选择 TRTCVideoPixelFormat_NV12。
* - bufferType:推荐选择 TRTCVideoBufferType_PixelBuffer。
* - pixelBuffer:iOS 平台上常用的视频数据格式。
* - data:视频裸数据格式,bufferType 为 NSData 时使用。
* - timestamp:如果 timestamp 间隔不均匀,会严重影响音画同步和录制出的 MP4 质量。
* - width:视频图像长度,bufferType 为 NSData 时填写。
* - height:视频图像宽度,bufferType 为 NSData 时填写。
*
* 参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
*
* @param frame 视频数据,支持 PixelBuffer NV12,BGRA,I420 格式数据。
* @note - SDK 内部有帧率控制逻辑,目标帧率以您在 setVideoEncoderParam 中设置的为准,太快会自动丢帧,太慢则会自动补帧。
* @note - 可以设置 frame 中的 timestamp 为 0,相当于让 SDK 自己设置时间戳,但请“均匀”地控制 sendCustomVideoData 的调用间隔,否则会导致视频帧率不稳定。
*
*/
- (void)sendCustomVideoData:(TRTCVideoFrame *)frame;
/**
* 8.3 设置本地视频的自定义渲染回调
*
* 设置此方法后,SDK 内部会跳过自己原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面的渲染。
* - pixelFormat 指定回调的数据格式,比如 NV12、i420 以及 32BGRA。
* - bufferType 指定 buffer 的类型,直接使用 PixelBuffer 效率最高;使用 NSData 相当于让 SDK 在内部做了一次内存转换,因此会有额外的性能损耗。
*
* @param delegate 自定义渲染回调
* @param pixelFormat 指定回调的像素格式
* @param bufferType PixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。
* @return 0:成功;<0:错误
*/
- (int)setLocalVideoRenderDelegate:(id<TRTCVideoRenderDelegate>)delegate pixelFormat:(TRTCVideoPixelFormat)pixelFormat bufferType:(TRTCVideoBufferType)bufferType;
/**
* 8.4 设置远端视频的自定义渲染回调
*
* 此方法同 setLocalVideoRenderDelegate,区别在于一个是本地画面的渲染回调, 一个是远程画面的渲染回调。
*
* @note 调用此函数之前,需要先调用 startRemoteView 来获取远端用户的视频流(view 设置为 nil 即可),否则不会有数据回调出来。
*
* @param userId 指定目标 userId。
* @param delegate 自定义渲染的回调。
* @param pixelFormat 指定回调的像素格式。
* @param bufferType PixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。
* @return 0:成功;<0:错误
*/
- (int)setRemoteVideoRenderDelegate:(NSString*)userId delegate:(id<TRTCVideoRenderDelegate>)delegate pixelFormat:(TRTCVideoPixelFormat)pixelFormat bufferType:(TRTCVideoBufferType)bufferType;
/**
* 8.5 启用音频自定义采集模式
*
* 开启该模式后,SDK 不在运行原有的音频采集流程,只保留编码和发送能力。
* 您需要用 sendCustomAudioData() 不断地向 SDK 塞入自己采集的视频画面。
*
* @note 由于回声抵消(AEC)需要严格的控制声音采集和播放的时间,所以开启自定义音频采集后,AEC 能力可能会失效。
*
* @param enable 是否启用, true:启用;false:关闭
*/
- (void)enableCustomAudioCapture:(BOOL)enable;
/**
* 8.6 向 SDK 投送自己采集的音频数据
*
* TRTCAudioFrame 推荐如下填写方式:
*
* - data:音频帧 buffer。音频帧数据必须是 PCM 格式,推荐每帧20ms采样数。【48000采样率、单声道的帧长度:48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
* - sampleRate:采样率,仅支持48000。
* - channel:频道数量(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
* - timestamp:如果 timestamp 间隔不均匀,会严重影响音画同步和录制出的 MP4 质量。
*
* 参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
*
* @param frame 音频数据
* @note 可以设置 frame 中的 timestamp 为 0,相当于让 SDK 自己设置时间戳,但请“均匀”地控制 sendCustomAudioData 的调用间隔,否则会导致声音断断续续。
*/
- (void)sendCustomAudioData:(TRTCAudioFrame *)frame;
/**
* 8.7 设置音频数据回调
*
* 设置此方法,SDK 内部会把音频数据(PCM 格式)回调出来,包括:
* - onCapturedAudioFrame:本机麦克风采集到的音频数据
* - onPlayAudioFrame:混音前的每一路远程用户的音频数据
* - onMixedPlayAudioFrame:各路音频数据混合后送入扬声器播放的音频数据
*
* @param delegate 音频数据回调,delegate = nil 则停止回调数据
*/
- (void)setAudioFrameDelegate:(id<TRTCAudioFrameDelegate>)delegate;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (九)自定义消息发送
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 自定义消息发送
/// @name 自定义消息发送
/// @{
/**
* 9.1 发送自定义消息给房间内所有用户
*
* 该接口可以借助音视频数据通道向当前房间里的其他用户广播您自定义的数据,但因为复用了音视频数据通道,
* 请务必严格控制自定义消息的发送频率和消息体的大小,否则会影响音视频数据的质量控制逻辑,造成不确定性的问题。
*
* @param cmdID 消息 ID,取值范围为1 - 10
* @param data 待发送的消息,最大支持1KB(1000字节)的数据大小
* @param reliable 是否可靠发送,可靠发送的代价是会引入一定的延时,因为接收端要暂存一段时间的数据来等待重传
* @param ordered 是否要求有序,即是否要求接收端接收的数据顺序和发送端发送的顺序一致,这会带来一定的接收延时,因为在接收端需要暂存并排序这些消息。
* @return YES:消息已经发出;NO:消息发送失败。
*
* @note 本接口有以下限制:
* - 发送消息到房间内所有用户,每秒最多能发送30条消息。
* - 每个包最大为1KB,超过则很有可能会被中间路由器或者服务器丢弃。
* - 每个客户端每秒最多能发送总计8KB数据。
* - 将 reliable 和 ordered 同时设置为 YES 或 NO,暂不支持交叉设置。
* - 强烈建议不同类型的消息使用不同的 cmdID,这样可以在要求有序的情况下减小消息时延。
*/
- (BOOL)sendCustomCmdMsg:(NSInteger)cmdID data:(NSData *)data reliable:(BOOL)reliable ordered:(BOOL)ordered;
/**
* 9.2 将小数据量的自定义数据嵌入视频帧中
*
* 跟 sendCustomCmdMsg 的原理不同,sendSEIMsg 是将数据直接塞入视频数据头中。因此,即使视频帧被旁路到了直播 CDN 上,
* 这些数据也会一直存在。但是由于要把数据嵌入视频帧中,所以数据本身不能太大,推荐几个字节就好。
*
* 最常见的用法是把自定义的时间戳(timstamp)用 sendSEIMsg 嵌入视频帧中,这种方案的最大好处就是可以实现消息和画面的完美对齐。
*
* @param data 待发送的数据,最大支持1kb(1000字节)的数据大小
* @param repeatCount 发送数据次数
* @return YES:消息已通过限制,等待后续视频帧发送;NO:消息被限制发送
*
* @note 本接口有以下限制:
* - 数据在接口调用完后不会被即时发送出去,而是从下一帧视频帧开始带在视频帧中发送。
* - 发送消息到房间内所有用户,每秒最多能发送30条消息(与 sendCustomCmdMsg 共享限制)。
* - 每个包最大为1KB,若发送大量数据,会导致视频码率增大,可能导致视频画质下降甚至卡顿(与 sendCustomCmdMsg 共享限制)。
* - 每个客户端每秒最多能发送总计8KB数据(与 sendCustomCmdMsg 共享限制)。
* - 若指定多次发送(repeatCount>1),则数据会被带在后续的连续 repeatCount 个视频帧中发送出去,同样会导致视频码率增大。
* - 如果 repeatCount>1,多次发送,接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息,需要去重。
*/
- (BOOL)sendSEIMsg:(NSData *)data repeatCount:(int)repeatCount;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (十)背景混音相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 背景混音相关接口函数
/// @name 背景混音相关接口函数
/// @{
/**
* 10.1 启动播放背景音乐
*
* @param path 音乐文件路径
* @param beginNotify 音乐播放开始的回调通知
* @param progressNotify 音乐播放的进度通知,单位毫秒
* @param completeNotify 音乐播放结束的回调通知
*/
- (void) playBGM:(NSString *)path
withBeginNotify:(void (^)(NSInteger errCode))beginNotify
withProgressNotify:(void (^)(NSInteger progressMS, NSInteger durationMS))progressNotify
andCompleteNotify:(void (^)(NSInteger errCode))completeNotify;
/**
* 10.2 停止播放背景音乐
*/
- (void)stopBGM;
/**
* 10.3 暂停播放背景音乐
*/
- (void)pauseBGM;
/**
* 10.4 继续播放背景音乐
*/
- (void)resumeBGM;
/**
* 10.5 获取音乐文件总时长,单位毫秒
*
* @param path 音乐文件路径,如果 path 为空,那么返回当前正在播放的 music 时长。
* @return 成功返回时长,失败返回-1
*/
- (NSInteger)getBGMDuration:(NSString *)path;
/**
* 10.6 设置 BGM 播放进度
*
* @param pos 单位毫秒
* @return 0:成功;-1:失败
*/
- (int)setBGMPosition:(NSInteger)pos;
/**
* 10.7 设置麦克风的音量大小,播放背景音乐混音时使用,用来控制麦克风音量大小。
*
* @param volume 音量大小,100为正常音量,取值范围为0 - 200。
*/
- (void)setMicVolumeOnMixing:(NSInteger)volume;
/**
* 10.8 设置背景音乐的音量大小,播放背景音乐混音时使用,用来控制背景音音量大小。
*
* @param volume 音量大小,100为正常音量,取值范围为0 - 200,如果需要调大背景音量可以设置更大的值。
*/
- (void)setBGMVolume:(NSInteger)volume;
/**
* 10.9 设置混响效果 (目前仅支持 iOS)
*
* @param reverbType 混响类型,详见 TXReverbType
*/
- (void)setReverbType:(TRTCReverbType)reverbType;
/**
* 10.10 设置变声类型 (目前仅支持 iOS)
*
* @param voiceChangerType 变声类型,详见 TXVoiceChangerType
*/
- (void)setVoiceChangerType:(TRTCVoiceChangerType)voiceChangerType;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (十一)设备和网络测试
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 设备和网络测试
/// @name 设备和网络测试
/// @{
/**
* 11.1 开始进行网络测速(视频通话期间请勿测试,以免影响通话质量)
*
* 测速结果将会用于优化 SDK 接下来的服务器选择策略,因此推荐您在用户首次通话前先进行一次测速,这将有助于我们选择最佳的服务器。
* 同时,如果测试结果非常不理想,您可以通过醒目的 UI 提示用户选择更好的网络。
*
* @note 测速本身会消耗一定的流量,所以也会产生少量额外的流量费用。
*
* @param sdkAppId 应用标识
* @param userId 用户标识
* @param userSig 用户签名
* @param completion 测试回调,会分多次回调
*/
- (void)startSpeedTest:(uint32_t)sdkAppId userId:(NSString *)userId userSig:(NSString *)userSig completion:(void(^)(TRTCSpeedTestResult* result, NSInteger completedCount, NSInteger totalCount))completion;
/**
* 11.2 停止服务器测速
*/
- (void)stopSpeedTest;
#if TARGET_OS_OSX
/**
* 11.3 开始进行摄像头测试
*
* @note 在测试过程中可以使用 setCurrentCameraDevice 接口切换摄像头。
* @param view 预览控件所在的父控件
*/
- (void)startCameraDeviceTestInView:(NSView *)view;
/**
* 11.4 结束视频测试预览
*/
- (void)stopCameraDeviceTest;
/**
* 11.5 开始进行麦克风测试
*
* 该方法测试麦克风是否能正常工作,volume 的取值范围为0 - 100。
*/
- (void)startMicDeviceTest:(NSInteger)interval testEcho:(void (^)(NSInteger volume))testEcho;
/**
* 11.6 停止麦克风测试
*/
- (void)stopMicDeviceTest;
/**
* 11.7 开始扬声器测试
*
* 该方法播放指定的音频文件测试播放设备是否能正常工作。如果能听到声音,说明播放设备能正常工作。
*/
- (void)startSpeakerDeviceTest:(NSString*)audioFilePath onVolumeChanged:(void (^)(NSInteger volume, BOOL isLastFrame))volumeBlock;
/**
* 11.8 停止扬声器测试
*/
- (void)stopSpeakerDeviceTest;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (十二)混流转码以及 CDN 旁路推流
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - 混流转码以及 CDN 旁路推流
/// @name 混流转码以及 CDN 旁路推流
/// @{
/**
* 12.1 设置云端的混流转码参数
*
* 该接口会向腾讯云的转码服务器发送一条指令,目的是将房间里的多路画面叠加到一路画面上。
*
* 如果您在实时音视频 [控制台](https://console.cloud.tencent.com/rav/) 中的功能配置页开启了“启动自动旁路直播”功能,
* 房间里的每一路画面都会有一个对应的直播 [CDN 地址](https://cloud.tencent.com/document/product/647/16826),
* 此时您可以通过云端混流,将多路直播地址的画面混合成一路,这样直播 CDN 上就可以看到混合后的画面。
*
* 您可以通过转码参数来调整每一路画面的位置以及最终输出的画面质量。
*
* 参考文档:[云端混流转码](https://cloud.tencent.com/document/product/647/16827)。
* 示例代码:我们在 Demo 中增加了该功能的体验入口,您可以在“更多功能”面板中看到“云端画面混合”和“分享播放地址”体验到该功能。
*
* <pre>
* 【画面1】=> 解码 => =>
* \
* 【画面2】=> 解码 => 画面混合 => 编码 => 【混合后的画面】
* /
* 【画面3】=> 解码 => =>
* </pre>
*
* @param config 请参考 TRTCCloudDef.h 中关于 TRTCTranscodingConfig 的介绍。如果传入 nil 则取消云端混流转码。
* @note 关于云端混流的注意事项:
* - 云端转码会引入一定的 CDN 观看延时,大概会增加1 - 2秒。
* - 调用该函数的用户,会将多路画面混合到自己这一路的 [CDN 地址](https://cloud.tencent.com/document/product/647/16826) 上。
*/
- (void)setMixTranscodingConfig:(TRTCTranscodingConfig*)config;
/**
* 12.2 旁路转推到指定的推流地址
*
* 该接口会向腾讯云的转推服务器发送一条指令,腾讯云会将当前一路的音视频画面转推到您指定的 rtmp 推流地址上。
*
* 在实时音视频 [控制台](https://console.cloud.tencent.com/rav/) 中的功能配置页开启了“启动自动旁路直播”功能后,
* 房间里的每一路画面都有一路默认的腾讯云 CDN 地址,所以该功能并不常用,仅在您需要适配多家 CDN 服务商时才需要关注该功能。
*
* 由于仅转推单独的一路画面到直播 CDN 并没有什么太大的意义,所以该方案通常是跟云端转码混合使用的。
* 也就是先通过 setMixTranscodingConfig 将房间里的多路画面混合到一路上,再转推出去。
*
* @param param 请参考 TRTCCloudDef.h 中关于 TRTCPublishCDNParam 的介绍。
* @note 关于旁路转推的注意事项:
* - 默认只支持转推到腾讯云的 rtmp [推流地址](https://cloud.tencent.com/document/product/267/32720) 上,转推其他云的需求请通过工单联系我们。
* - 调用该函数的用户,只会转推自己这一路画面到指定的 rtmp 推流地址上,因此一般需要配合 setMixTranscodingConfig 一起使用。
* - TRTC 房间里的每一路画面都有一路默认的腾讯云 CDN 地址(需要开启),所以该功能并不常用,仅在您需要适配多家 CDN 服务商时才需要关注该功能。
*/
- (void) startPublishCDNStream:(TRTCPublishCDNParam*)param;
/**
* 12.3 停止旁路推流
*/
- (void) stopPublishCDNStream;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (十三)Log 相关接口函数
//
/////////////////////////////////////////////////////////////////////////////////
/// @name Log 相关接口函数
/// @{
#pragma mark - LOG 相关接口函数
/**
* 13.1 获取 SDK 版本信息
*/
+ (NSString *)getSDKVersion;
/**
* 13.2 设置 Log 输出级别
*
* @param level 参见 TRTCLogLevel
*/
+ (void)setLogLevel:(TRTCLogLevel)level;
/**
* 13.3 启用或禁用控制台日志打印
*
* @param enabled 指定是否启用
*/
+ (void)setConsoleEnabled:(BOOL)enabled;
/**
* 13.4 启用或禁用 Log 的本地压缩。
*
* 开启压缩后,Log 存储体积明显减小,但需要腾讯云提供的 Python 脚本解压后才能阅读。
* 禁用压缩后,Log 采用明文存储,可以直接用记事本打开阅读,但占用空间较大。
*
* @param enabled 指定是否启用
*/
+ (void)setLogCompressEnabled:(BOOL)enabled;
/**
* 13.5 修改日志保存路径
*
* @note 日志文件默认保存在 sandbox Documents/log 下,如需修改,必须在所有方法前调用。
* @param path 存储日志路径
*/
+ (void)setLogDirPath:(NSString *)path;
/**
* 13.6 设置日志回调
*/
+ (void)setLogDelegate:(id<TRTCLogDelegate>)logDelegate;
/**
* 13.7 显示仪表盘
*
* 仪表盘是状态统计和事件消息浮层 view,方便调试。
* @param showType 0:不显示;1:显示精简版;2:显示全量版
*/
- (void)showDebugView:(NSInteger)showType;
/**
* 13.8 设置仪表盘的边距
*
* 必须在 showDebugView 调用前设置才会生效
* @param userId 用户 ID
* @param margin 仪表盘内边距,注意这里是基于 parentView 的百分比,margin 的取值范围是0 - 1
*/
- (void)setDebugViewMargin:(NSString *)userId margin:(TXEdgeInsets)margin;
/**
* 13.9 调用实验性 API 接口
*
* @note 该接口用于调用一些实验性功能
* @param jsonStr 接口及参数描述的 JSON 字符串
*/
- (void)callExperimentalAPI:(NSString*)jsonStr;
/// @}
@end