NERtcEngineDelegate.h

浏览该文件的文档.

/*
 * Copyright (c) 2021 NetEase, Inc. All rights reserved.
 */
 
#import <Foundation/Foundation.h>
#import "NERtcEngineErrorCode.h"
#import "NERtcEngineEnum.h"
#import "NERtcEngineBase.h"
#import <CoreVideo/CoreVideo.h>
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
 
 
NS_ASSUME_NONNULL_BEGIN
 
@protocol NERtcEngineDelegate <NSObject>
 
@optional
 
- (void)onNERtcEngineDidError:(NERtcError)errCode;
 
- (void)onNERtcEngineDidWarning:(NERtcWarning)warnCode msg:(NSString *)msg;
 
- (void)onNERtcEngineApiDidExecuted:(NSString *)apiName errCode:(NERtcError)errCode msg:(NSString *)msg;
 
- (void)onNERtcEngineConnectionStateChangeWithState:(NERtcConnectionStateType)state
                                             reason:(NERtcReasonConnectionChangedType)reason;
 
- (void)onNERtcEngineDidLeaveChannelWithResult:(NERtcError)result;
 
- (void)onNERtcEngineDidDisconnectWithReason:(NERtcError)reason;
 
  - (void)onNERtcEngineRejoinChannel:(NERtcError)result;
 
  - (void)onNERtcEngineUserDidJoinWithUserID:(uint64_t)userID userName:(NSString *)userName;
 
- (void)onNERtcEngineUserDidJoinWithUserID:(uint64_t)userID userName:(NSString *)userName joinExtraInfo:(nullable NERtcUserJoinExtraInfo *)joinExtraInfo;
 
 
- (void)onNERtcEngineUserDidLeaveWithUserID:(uint64_t)userID reason:(NERtcSessionLeaveReason)reason;
 
- (void)onNERtcEngineUserDidLeaveWithUserID:(uint64_t)userID reason:(NERtcSessionLeaveReason)reason  leaveExtraInfo:(nullable NERtcUserLeaveExtraInfo *)leaveExtraInfo;
 
- (void)onNERtcEngineDidClientRoleChanged:(NERtcClientRole)oldRole newRole:(NERtcClientRole)newRole;
 
- (void)onNERtcEngineReconnectingStart;
 
- (void)onNERtcEngineUserAudioDidStart:(uint64_t)userID;
 
- (void)onNERtcEngineUserAudioDidStop:(uint64_t)userID;
 
- (void)onNERtcEngineUserVideoDidStartWithUserID:(uint64_t)userID videoProfile:(NERtcVideoProfileType)profile;
 
- (void)onNERtcEngineUserVideoDidStop:(uint64_t)userID;
 
- (void)onNERtcEngineUserSubStreamDidStartWithUserID:(uint64_t)userID subStreamProfile:(NERtcVideoProfileType)profile;
 
- (void)onNERtcEngineUserVideoStreamDidStart:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType streamProfile:(NERtcVideoProfileType)profile;
 
- (void)onNERtcEngineUserSubStreamDidStop:(uint64_t)userID;
 
- (void)onNERtcEngineUserVideoStreamDidStop:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType;
 
- (void)onNERtcEngineMediaRightChangeWithAudio:(BOOL)isAudioBannedByServer
                                         video:(BOOL)isVideoBannedByServer;
 
- (void)onNERtcEngineUserSubStreamAudioDidStart:(uint64_t)userID;
 
- (void)onNERtcEngineUserSubStreamAudioDidStop:(uint64_t)userID;
 
- (void)onNERtcEngineUser:(uint64_t)userID subStreamAudioMuted:(BOOL)muted;
 
@end
 
@protocol NERtcEngineLiveStreamObserver <NSObject>
 
@optional
- (void)onNERTCEngineLiveStreamState:(NERtcLiveStreamStateCode)state taskID:(NSString *)taskID url:(NSString *)url;
 
@end
 
@protocol NERtcEngineVideoFrameObserver <NSObject>
 
@optional
 
- (void)onNERtcEngineVideoFrameCaptured:(CVPixelBufferRef)bufferRef rotation:(NERtcVideoRotationType)rotation;
 
