NERtc iOS SDK  V4.6.0
NERtcEngineDelegate.h
浏览该文件的文档.
1 /*
2  * Copyright (c) 2021 NetEase, Inc. All rights reserved.
3  */
4 
5 #import <Foundation/Foundation.h>
7 #import "NERtcEngineEnum.h"
8 #import "NERtcEngineBase.h"
9 #import <CoreVideo/CoreVideo.h>
10 
11 NS_ASSUME_NONNULL_BEGIN
12 
21 @protocol NERtcEngineDelegate <NSObject>
22 
23 @optional
24 
39 - (void)onNERtcEngineDidError:(NERtcError)errCode;
40 
59 - (void)onNERtcEngineDidWarning:(NERtcWarning)warnCode msg:(NSString *)msg;
60 
75 - (void)onNERtcEngineConnectionStateChangeWithState:(NERtcConnectionStateType)state
76  reason:(NERtcReasonConnectionChangedType)reason;
77 
91 - (void)onNERtcEngineDidLeaveChannelWithResult:(NERtcError)result;
92 
109 - (void)onNERtcEngineDidDisconnectWithReason:(NERtcError)reason;
110 
123  - (void)onNERtcEngineRejoinChannel:(NERtcError)result;
124 
151  - (void)onNERtcEngineUserDidJoinWithUserID:(uint64_t)userID userName:(NSString *)userName;
152 
176 - (void)onNERtcEngineUserDidLeaveWithUserID:(uint64_t)userID reason:(NERtcSessionLeaveReason)reason;
177 
199 - (void)onNERtcEngineDidClientRoleChanged:(NERtcClientRole)oldRole newRole:(NERtcClientRole)newRole;
200 
212 
224 - (void)onNERtcEngineUserAudioDidStart:(uint64_t)userID;
225 
237 - (void)onNERtcEngineUserAudioDidStop:(uint64_t)userID;
238 
254 - (void)onNERtcEngineUserVideoDidStartWithUserID:(uint64_t)userID videoProfile:(NERtcVideoProfileType)profile;
255 
269 - (void)onNERtcEngineUserVideoDidStop:(uint64_t)userID;
270 
285 - (void)onNERtcEngineUserSubStreamDidStartWithUserID:(uint64_t)userID subStreamProfile:(NERtcVideoProfileType)profile;
286 
299 - (void)onNERtcEngineUserSubStreamDidStop:(uint64_t)userID;
300 
313 - (void)onNERtcEngineMediaRightChangeWithAudio:(BOOL)isAudioBannedByServer
314  video:(BOOL)isVideoBannedByServer;
315 
316 @end
317 
328 @protocol NERtcEngineLiveStreamObserver <NSObject>
329 
330 @optional
345 - (void)onNERTCEngineLiveStreamState:(NERtcLiveStreamStateCode)state taskID:(NSString *)taskID url:(NSString *)url;
346 
347 @end
348 
360 @protocol NERtcEngineVideoFrameObserver <NSObject>
361 
362 @optional
363 
380 - (void)onNERtcEngineVideoFrameCaptured:(CVPixelBufferRef)bufferRef rotation:(NERtcVideoRotationType)rotation;
381 
382 @end
383 
393 
394 @optional
395 //
396 //- (void)onNERtcEngineAudioDeviceInterruptionBegan;
397 //
398 //- (void)onNERtcEngineAudioDeviceInterruptionEnded;
399 
410 - (void)onNERtcEngineAudioDeviceRoutingDidChange:(NERtcAudioOutputRouting)routing;
411 
412 @end
413 
422 @protocol NERtcEngineVideoRenderSink <NSObject>
423 
424 @optional
437 - (void)onNERtcEngineRenderFrame:(NERtcVideoFrame *_Nonnull)frame;
438 
439 @end
450 @protocol NERtcEngineVideoSEIObserver <NSObject>
451 
452 @optional
453 
470 - (void)onNERtcEngineRecvSEIMsg:(uint64_t)userID message:(NSData *)message;
471 
472 @end
473 
483 
484 @optional
485 
500 - (void)onNERtcEngineUserVideoProfileDidUpdate:(uint64_t)userID maxProfile:(NERtcVideoProfileType)maxProfile;
501 
519 - (void)onNERtcEngineUser:(uint64_t)userID videoMuted:(BOOL)muted;
520 
534 - (void)onNERtcEngineUser:(uint64_t)userID audioMuted:(BOOL)muted;
535 
550 - (void)onNERtcEngineFirstVideoDataDidReceiveWithUserID:(uint64_t)userID;
551 
562 - (void)onNERtcEngineFirstAudioDataDidReceiveWithUserID:(uint64_t)userID;
563 
574 - (void)onEngineFirstAudioFrameDecoded:(uint64_t)userID;
575 
594 - (void)onEngineFirstVideoFrameDecoded:(uint64_t)userID width:(uint32_t)width height:(uint32_t)height;
595 
610 - (void)onNERtcEngineAudioDeviceStateChangeWithDeviceID:(NSString *)deviceID deviceType:(NERtcAudioDeviceType)deviceType deviceState:(NERtcAudioDeviceState)deviceState;
611 
630 - (void)onNERtcEngineVideoDeviceStateChangeWithDeviceID:(NSString *)deviceID deviceType:(NERtcVideoDeviceType)deviceType deviceState:(NERtcVideoDeviceState)deviceState;
631 
644 - (void)onNERtcEngineNetworkConnectionTypeChanged:(NERtcNetworkConnectionType)newConnectionType;
645 
667 - (void)onAudioMixingStateChanged:(NERtcAudioMixingState)state errorCode:(NERtcAudioMixingErrorCode)errorCode;
668 
681 - (void)onAudioMixingTimestampUpdate:(uint64_t)timeStampMS;
682 
683 
695 - (void)onAudioEffectFinished:(uint32_t)effectId;
696 
697 
716 - (void)onLocalAudioVolumeIndication:(int)volume;
717 
718 
741 -(void)onRemoteAudioVolumeIndication:(nullable NSArray<NERtcAudioVolumeInfo*> *)speakers totalVolume:(int)totalVolume;
742 
757 - (void)onNERtcEngineHardwareResourceReleased:(NERtcError)result;
758 
775 - (void)onNERtcCameraFocusChanged:(CGPoint)focusPoint;
776 
791 - (void)onNERtcCameraExposureChanged:(CGPoint)exposurePoint;
792 
793 
794 
808 
821 - (void)onNERtcEngineChannelMediaRelayStateDidChange:(NERtcChannelMediaRelayState)state channelName:(NSString *)channelName;
822 
837 - (void)onNERtcEngineDidReceiveChannelMediaRelayEvent:(NERtcChannelMediaRelayEvent)event channelName:(NSString *)channelName error:(NERtcError)error;
838 
852 - (void)onNERtcEngineAudioRecording:(NERtcAudioRecordingCode)code filePath:(NSString *)filePath;
853 
854 
875 - (void)onNERtcEngineLocalPublishFallbackToAudioOnly:(BOOL)isFallback streamType:(NERtcStreamChannelType)streamType;
876 
900 - (void)onNERtcEngineRemoteSubscribeFallbackToAudioOnly:(uint64_t)uid isFallback:(BOOL)isFallback streamType:(NERtcStreamChannelType)streamType;
901 
917 - (void)onNERtcEngineLastmileQuality:(NERtcNetworkQuality)quality;
918 
935 - (void)onNERtcEngineLastmileProbeTestResult:(NERtcLastmileProbeResult *)result;
936 
937 
938 
939 @end
940 
951 @protocol NERtcEngineAudioFrameObserver <NSObject>
952 
953 @optional
954 
973 - (void)onNERtcEngineAudioFrameDidRecord:(NERtcAudioFrame *)frame;
974 
975 
994 - (void)onNERtcEngineAudioFrameWillPlayback:(NERtcAudioFrame *)frame;
995 
1018 - (void)onNERtcEnginePlaybackAudioFrameBeforeMixingWithUserID:(uint64_t)userID frame:(NERtcAudioFrame *)frame;
1019 
1044 - (void)onNERtcEnginePlaybackAudioFrameBeforeMixingWithUserID:(uint64_t)userID frame:(NERtcAudioFrame *)frame channelId:(uint64_t)channelId;
1045 
1066 - (void)onNERtcEngineMixedAudioFrame:(NERtcAudioFrame *)frame;
1067 
1068 @end
1069 
1070 NS_ASSUME_NONNULL_END
NERtcAudioMixingErrorCode
伴音错误码。
Definition: NERtcEngineEnum.h:1889
NERtcAudioDeviceState
音频设备状态。
Definition: NERtcEngineEnum.h:2415
NERtcChannelMediaRelayEvent
媒体流转发回调事件
Definition: NERtcEngineEnum.h:2631
NERtcChannelMediaRelayState
媒体流转发状态
Definition: NERtcEngineEnum.h:2584
NERtcAudioDeviceType
音频设备类型。
Definition: NERtcEngineEnum.h:2347
NERtcAudioOutputRouting
音频路由。
Definition: NERtcEngineEnum.h:1044
NERtcAudioMixingState
伴音任务状态。
Definition: NERtcEngineEnum.h:1860
NERtcSessionLeaveReason
用户离开房间的原因。
Definition: NERtcEngineEnum.h:107
NERtcConnectionStateType
当前房间的连接状态。
Definition: NERtcEngineEnum.h:31
NERtcVideoProfileType
视频 profile 类型。
Definition: NERtcEngineEnum.h:361
NERtcNetworkConnectionType
网络连接的类型。
Definition: NERtcEngineEnum.h:2046
NERtcAudioRecordingCode
录音回调状态码。
Definition: NERtcEngineEnum.h:1422
NERtcNetworkQuality
网络质量类型。
Definition: NERtcEngineEnum.h:2510
NERtcVideoDeviceState
视频设备状态无限制,SDK 可以完全控制 Audio Session。
Definition: NERtcEngineEnum.h:2462
NERtcClientRole
用户角色。
Definition: NERtcEngineEnum.h:163
NERtcStreamChannelType
SEI发送的流通道类型。
Definition: NERtcEngineEnum.h:1013
NERtcLiveStreamStateCode
直播推流状态。
Definition: NERtcEngineEnum.h:2256
NERtcReasonConnectionChangedType
当前engine连接状态变更的原因。
Definition: NERtcEngineEnum.h:192
NERtcVideoDeviceType
视频设备类型。
Definition: NERtcEngineEnum.h:2385
NERtcVideoRotationType
视频数据的旋转方向
Definition: NERtcEngineEnum.h:928
NERtcError
Engine Error Code。
Definition: NERtcEngineErrorCode.h:17
NERtcWarning
Definition: NERtcEngineErrorCode.h:556
音频帧。
Definition: NERtcEngineBase.h:1376
声音音量信息。
Definition: NERtcEngineBase.h:1411
上下行 Last mile 网络质量探测结果。
Definition: NERtcEngineBase.h:2124
视频帧信息。
Definition: NERtcEngineBase.h:1445
音频数据回调 如果需要对音频数据做处理,需要实现这个 protocol
Definition: NERtcEngineDelegate.h:951
音频会话回调
Definition: NERtcEngineDelegate.h:392
NERtcEngine 常用回调
Definition: NERtcEngineDelegate.h:21
void onNERtcEngineReconnectingStart()
重连开始回调。 客户端和服务器断开连接时,SDK 会进行重连,重连开始时触发此回调。重连结果请参考 onNERtcEngineRejoinChannel 、onNERtcEngineDidDisconn...
NERtcEngine 扩展回调。
Definition: NERtcEngineDelegate.h:482
void onNERtcEngineAudioHasHowling()
检测到啸叫回调。 当声源与扩音设备之间因距离过近时,可能会产生啸叫。NERTC SDK 支持啸叫检测,当检测到有啸叫信号产生的时候,自动触发该回调直至啸叫停止。App 应用层可以在收到啸叫回调时,提示用...
直播推流状态回调 如果需要监听直播推流状态,需要实现这个 protocol
Definition: NERtcEngineDelegate.h:328
本地视频数据采集回调 如果需要对采集数据做美颜等处理,需要实现这个 protocol。
Definition: NERtcEngineDelegate.h:360
外部视频渲染。
Definition: NERtcEngineDelegate.h:422
注册 SEI 观测者。 注册观测者并拉流成功后,当远端流发送 SEI,本端会收到 onNERtcEngineRecvSEIMsg 回调。
Definition: NERtcEngineDelegate.h:450