TRTCCloudDelegate.h
27.9 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
/*
* Module: TRTCCloudDelegate @ TXLiteAVSDK
*
* Function: 腾讯云视频通话功能的事件回调接口
*
*/
#import <Foundation/Foundation.h>
#import "TRTCCloudDef.h"
#import "TXLiteAVCode.h"
NS_ASSUME_NONNULL_BEGIN
@class TRTCCloud;
@class TRTCStatistics;
/// @defgroup TRTCCloudDelegate_ios TRTCCloudDelegate
/// 腾讯云视频通话功能的事件回调接口
/// @{
@protocol TRTCCloudDelegate <NSObject>
@optional
/////////////////////////////////////////////////////////////////////////////////
//
// (一)错误事件和警告事件
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 错误事件和警告事件
/// @{
/**
* 1.1 错误回调,表示 SDK 不可恢复的错误,一定要监听并分情况给用户适当的界面提示。
*
* @param errCode 错误码
* @param errMsg 错误信息
* @param extInfo 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题
*/
- (void)onError:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg extInfo:(nullable NSDictionary*)extInfo;
/**
* 1.2 警告回调,用于告知您一些非严重性问题,例如出现了卡顿或者可恢复的解码失败。
*
* @param warningCode 警告码
* @param warningMsg 警告信息
* @param extInfo 扩展信息字段,个别警告码可能会带额外的信息帮助定位问题
*/
- (void)onWarning:(TXLiteAVWarning)warningCode warningMsg:(nullable NSString *)warningMsg extInfo:(nullable NSDictionary*)extInfo;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (二)房间事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 房间事件回调
/// @{
/**
* 2.1 已加入房间的回调
*
* 调用 TRTCCloud 中的 enterRoom() 接口执行进房操作后,会收到来自 SDK 的 onEnterRoom(result) 回调:
*
* - 如果加入成功,result 会是一个正数(result > 0),代表加入房间的时间消耗,单位是毫秒(ms)。
* - 如果加入失败,result 会是一个负数(result < 0),代表进房失败的错误码。
* 进房失败的错误码含义请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
*
* @note 在 Ver6.6 之前的版本,只有进房成功会抛出 onEnterRoom(result) 回调,进房失败由 onError() 回调抛出。
* 在 Ver6.6 及之后改为:进房成功返回正的 result,进房失败返回负的 result,同时进房失败也会有 onError() 回调抛出。
*
* @param result result > 0 时为进房耗时(ms),result < 0 时为进房错误码。
*/
- (void)onEnterRoom:(NSInteger)result;
/**
* 2.2 离开房间的事件回调
*
* 调用 TRTCCloud 中的 exitRoom() 接口会执行退出房间的相关逻辑,例如释放音视频设备资源和编解码器资源等。
* 待资源释放完毕,SDK 会通过 onExitRoom() 回调通知到您。
*
* 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK,请等待 onExitRoom() 回调到来之后再执行相关操作。
* 否则可能会遇到音频设备(例如 iOS 里的 AudioSession)被占用等各种异常问题。
*
* @param reason 离开房间原因,0:主动调用 exitRoom 退房;1:被服务器踢出当前房间;2:当前房间整个被解散。
*/
- (void)onExitRoom:(NSInteger)reason;
/**
* 2.3 切换角色的事件回调
*
* 调用 TRTCCloud 中的 switchRole() 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程,
* 待 SDK 切换完成后,会抛出 onSwitchRole() 事件回调。
*
* @param errCode 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
* @param errMsg 错误信息。
*/
- (void)onSwitchRole:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/**
* 2.4 请求跨房通话(主播 PK)的结果回调
*
* 调用 TRTCCloud 中的 connectOtherRoom() 接口会将两个不同房间中的主播拉通视频通话,也就是所谓的“主播PK”功能。
* 调用者会收到 onConnectOtherRoom() 回调来获知跨房通话是否成功,
* 如果成功,两个房间中的所有用户都会收到 PK 主播的 onUserVideoAvailable() 回调。
*
* @param userId 要 PK 的目标主播 userid。
* @param errCode 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
* @param errMsg 错误信息。
*/
- (void)onConnectOtherRoom:(NSString*)userId errCode:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/**
* 2.5 结束跨房通话(主播 PK)的结果回调
*/
- (void)onDisconnectOtherRoom:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/**
* 2.6 切换房间 (switchRoom) 的结果回调
*/
- (void)onSwitchRoom:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (三)成员事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 成员事件回调
/// @{
/**
* 3.1 有用户加入当前房间
*
* 出于性能方面的考虑,在两种不同的应用场景下,该通知的行为会有差别:
* - 通话场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下用户没有角色的区别,任何用户进入房间都会触发该通知。
* - 直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):该场景不限制观众的数量,如果任何用户进出都抛出回调会引起很大的性能损耗,所以该场景下只有主播进入房间时才会触发该通知,观众进入房间不会触发该通知。
*
*
* @note 注意 onRemoteUserEnterRoom 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“成员列表”,如果需要显示远程画面,建议使用监听 onUserVideoAvailable() 事件回调。
*
* @param userId 用户标识
*/
- (void)onRemoteUserEnterRoom:(NSString *)userId;
/**
* 3.2 有用户离开当前房间
*
* 与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景下,该通知的行为会有差别:
* - 通话场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下用户没有角色的区别,任何用户的离开都会触发该通知。
* - 直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):只有主播离开房间时才会触发该通知,观众离开房间不会触发该通知。
*
* @param userId 用户标识
* @param reason 离开原因,0 表示用户主动退出房间,1 表示用户超时退出,2 表示被踢出房间。
*/
- (void)onRemoteUserLeaveRoom:(NSString *)userId reason:(NSInteger)reason;
/**
* 3.3 远端用户是否存在可播放的主路画面(一般用于摄像头)
*
* 当您收到 onUserVideoAvailable(userid, YES) 通知时,表示该路画面已经有可用的视频数据帧到达。
* 此时,您需要调用 startRemoteView(userid) 接口加载该用户的远程画面。
* 然后,您会收到名为 onFirstVideoFrame(userid) 的首帧画面渲染回调。
*
* 当您收到 onUserVideoAvailable(userid, NO) 通知时,表示该路远程画面已被关闭,
* 可能由于该用户调用了 muteLocalVideo() 或 stopLocalPreview()。
*
* @param userId 用户标识
* @param available 画面是否开启
*/
- (void)onUserVideoAvailable:(NSString *)userId available:(BOOL)available;
/**
* 3.4 远端用户是否存在可播放的辅路画面(一般用于屏幕分享)
*
* @note 显示辅路画面使用的函数是 startRemoteSubStreamView() 而非 startRemoteView()。
* @param userId 用户标识
* @param available 屏幕分享是否开启
*/
- (void)onUserSubStreamAvailable:(NSString *)userId available:(BOOL)available;
/**
* 3.5 远端用户是否存在可播放的音频数据
*
* @param userId 用户标识
* @param available 声音是否开启
*/
- (void)onUserAudioAvailable:(NSString *)userId available:(BOOL)available;
/**
* 3.6 开始渲染本地或远程用户的首帧画面
*
* 如果 userId == nil,代表开始渲染本地采集的摄像头画面,需要您先调用 startLocalPreview 触发。
* 如果 userId != nil,代表开始渲染远程用户的首帧画面,需要您先调用 startRemoteView 触发。
*
* @note 只有当您调用 startLocalPreivew()、startRemoteView() 或 startRemoteSubStreamView() 之后,才会触发该回调。
*
* @param userId 本地或远程用户 ID,如果 userId == nil 代表本地,userId != nil 代表远程。
* @param streamType 视频流类型:摄像头或屏幕分享。
* @param width 画面宽度
* @param height 画面高度
*/
- (void)onFirstVideoFrame:(NSString*)userId streamType:(TRTCVideoStreamType)streamType width:(int)width height:(int)height;
/**
* 3.7 开始播放远程用户的首帧音频(本地声音暂不通知)
*
* @param userId 远程用户 ID。
*/
- (void)onFirstAudioFrame:(NSString*)userId;
/**
* 3.8 首帧本地视频数据已经被送出
*
* SDK 会在 enterRoom() 并 startLocalPreview() 成功后开始摄像头采集,并将采集到的画面进行编码。
* 当 SDK 成功向云端送出第一帧视频数据后,会抛出这个回调事件。
*
* @param streamType 视频流类型,主画面、小画面或辅流画面(屏幕分享)
*/
- (void)onSendFirstLocalVideoFrame: (TRTCVideoStreamType)streamType;
/**
* 3.9 首帧本地音频数据已经被送出
*
* SDK 会在 enterRoom() 并 startLocalAudio() 成功后开始麦克风采集,并将采集到的声音进行编码。
* 当 SDK 成功向云端送出第一帧音频数据后,会抛出这个回调事件。
*/
- (void)onSendFirstLocalAudioFrame;
/**
* 3.10 废弃接口:有主播加入当前房间
*
* 该回调接口可以被看作是 onRemoteUserEnterRoom 的废弃版本,不推荐使用。请使用 onUserVideoAvailable 或 onRemoteUserEnterRoom 进行替代。
*
* @note 该接口已被废弃,不推荐使用
*
* @param userId 用户标识
*/
- (void)onUserEnter:(NSString *)userId DEPRECATED_ATTRIBUTE;
/**
* 3.11 废弃接口:有主播离开当前房间
*
* 该回调接口可以被看作是 onRemoteUserLeaveRoom 的废弃版本,不推荐使用。请使用 onUserVideoAvailable 或 onRemoteUserLeaveRoom 进行替代。
*
* @note 该接口已被废弃,不推荐使用
*
* @param userId 用户标识
* @param reason 离开原因。
*/
- (void)onUserExit:(NSString *)userId reason:(NSInteger)reason DEPRECATED_ATTRIBUTE;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (四)统计和质量回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 统计和质量回调
/// @{
/**
* 4.1 网络质量,该回调每2秒触发一次,统计当前网络的上行和下行质量
*
* @note userId == nil 代表自己当前的视频质量
*
* @param localQuality 上行网络质量
* @param remoteQuality 下行网络质量
*/
- (void)onNetworkQuality: (TRTCQualityInfo*)localQuality remoteQuality:(NSArray<TRTCQualityInfo*>*)remoteQuality;
/**
* 4.2 技术指标统计回调
*
* 如果您是熟悉音视频领域相关术语,可以通过这个回调获取 SDK 的所有技术指标。
* 如果您是首次开发音视频相关项目,可以只关注 onNetworkQuality 回调。
*
* @param statistics 统计数据,包括本地和远程的
* @note 每2秒回调一次
*/
- (void)onStatistics: (TRTCStatistics *)statistics;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (五)服务器事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 服务器事件回调
/// @{
/**
* 5.1 SDK 跟服务器的连接断开
*/
- (void)onConnectionLost;
/**
* 5.2 SDK 尝试重新连接到服务器
*/
- (void)onTryToReconnect;
/**
* 5.3 SDK 跟服务器的连接恢复
*/
- (void)onConnectionRecovery;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (六)硬件设备事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 硬件设备事件回调
/// @{
/**
* 6.1 摄像头准备就绪
*/
- (void)onCameraDidReady;
/**
* 6.2 麦克风准备就绪
*/
- (void)onMicDidReady;
#if TARGET_OS_IPHONE
/**
* 6.3 音频路由发生变化(仅 iOS),音频路由即声音由哪里输出(扬声器或听筒)
*
* @param route 当前音频路由
* @param fromRoute 变更前的音频路由
*/
- (void)onAudioRouteChanged:(TRTCAudioRoute)route fromRoute:(TRTCAudioRoute)fromRoute;
#endif
/**
* 6.4 用于提示音量大小的回调,包括每个 userId 的音量和远端总音量
*
* 您可以通过调用 TRTCCloud 中的 enableAudioVolumeEvaluation 接口来开关这个回调或者设置它的触发间隔。
* 需要注意的是,调用 enableAudioVolumeEvaluation 开启音量回调后,无论频道内是否有人说话,都会按设置的时间间隔调用这个回调;
* 如果没有人说话,则 userVolumes 为空,totalVolume 为 0。
*
* @param userVolumes 所有正在说话的房间成员的音量,取值范围 0 - 100。
* @param totalVolume 所有远端成员的总音量, 取值范围 0 - 100。
* @note userId 为 nil 时表示自己的音量,userVolumes 内仅包含正在说话(音量不为 0 )的用户音量信息。
*/
- (void)onUserVoiceVolume:(NSArray<TRTCVolumeInfo *> *)userVolumes totalVolume:(NSInteger)totalVolume;
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
/**
* 6.5 本地设备通断回调
*
* @param deviceId 设备 ID
* @param deviceType 设备类型
* @param state 0:设备断开;1:设备连接
*/
- (void)onDevice:(NSString *)deviceId type:(TRTCMediaDeviceType)deviceType stateChanged:(NSInteger)state;
/**
* 6.6 当前音频采集设备音量变化回调
*
* @note 使用 enableAudioVolumeEvaluation(interval>0)开启,(interval == 0)关闭
*
* @param volume 音量 取值范围 0 - 100
* @param muted 当前采集音频设备是否被静音:YES 被静音了,NO 未被静音
*/
- (void)onAudioDeviceCaptureVolumeChanged:(NSInteger)volume muted:(BOOL)muted;
/**
* 6.7 当前音频播放设备音量变化回调
*
* @note 使用 enableAudioVolumeEvaluation(interval>0)开启,(interval == 0)关闭
*
* @param volume 音量 取值范围 0 - 100
* @param muted 当前音频播放设备是否被静音:YES 被静音了,NO 未被静音
*/
- (void)onAudioDevicePlayoutVolumeChanged:(NSInteger)volume muted:(BOOL)muted;
/**
* 6.8 系统声音采集结果回调
*
* 系统声音采集接口 startSystemAudioLoopback 会触发这个回调
*
* @param err ERR_NULL 表示成功,其余值表示失败
*/
- (void)onSystemAudioLoopbackError:(TXLiteAVError)err;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (七)自定义消息的接收回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 自定义消息的接收回调
/// @{
/**
* 7.1 收到自定义消息回调
*
* 当房间中的某个用户使用 sendCustomCmdMsg 发送自定义消息时,房间中的其它用户可以通过 onRecvCustomCmdMsg 接口接收消息
*
* @param userId 用户标识
* @param cmdID 命令 ID
* @param seq 消息序号
* @param message 消息数据
*/
- (void)onRecvCustomCmdMsgUserId:(NSString *)userId cmdID:(NSInteger)cmdID seq:(UInt32)seq message:(NSData *)message;
/**
* 7.2 自定义消息丢失回调
*
* 实时音视频使用 UDP 通道,即使设置了可靠传输(reliable),也无法确保100@%不丢失,只是丢消息概率极低,能满足常规可靠性要求。
* 在发送端设置了可靠运输(reliable)后,SDK 都会通过此回调通知过去时间段内(通常为5s)传输途中丢失的自定义消息数量统计信息。
*
* @note 只有在发送端设置了可靠传输(reliable),接收方才能收到消息的丢失回调
* @param userId 用户标识
* @param cmdID 命令 ID
* @param errCode 错误码
* @param missed 丢失的消息数量
*/
- (void)onMissCustomCmdMsgUserId:(NSString *)userId cmdID:(NSInteger)cmdID errCode:(NSInteger)errCode missed:(NSInteger)missed;
/**
* 7.3 收到 SEI 消息的回调
*
* 当房间中的某个用户使用 sendSEIMsg 发送数据时,房间中的其它用户可以通过 onRecvSEIMsg 接口接收数据。
*
* @param userId 用户标识
* @param message 数据
*/
- (void)onRecvSEIMsg:(NSString *)userId message:(NSData*)message;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (八)CDN 旁路回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name CDN 旁路转推回调
/// @{
/**
* 8.1 开始向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 startPublishing() 接口
*
* @param err 0表示成功,其余值表示失败
* @param errMsg 具体错误原因
*/
- (void)onStartPublishing:(int)err errMsg:(NSString*)errMsg;
/**
* 8.2 停止向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 stopPublishing() 接口
*
* @param err 0表示成功,其余值表示失败
* @param errMsg 具体错误原因
*/
- (void)onStopPublishing:(int)err errMsg:(NSString*)errMsg;
/**
* 8.3 启动旁路推流到 CDN 完成的回调
*
* 对应于 TRTCCloud 中的 startPublishCDNStream() 接口
*
* @note Start 回调如果成功,只能说明转推请求已经成功告知给腾讯云,如果目标 CDN 有异常,还是有可能会转推失败。
*/
- (void)onStartPublishCDNStream:(int)err errMsg:(NSString *)errMsg;
/**
* 8.4 停止旁路推流到 CDN 完成的回调
*
* 对应于 TRTCCloud 中的 stopPublishCDNStream() 接口
*
*/
- (void)onStopPublishCDNStream:(int)err errMsg:(NSString *)errMsg;
/**
* 8.5 设置云端的混流转码参数的回调,对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口
*
* @param err 0表示成功,其余值表示失败
* @param errMsg 具体错误原因
*/
- (void)onSetMixTranscodingConfig:(int)err errMsg:(NSString*)errMsg;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (九)音效回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 音效回调
/// @{
/**
* 播放音效结束回调
*
* @param effectId 音效 ID
* @param code 0 表示播放正常结束;其他表示异常结束
* @note 该接口已不再维护,推荐使用 TXAudioEffectManager.startPlayMusic 及相关回调
*/
- (void)onAudioEffectFinished:(int) effectId code:(int) code DEPRECATED_ATTRIBUTE;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (十)屏幕分享回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 屏幕分享回调
/// @{
/**
* 10.1 当屏幕分享开始时,SDK 会通过此回调通知
*/
- (void)onScreenCaptureStarted;
/**
* 10.2 当屏幕分享暂停时,SDK 会通过此回调通知
*
* @param reason 原因,0:用户主动暂停;1:屏幕窗口不可见暂停
*/
- (void)onScreenCapturePaused:(int)reason;
/**
* 10.3 当屏幕分享恢复时,SDK 会通过此回调通知
*
* @param reason 恢复原因,0:用户主动恢复;1:屏幕窗口恢复可见从而恢复分享
*/
- (void)onScreenCaptureResumed:(int)reason;
/**
* 10.4 当屏幕分享停止时,SDK 会通过此回调通知
*
* @param reason 停止原因,0:用户主动停止;1:屏幕窗口关闭导致停止
*/
- (void)onScreenCaptureStoped:(int)reason;
/// @}
#if TARGET_OS_IPHONE
/////////////////////////////////////////////////////////////////////////////////
//
// (十一)媒体录制回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 媒体录制回调
/// @{
/**
* 11.1 媒体录制回调
*
* @param errCode 错误码 0:初始化录制成功;-1:初始化录制失败;-2: 文件后缀名有误。
* @param storagePath 录制文件存储路径
*/
- (void)onLocalRecordBegin:(NSInteger)errCode storagePath:(NSString *)storagePath;
/**
* 11.2 录制信息更新回调
*
* @param storagePath 录制文件存储路径
* @param duration 录制时长,单位毫秒
*/
- (void)onLocalRecording:(NSInteger)duration storagePath:(NSString *)storagePath;
/**
* 11.2 录制任务已结束
*
* @param errCode 错误码 0:录制成功;-1:录制失败;-2:切换分辨率或横竖屏导致录制结束。
* @param storagePath 录制文件存储路径
*/
- (void)onLocalRecordComplete:(NSInteger)errCode storagePath:(NSString *)storagePath;
///@}
#endif
@end
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// (十二)自定义视频渲染回调
//
/////////////////////////////////////////////////////////////////////////////////
#pragma mark - TRTCVideoRenderDelegate
/// @addtogroup TRTCCloudDelegate_ios
/// @{
/**
* 视频数据帧的自定义处理回调
*/
@protocol TRTCVideoRenderDelegate <NSObject>
/**
* 自定义视频渲染回调
*
* @param frame 待渲染的视频帧信息
* @param userId 视频源的 userId,如果是本地视频回调(setLocalVideoRenderDelegate),该参数可以忽略
* @param streamType 视频源类型,例如,使用摄像头画面或屏幕分享画面等
*/
@optional
- (void) onRenderVideoFrame:(TRTCVideoFrame * _Nonnull)frame userId:(NSString* __nullable)userId streamType:(TRTCVideoStreamType)streamType;
@end
/////////////////////////////////////////////////////////////////////////////////
//
// (十三)第三方美颜回调
//
/////////////////////////////////////////////////////////////////////////////////
@protocol TRTCVideoFrameDelegate <NSObject>
@optional
/**
* 第三方美颜的视频数据回调,需要使用 TRTCCloud 中的 setLocalVideoProcessDelegete 接口进行设置
*
* @param srcFrame 用于承载 TRTC 采集到的摄像头画面
* @param dstFrame 用于接收第三方美颜处理过的视频画面
* @note 目前仅支持 OpenGL 纹理方案
*
* 【使用相芯】
* 由于相芯的美颜模块会在处理图像的过程中产生一个全新的纹理,因此需要您在回调函数中将 dstFrame.textureId 设置为相芯处理后的新纹理。
* <pre>
* uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVideoFrame * _Nonnull)dstFrame
* {
* uint32_t dstTextureId = renderItemWithTexture(srcFrame.textureId, srcFrame.width, srcFrame.height);
* dstFrame.textureId = dstTextureId;
* return 0;
* }
* </pre>
*
* 【其他方案】
* 如果您使用的第三方美颜模块并不生成新的纹理,而是需要您设置给该模块一个输入纹理和一个输出纹理,则可以考虑如下方案:
* <pre>
* uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVideoFrame * _Nonnull)dstFrame
* {
* thirdparty_process(srcFrame.textureId, srcFrame.width, srcFrame.height, dstFrame.textureId);
* return 0;
* }
* </pre>
*
**/
- (uint32_t)onProcessVideoFrame:(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVideoFrame * _Nonnull)dstFrame;
/**
* SDK 内部的 OpenGL 环境的销毁通知
*/
- (void)onGLContextDestory;
@end
/////////////////////////////////////////////////////////////////////////////////
//
// (十四)音频数据回调
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 声音数据帧的自定义处理回调
*/
@protocol TRTCAudioFrameDelegate <NSObject>
@optional
/**
* 本地麦克风采集到的原始音频数据回调
*
* @param frame 音频数据
* @note - 请不要在此回调函数中做任何耗时操作,建议直接拷贝到另一线程进行处理,否则会导致各种声音问题。
* @note - 此接口回调出的音频数据 **不包含** 背景音、音效、混响等前处理效果,延迟极低。
* - 此接口回调出的音频数据支持修改。
*/
- (void) onCapturedRawAudioFrame:(TRTCAudioFrame *)frame;
/**
* 本地采集并经过音频模块前处理后的音频数据回调
*
* @param frame 音频数据
* @note - 请不要在此回调函数中做任何耗时操作,建议直接拷贝到另一线程进行处理,否则会导致各种声音问题。
* @note - 此接口回调出的音频数据包含背景音、音效、混响等前处理效果,延迟较高。
* @note - 此接口回调出的音频数据支持修改。
* @note - 此接口回调出的音频时间帧长固定为 0.02s。
由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
以SDK默认的音频录制格式 48000 采样率、单声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
*/
- (void) onLocalProcessedAudioFrame:(TRTCAudioFrame *)frame;
/**
* 混音前的每一路远程用户的音频数据,即混音前的各路原始数据。例如,对某一路音频进行文字转换时,您必须使用该路音频的原始数据
*
* @param frame 音频数据
* @param userId 用户标识
* @note - 此接口回调出的音频数据是只读的,不支持修改。
*/
- (void) onRemoteUserAudioFrame:(TRTCAudioFrame *)frame userId:(NSString *)userId;
/**
* 各路音频数据混合后的音频数据
*
* @param frame 音频数据
* @note - 请不要在此回调函数中做任何耗时操作,建议直接拷贝到另一线程进行处理,否则会导致各种声音问题。
* @note - 此接口回调出的音频数据支持修改。
* @note - 此接口回调出的音频时间帧长固定为 0.02s。
由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
以SDK默认的音频播放格式 48000 采样率、双声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 2 × 16bit = 30720bit = 3840字节】。
* @note - 此接口回调出的音频数据是各路音频播放数据的混合,不包含耳返的音频数据。
*/
- (void) onMixedPlayAudioFrame:(TRTCAudioFrame *)frame;
/**
* SDK所有音频数据混合后的数据回调(包括采集音频数据和所有播放音频数据)
*
* @param frame 音频数据
* @note - 此接口回调出的音频数据不支持修改。
* @note - 此接口回调出的音频时间帧长固定为 0.02s。音频格式固定为48000采样率、单声道、16采样点位宽。
由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
因此回调的字节帧长固定为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
* @note - 此接口回调出的是SDK所有音频数据的混合数据,包括:经过特效(包括混响、变声等)处理后的本地麦克风采集数据,
所有远程用户的数据,所有背景音和音效数据。不包括耳返数据。
*/
- (void) onMixedAllAudioFrame:(TRTCAudioFrame *)frame;
@end
/////////////////////////////////////////////////////////////////////////////////
//
// (十五)Log 信息回调
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 日志相关回调
*
* 建议在比较早初始化的类中设置回调委托对象,例如 AppDelegate
*/
@protocol TRTCLogDelegate <NSObject>
/**
* 有日志打印时的回调
*
* @param log 日志内容
* @param level 日志等级,参见 TRTCLogLevel
* @param module 值暂无具体意义,目前为固定值 TXLiteAVSDK
*/
@optional
-(void) onLog:(nullable NSString*)log LogLevel:(TRTCLogLevel)level WhichModule:(nullable NSString*)module;
@end
/// @}
NS_ASSUME_NONNULL_END