- (void)onNERtcEngineRemoteVideoFrame:(NERtcStreamChannelType)videoStreamType
                               userId:(uid_t)userId
                                 data:(void *)data
                               format:(NERtcVideoFormatType)format
                                width:(uint32_t)width
                               height:(uint32_t)height
                           planeCount:(uint32_t)planeCount
                               offset:(int64_t *)offset
                               stride:(uint32_t *)stride
                             rotation:(NERtcVideoRotationType)rotation;
 
- (void)onNERtcEnginePlayStreamingVideoFrame:(void *)data
                               format:(NERtcVideoFormatType)format
                                width:(uint32_t)width
                               height:(uint32_t)height
                           planeCount:(uint32_t)planeCount
                               offset:(int64_t *)offset
                               stride:(uint32_t *)stride
                             rotation:(NERtcVideoRotationType)rotation
                             streamId:(NSString *)streamId;
 
@end
 
@protocol NERtcEngineAudioSessionObserver <NSObject>
 
@optional
//
//- (void)onNERtcEngineAudioDeviceInterruptionBegan;
//
//- (void)onNERtcEngineAudioDeviceInterruptionEnded;
 
- (void)onNERtcEngineAudioDeviceRoutingDidChange:(NERtcAudioOutputRouting)routing;
 
@end
 
@protocol NERtcEngineVideoRenderSink <NSObject>
 
@optional
- (void)onNERtcEngineRenderFrame:(NERtcVideoFrame *_Nonnull)frame;
 
// 渲染所需的 buffer 类型，默认为 NERtcVideoBufferTypeRawData
- (NERtcVideoBufferType)getFrameBufferType;
 
@end
@protocol NERtcEngineVideoSEIObserver <NSObject>
 
@optional
 
- (void)onNERtcEngineRecvSEIMsg:(uint64_t)userID message:(NSData *)message;
 
@end
 
@protocol NERtcEnginePreDecodeObserver <NSObject>
 @optional
- (void)onNERtcEnginePreDecoderFrame:(NERtcPreDecoderFrameInfo *)preDecoderFrame;
 
@end
 
@protocol NERtcEngineVideoEncoderQosObserver <NSObject>
 
 @optional
 
- (void)onNERtcEngineRequestSendKeyFrame:(NERtcStreamChannelType)videoStreamType;
 
- (void)onNERtcEngineBitrateUpdated:(int)bitrateBps
                    videoStreamType:(NERtcStreamChannelType)videoStreamType;
 
- (void)onNERtcEngineVideoCodecUpdated:(NERtcVideoCodecType)videoCodecType
                       videoStreamType:(NERtcStreamChannelType)videoStreamType;
 
@end
 
@protocol NERtcEnginePushStreamingObserver <NSObject>
 @optional
- (void)onNERtcEngineStartPushStreamingWithResult:(NERtcError)result channelId:(uint64_t)channelId;
- (void)onNERtcEngineStopPushStreaming:(NERtcError)result;
 
- (void)onNERtcEnginePushStreamingChangeToReconnectingWithReason:(NERtcError)reason;
 
- (void)onNERtcEnginePushStreamingReconnectedSuccess;
 
@end
 
 
@protocol NERtcEnginePlayStreamingObserver <NSObject>
 @optional
 
- (void)onNERtcEnginePlayStreamingStateChange:(NSString*)streamId state:(NERtcLivePlayStreamState)state error:(NERtcError)error;
 
- (void)onNERtcEnginePlayStreamingReceiveSeiMessage:(NSString*)streamId message:(NSString*)message;
 
- (void)onNERtcEnginePlayStreamingFirstVideoFrameRender:(NSString*)streamId timeMs:(int64_t)time_ms width:(uint32_t)width height:(uint32_t)height;
 
- (void)onNERtcEnginePlayStreamingFirstAudioFramePlayed:(NSString*)streamId timeMs:(int64_t)time_ms;
 
@end
@protocol NERtcEngineDelegateEx <NERtcEngineDelegate,
NERtcEngineVideoFrameObserver, // deprecated, USE setVideoFrameObserver:(id<NERtcEngineVideoFrameObserver>)videoframeObserver instead
NERtcEngineAudioSessionObserver,
NERtcEngineLiveStreamObserver,
NERtcEngineVideoSEIObserver,
NERtcEnginePushStreamingObserver,
NERtcEnginePlayStreamingObserver>
 
@optional
 
- (void)onNERtcEngineUserVideoProfileDidUpdate:(uint64_t)userID maxProfile:(NERtcVideoProfileType)maxProfile;
 
- (void)onNERtcEngineUser:(uint64_t)userID videoMuted:(BOOL)muted;
 
- (void)onNERtcEngineUser:(uint64_t)userID videoMuted:(BOOL)muted streamType:(NERtcStreamChannelType)streamType;
 
- (void)onNERtcEngineUser:(uint64_t)userID audioMuted:(BOOL)muted;
 
- (void)onNERtcEngineFirstVideoDataDidReceiveWithUserID:(uint64_t)userID;
 
- (void)onNERtcEngineFirstVideoDataDidReceiveWithUserID:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType;
 
- (void)onNERtcEngineRemoteVideoSizeDidChangedWithUserID:(uint64_t)userID width:(uint32_t)width height:(uint32_t)height streamType:(NERtcStreamChannelType)streamType;
 
- (void)onNERtcEngineLocalVideoRenderSizeChanged:(NERtcStreamChannelType)streamType width:(uint32_t)width height:(uint32_t)height;
 
- (void)onNERtcEngineFirstAudioDataDidReceiveWithUserID:(uint64_t)userID;
 
- (void)onEngineFirstAudioFrameDecoded:(uint64_t)userID;
- (void)onNERtcEngineLocalFirstAudioPacketSent:(NERtcAudioStreamType)streamType;
- (void)onEngineFirstVideoFrameDecoded:(uint64_t)userID width:(uint32_t)width height:(uint32_t)height;
 
- (void)onEngineFirstVideoFrameDecoded:(uint64_t)userID width:(uint32_t)width height:(uint32_t)height streamType:(NERtcStreamChannelType)streamType;
 
- (void)onEngineFirstVideoFrameRender:(uint64_t)userID width:(uint32_t)width height:(uint32_t)height elapsed:(uint64_t)elapsed streamType:(NERtcStreamChannelType)streamType;
 
- (void)onNERtcEngineAudioDeviceStateChangeWithDeviceID:(NSString *)deviceID deviceType:(NERtcAudioDeviceType)deviceType deviceState:(NERtcAudioDeviceState)deviceState;
 
- (void)onNERtcEngineVideoDeviceStateChangeWithDeviceID:(NSString *)deviceID deviceType:(NERtcVideoDeviceType)deviceType deviceState:(NERtcVideoDeviceState)deviceState;
 
- (void)onNERtcEngineNetworkConnectionTypeChanged:(NERtcNetworkConnectionType)newConnectionType;
 
- (void)onAudioMixingStateChanged:(NERtcAudioMixingState)state errorCode:(NERtcAudioMixingErrorCode)errorCode;
 
- (void)onAudioMixingTimestampUpdate:(uint64_t)timeStampMS;
 
 
- (void)onAudioEffectFinished:(uint32_t)effectId;
 
- (void)onAudioEffectTimestampUpdateWithId:(uint32_t)effectId timeStampMS:(uint64_t)timeStampMS;
 
- (void)onLocalAudioVolumeIndication:(int)volume;
 
- (void)onLocalAudioVolumeIndication:(int)volume withVad:(BOOL)enableVad;
 
 
-(void)onRemoteAudioVolumeIndication:(nullable NSArray<NERtcAudioVolumeInfo*> *)speakers totalVolume:(int)totalVolume;
 
- (void)onNERtcEngineHardwareResourceReleased:(NERtcError)result;
 
- (void)onNERtcCameraFocusChanged:(CGPoint)focusPoint;
 
- (void)onNERtcCameraExposureChanged:(CGPoint)exposurePoint;
 
 
 
- (void)onNERtcEngineAudioHasHowling;
 
- (void)onNERtcEngineAudioHasHowling:(BOOL)flag;
 
- (void)onNERtcEngineChannelMediaRelayStateDidChange:(NERtcChannelMediaRelayState)state channelName:(NSString *)channelName;
 
- (void)onNERtcEngineDidReceiveChannelMediaRelayEvent:(NERtcChannelMediaRelayEvent)event channelName:(NSString *)channelName error:(NERtcError)error;
 
- (void)onNERtcEngineAudioRecording:(NERtcAudioRecordingCode)code filePath:(NSString *)filePath;
 
 
- (void)onNERtcEngineLocalPublishFallbackToAudioOnly:(BOOL)isFallback streamType:(NERtcStreamChannelType)streamType;
 
- (void)onNERtcEngineRemoteSubscribeFallbackToAudioOnly:(uint64_t)uid isFallback:(BOOL)isFallback streamType:(NERtcStreamChannelType)streamType;
 
- (void)onNERtcEngineLastmileQuality:(NERtcNetworkQuality)quality;
 
- (void)onNERtcEngineLastmileProbeTestResult:(NERtcLastmileProbeResult *)result;
 
- (void)onNERtcEngineVirtualBackgroundSourceEnabled:(BOOL)enabled reason:(NERtcVirtualBackgroundSourceStateReason)reason;
 
- (void)onNERtcEngineLocalVideoWatermarkStateWithStreamType:(NERtcStreamChannelType)type
                                                      state:(NERtcLocalVideoWatermarkState)state;
- (void)onNERtcEnginePermissionKeyWillExpire;
 
- (void)onNERtcEngineUpdatePermissionKey:(NSString *)key error:(NERtcError)error timeout:(NSUInteger)timeout;
 
- (void)onNERtcEngineUserDataDidStart:(uint64_t)userID;
 
- (void)onNERtcEngineUserDataDidStop:(uint64_t)userID;
 
- (void)onNERtcEngineUserDataReceiveMessage:(uint64_t)userID data:(NSData *)data;
 
- (void)onNERtcEngineUserDataStateChanged:(uint64_t)userID;
 
- (void)onNERtcEngineUserDataBufferedAmountChanged:(uint64_t)userID previousAmount:(uint64_t)previousAmount;
 
- (void)onNERtcEngineLabFeatureDidCallbackWithKey:(NSString*)key param:(id)param;
 
- (void)onNERtcEngineAiDataWithType:(NSString*)type data:(NSString*)data;
 
- (void)onNERtcEngineAsrCaptionStateChanged:(NERtcAsrCaptionState)state code:(int)code message:(NSString *)message;
 
- (void)onNERtcEngineAsrCaptionResult:(nullable NSArray<NERtcAsrCaptionResult*> *)results;
 
@end
 
@protocol NERtcEngineAudioFrameObserver <NSObject>
 
@optional
 
- (void)onNERtcEngineAudioFrameDidRecord:(NERtcAudioFrame *)frame;
 
 
- (void)onNERtcEngineAudioFrameWillPlayback:(NERtcAudioFrame *)frame;
 
- (void)onNERtcEnginePlaybackAudioFrameBeforeMixingWithUserID:(uint64_t)userID frame:(NERtcAudioFrame *)frame;
 
- (void)onNERtcEnginePlaybackAudioFrameBeforeMixingForPlayStreaming:(NSString*)playStreamId frame:(NERtcAudioFrame *)frame;
 
- (void)onNERtcEnginePlaybackAudioFrameBeforeMixingWithUserID:(uint64_t)userID frame:(NERtcAudioFrame *)frame channelId:(uint64_t)channelId;
 
- (void)onNERtcEngineMixedAudioFrame:(NERtcAudioFrame *)frame;
 
 
- (void)onNERtcEngineSubStreamAudioFrameDidRecord:(NERtcAudioFrame *)frame;
 
- (void)onNERtcEnginePlaybackSubStreamAudioFrameBeforeMixingWithUserID:(uint64_t)userID frame:(NERtcAudioFrame *)frame channelId:(uint64_t)channelId;
 
 
@end
 
@protocol NERtcEnginePacketObserver <NSObject>
 
 @optional
- (BOOL)onSendAudioPacket:(NERtcPacket *)packet;
- (BOOL)onSendVideoPacket:(NERtcPacket *)packet;
- (BOOL)onReceiveAudioPacket:(NERtcPacket *)packet;
- (BOOL)onReceiveVideoPacket:(NERtcPacket *)packet;
 
@end
 
NS_ASSUME_NONNULL_END
 
#pragma clang diagnostic pop