• Docs /
• RTC /
• Audio and Video SDK /
• iOS /
• iOS /

CloudHubSDK iOS

• Overview
• CloudHubRtcEngineKit
• CloudHubRtcEngineDelegate
• CloudHubRtcChannelKit
• CloudHubRtcChannelDelegate
• CloudHubEnumerates
• CloudHubObjects

CloudHubRTCEngineDelegate

Unless otherwise specified, the callback methods of delegete run on the main thread

Channel events

rtcEngine:didOccurError:withMessage:

An error occurred callback

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
     didOccurError:(CloudHubErrorCode)errorCode
       withMessage:(NSString * _Nonnull)message;

Details

This callback method indicates that an error occurred inside the SDK

rtcEngine:didJoinChannelwithUid:elapsed:

Occurs when a user joins a channel.

- (void)       rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
   didJoinChannelwithUid:(NSString * _Nonnull)uid
                 elapsed:(NSInteger) elapsed;

Details

This callback method indicates that the client has successfully joined the specified channel, which is the same as the callback of joinSuccessBlock ofjoinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess:

rtcEngine:didReJoinChannelwithUid:elapsed:

Occurs when a user rejoins the channel.

- (void)       rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
 didReJoinChannelwithUid:(NSString * _Nonnull)uid
                 elapsed:(NSInteger) elapsed;

Details

When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.

rtcEngine:didLeaveChannel:

Occurs when a user leaves a channel.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
  didLeaveChannel:(CloudHubChannelStats * _Nonnull)stats;

Details

This callback notifies the app that the user leaves the channel by calling leaveChannel: . From this callback, the app can get information such as the call duration and quality statistics.

rtcEngine:onClientRoleChangedFrom:to:

Occurs when the user role switches in the interactive live streaming.

- (void)      rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onClientRoleChangedFrom:(CloudHubClientRole)oldRole
                     to:(CloudHubClientRole)newRole;

Details

The SDK triggers this callback when the local user switches the user role by calling setClientRole: after joining the channel.

rtcEngine:didJoinedOfUid:properties:isHistory:fromChannel:

Occurs when a remote user (CloudHubChannelProfileCommunication)/ host (CloudHubChannelProfileLiveBroadcasting) joins the channel.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
   didJoinedOfUid:(NSString * _Nonnull)uid
       properties: (NSString * _Nullable)properties
        isHistory: (BOOL)isHistory
      fromChannel:(NSString* _Nonnull)srcChannel;

Details

In a communication channel, this callback indicates that a remote user joins the channel. The SDK also triggers this callback to report the existing users in the channel when a user joins the channel.

In a live-broadcast channel, this callback indicates that a host joins the channel. The SDK also triggers this callback to report the existing hosts in the channel when a host joins the channel. Cloudhub recommends limiting the number of hosts to 17.

The SDK triggers this callback under one of the following circumstances:

• A remote user/host joins the channel by calling the joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess: method
• A remote user switches the user role to the host after joining the channel.
• A remote user/host rejoins the channel after a network interruption.

Note:

• The host can receive the callback of the new host joining the channel, and can obtain the uid of the host
• Viewers can also receive a callback for a new host to join the channel, and can obtain the uid of the host

rtcEngine:didOfflineOfUid:reason:

Occurs when a remote user (CloudHubChannelProfileCommunication)/ host (CloudHubChannelProfileLiveBroadcasting) leaves the channel.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
  didOfflineOfUid:(NSString * _Nonnull)uid
           reason:(NSInteger)reason

Details

It prompts that a remote user/host has left the channel (or dropped). There are two reasons for the user to leave the channel, namely normal leaving and timeout dropped (more than 30 seconds can not communicate with the server normally)

rtcEngine:connectionChangedToState:

Occurs when the network connection state changes.

- (void)       rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
connectionChangedToState:(CloudHubConnectionStateType)state;

Details

When the network connection state changes, the SDK triggers this callback and reports the current connection state and the reason for the change.

rtcEngine:tokenPrivilegeWillExpire:

Occurs when the token expires in 30 seconds.

- (void)       rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
tokenPrivilegeWillExpire:(NSString *_Nonnull)token;

Details

If Token is specified when calling joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess: , because Token has a certain time limit, if Token is about to expire during the call, the SDK will trigger the callback 30 seconds in advance to remind the application to update the Token, When receiving the callback, the user needs to regenerate a new Token on the server, and then call renewToken: to pass the newly generated Token to the SDK

rtcEngineRequestToken:

Occurs when the token expires.

- (void)rtcEngineRequestToken:(CloudHubRtcEngineKit * _Nonnull)engine;

Details

If Token is specified when calling joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess: , since Token has a certain time limit, if the Token has expired during the call, the SDK will immediately trigger the callback to remind the application to update the Token when receiving When this callback is reached, the user needs to regenerate a new Token on the server, and then call renewToken: to pass the newly generated Token to the SDK

rtcEngine:onLocalUserPermissionChanged:permission:

Local user publishing or subscribing permissions have changed

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onLocalUserPermissionChanged:(CloudHubPermissionType)type
                  permission:(BOOL)hasPermission;

Details

You can change the publishing and subscribing permissions of any user in the channel through the backend api. When a user’s publishing and subscribing permissions change, the published audio and video streams will be interrupted immediately, and the local will receive rtcEngine:onLocalUserPermissionChanged:permission: callback If you lose the publishing right, other people in the channel will not be able to receive the audio and video of this user; if you lose the subscription right, this user will not be able to receive the audio and video of other people in the channel

Note:

• After regaining the publishing permission, if you want to publish your own audio and video immediately, you need to call the publishStream method again after receiving the rtcEngine:onLocalUserPermissionChanged:permission: callback
• When the subscription permission is regained, the subscription will continue automatically, and only need to respond to the following rtcEngine:remoteAudioStateChangedOfUid:state:reason: and rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo:

Local media events

rtcEngine:localAudioStateChange:error:

Occurs when the local audio stream state changes.

- (void)    rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
localAudioStateChange:(CloudHubAudioLocalState)state
                error:(CloudHubAudioLocalError)error;

Details

When the state of the local audio stream changes (including the state of the audio capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local audio stream, and allows you to troubleshoot issues when audio exceptions occur.

rtcEngine:localVideoStateChangeWithState:error:

Occurs when the local video stream state changes.

- (void)             rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
localVideoStateChangeWithState:(CloudHubLocalVideoStreamState)state
                         error:(CloudHubLocalVideoStreamError)error;

Details

When the state of the local video stream changes (including the state of the video capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur.

rtcEngineFirstLocalAudioFrame:

已发送本地音频首帧回调

- (void)rtcEngineFirstLocalAudioFrame:(CloudHubRtcEngineKit * _Nonnull)engine;

Remote media events

rtcEngine:remoteAudioStateChangedOfUid:state:reason:

Occurs when the remote audio state changes.

- (void)           rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
remoteAudioStateChangedOfUid:(NSString * _Nonnull)uid
                       state:(CloudHubAudioRemoteState)state
                      reason:(CloudHubAudioRemoteStateReason)reason;

Details

When the audio state of a remote user (in the voice/video call channel) or host (in the live streaming channel) changes, the SDK triggers this callback to report the current state of the remote audio stream.

rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo:

Occurs when the remote video state changes.

- (void)            rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
 remoteVideoStateChangedOfUid:(NSString * _Nonnull)uid
                     streamId:(NSString * _Nonnull)streamId
                         type:(CloudHubMediaType)type
                        state:(CloudHubVideoRemoteState)state
                       reason:(CloudHubVideoRemoteStateReason)reason
                       streamInfo:(NSString * _Nullable)streamInfo;

Details

When the remote user/host video status changes, the SDK will trigger the callback to report the current remote video stream status to the local user

Each user may have multiple video streams, each video has its type (type), streamId is the unique identifier of a video stream in the channel

rtcEngine:firstRemoteAudioFrameOfUid:

Callback of the first frame of received remote audio

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
firstRemoteAudioFrameOfUid:(NSString * _Nonnull)uid;

rtcEngine:firstLocalVideoFrameWithSize:elapsed:

Occurs when the first video frame is published.

- (void)           rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
firstLocalVideoFrameWithSize:(CGSize)size
                     elapsed:(NSInteger)elapsed;

rtcEngine:onLocalVideoSizeChanged:

Callback for local video size change

- (void)      rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onLocalVideoSizeChanged:(CGSize)size;

rtcEngine:firstRemoteVideoFrameOfUID:streamId:type:Size:

Occurs when the first remote video frame is rendered.

- (void)         rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
firstRemoteVideoFrameOfUID:(NSString * _Nonnull)uid
                  streamId:(NSString * _Nonnull)streamId
                      type:(CloudHubMediaType)type
                      Size:(CGSize)size;

Details

After the first video frame from the remote end is received locally and successfully decoded, the callback will be triggered. There are two situations:

• Send video after the remote user goes online for the first time
• The remote user’s video is offline and then goes online to send the video. The video offline means that the local user did not receive the video package within 15 seconds. The possible reasons are as follows:
  • The remote user leaves the channel
  • Remote user dropped
  • The remote user stopped sending the video stream（muteLocalVideoStream: be called ）
  • The remote user turns off the video (enableLocalVideo:NO is called)

rtcEngine:remoteVideoSizeChangedOfUID:streamId:type:size:

The size of the remote video stream has changed callback

- (void)          rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
remoteVideoSizeChangedOfUID:(NSString * _Nonnull)uid
                   streamId:(NSString * _Nonnull)streamId
                       type:(CloudHubMediaType)type
                       size:(CGSize)size;

Statistics events

rtcEngine:remoteAudioStats:

Reports the transport-layer statistics of each remote audio stream.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
 remoteAudioStats:(CloudHubRtcRemoteAudioStats * _Nonnull)stats;

Details

The SDK triggers this callback once every two seconds for each remote user who is sending audio streams. If a channel includes multiple remote users, the SDK triggers this callback as many times.

rtcEngine:onRtcStats:

Reports the statistics of the current call.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
       onRtcStats:(CloudHubChannelStats * _Nonnull)stats;

Details

The SDK triggers this callback once every two seconds after the user joins the channel.

rtcEngine:onNetworkQuality:

Reports the last mile network quality of each user in the channel.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
 onNetworkQuality:(NSString * _Nonnull)uid
        txQuality:(CloudHubNetworkQuality)txQuality
        rxQuality:(CloudHubNetworkQuality)rxQuality;

Details

This callback describes the statistics of sending media streams and receiving remote media streams during a call. The outgoing media stream and each remote user media stream will be called back separately

rtcEngine:localAudioStats:

Reports the statistics of the local audio stream.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
  localAudioStats:(CloudHubRtcLocalAudioStats * _Nonnull)stats;

Details

The SDK triggers this callback once every two seconds.

rtcEngine:localVideoStats:

Reports the statistics of the local video stream.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
  localVideoStats:(CloudHubRtcLocalVideoStats * _Nonnull)stats;

Details

The SDK triggers this callback once every two seconds to report the statistics of the local video stream.

rtcEngine:remoteVideoStats:

Reports the transport-layer statistics of each remote video stream.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
 remoteVideoStats:(CloudHubRtcRemoteVideoStats * _Nonnull)stats;

Details

Reports the statistics of the video stream from the remote users. The SDK triggers this callback once every two seconds for each remote user. If a channel has multiple users/hosts sending video streams, the SDK triggers this callback as many times.

Media files play（Mobile currently only supports mp4, wav, mp3） events

rtcEngine:onLocalMovieStateChanged:state:errorCode:

The local user’s music file playback status changes callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onLocalMovieStateChanged:(NSString * _Nonnull)filepath
                    state:(CloudHubMovieStateCode)state
                errorCode:(CloudHubMovieErrorCode)errorCode;

rtcEngine:onLocalMovieProgress:pos:total:

Local user’s music file playback progress callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onLocalMovieProgress:(NSString * _Nonnull)filepath
                  pos:(NSUInteger)pos
                total:(NSUInteger)total;

rtcEngine:firstLocalMovieVideoFrame:size:

The callback triggered when the first frame of the local video is played

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
firstLocalMovieVideoFrame:(NSString * _Nonnull)filepath
                      size:(CGSize)size;

Audio effect file playbac（Mobile currently only supports wav, mp3）events

rtcEngine:onAudioEffectFinish:

Occurs when the playback of the local audio effect file finishes.

- (void)  rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onAudioEffectFinish:(int)soundId;;

Media stream relay across channels events

rtcEngine:onChannel:MediaRelayStateChanged:error:

The cross-channel media stream forwarding status has changed callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
             onChannel:(NSString* _Nonnull)channelID
MediaRelayStateChanged:(CloudHubMediaRelayState)state
                 error:(CloudHubMediaRelayError)error;

Note: When the cross-channel media stream forwarding status changes, the SDK will trigger the callback and report the current forwarding status and related error information

Volume indication

rtcEngine:reportAudioVolumeIndication:totalVolume:

Reports the volume information of users.

- (void)          rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
reportAudioVolumeIndication:(NSArray * _Nonnull)speakers
                totalVolume:(NSInteger)totalVolume;

​ Details

This callback reports the user IDs of the users (up to 3) with the highest instantaneous volume in the channel, their volume, and whether the local user is talking

This callback is disabled by default and can be enabled by the enableAudioVolumeIndication:smooth:reportVAD: method; when enabled, the SDK will press enableAudioVolumeIndication:smooth:reportVAD: The callback is triggered at the interval set in the method. Each time it is triggered, the user will receive two separate callbacks, one of which contains the local user’s Volume information, the other contains the volume information of all users at the remote end.

rtcEngine:onActiveSpeaker:

Callback of the most active remote user detected

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
   onActiveSpeaker:(NSString * _Nonnull)uid;

Details

After successfully calling enableAudioVolumeIndication:smooth:reportVAD:, the SDK will continue to monitor the remote user with the loudest volume, and count the number of times the user is judged to be the loudest. . In the current time period, the remote user with the most accumulated number of times is the most active user.

When the number of users in the channel is greater than or equal to 2 and there are active users, the SDK will trigger the callback and report the uid of the most active user.

• If the most active user is always the same user, the SDK will not trigger the onActiveSpeaker callback again.
• If the most active user changes, the SDK will trigger the callback again and report the uid of the new most active user.

Stream fallback

rtcEngine:didLocalPublishFallbackToAudioOnly:deviceId:

The local publishing stream has fallen back to audio stream or reverted to audio and video stream callback

- (void)                rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
didLocalPublishFallbackToAudioOnly:(BOOL)isFallbackOrRecover
                         deviceId:(NSString * _Nonnull)deviceId;

rtcEngine:didRemoteSubscribeFallbackToAudioOnly:byUid:type:streamId:

The remote subscription stream has fallen back to an audio stream or reverted to an audio and video stream callback

- (void)                    rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
didRemoteSubscribeFallbackToAudioOnly:(BOOL)isFallbackOrRecover
                                byUid:(NSString * _Nonnull)uid
                                 type:(CloudHubMediaType)type
                             streamId:(NSString * _Nonnull)streamId;

Pre-call network test events

rtcEngine:onLastmileQuality:

Reports the last-mile network quality of the local user once every two seconds.

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onLastmileQuality:(CloudHubNetworkQuality * _Nonnull)quality;

rtcEngine:onLastmileProbeResult:

Reports the last mile network probe result.

- (void)    rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onLastmileProbeResult:(CloudHubLastmileProbeResult * _Nonnull)result;

Raw audio data events

rtcEngine:onRecordAudioFrame:sampleRate:channels:

- (void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onRecordAudioFrame:(NSData * _Nonnull)buffer
        sampleRate:(int)sampelRate
          channels:(int)channels;

Set the format of the collected data callback.

Parameters

rtcEngine:onPlaybackAudioFrame:sampleRate:channels:

- (void)    rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
 onPlaybackAudioFrame:(NSData * _Nonnull)buffer
           sampleRate:(int)sampelRate
             channels:(int)channels;

Set the format of the playback data callback

Parameters

Audio recorder events

rtcEngine:voiceClipFileReady:clip:ts:

Record sound clip callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
voiceClipFileReady:(NSString* _Nonnull)clipBaseName
               clip:(NSString* _Nonnull)currentClipFileName
                 ts:(int64_t)clipTs;

rtcEngine:onVoiceTranslateTextReady:text:

Sound file recognition callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onVoiceTranslateTextReady:(NSString* _Nonnull)wavFileName
                      text:(NSString * _Nonnull)text;

Device manager

rtcEngine:didAudioRouteChanged:

Audio output device change notification

- (void)   rtcEngine:(CloudHubRtcEngineKit *_Nonnull)engine
didAudioRouteChanged:(CloudHubAudioOutputRouting)routing;

Data stream events

rtcEngine:onStreamMessagWithUid:data:

- (void)    rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onStreamMessagWithUid:(NSString * _Nonnull)uid
                 data:(NSData * _Nonnull)data;

The callback of receiving the other party’s data stream message.

This callback indicates that the local user has received the stream message sent by the remote user calling the sendStreamMessage: method.

Parameters

Remote publish event（only when auto subscription mode is turned off）

rtcEngine:onUserPublished:type:stream:

The remote user starts to publish the audio video callback

- (void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
  onUserPublished:(NSString * _Nonnull)uid
             type:(CloudHubMediaType)type
           stream:(NSString * _Nonnull)streamId;

Details

When a user in the channel successfully publishes an audio and video stream, if the local automatic subscription is turned off, the callback will be received. At this time, if you decide to watch this person, you need to call subscribe，after success, receive rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streaminfo: callback. If the local auto subscription is not closed, you will directly receive the rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo: callback

rtcEngine:onUserUnPublished:type:stream:

The remote user stops publishing audio and video callbacks

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onUserUnPublished:(NSString * _Nonnull)uid
              type:(CloudHubMediaType)type
            stream:(NSString * _Nonnull)streamId;

Details

When a user in the channel stops the audio video stream, if the local automatic subscription is turned off, the callback will be received, and there is no need to actively call unSubscribe method

Server recording events

rtcEngine:onServerRecordStateChange:startTS:currTS:pauseDuration:recordDuration:

The local user’s music file playback status changes callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onServerRecordStateChange:(CloudHubRecordingState)state
                   startTS:(NSUInteger)startTS
                    currTS:(NSUInteger)currTS
             pauseDuration:(NSUInteger)pauseDuration
            recordDuration:(NSUInteger)recordDuration;

Advanced signaling event

rtcEngine:onSetPropertyOfUid:from:properties:

User-defined attribute change callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onSetPropertyOfUid:(NSString * _Nonnull)uid
               from:(NSString * _Nullable)fromuid
         properties:(NSString * _Nonnull)prop;

Note:

Only when the local user is within the notification range specified when calling setPropertyOfUid:tell:properties: (if not specified, everyone in the channel will be notified). Will receive the callback

rtcEngine:onChatMessageArrival:from:withExtraData:

Chat message callback

-(void) rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onChatMessageArrival:(NSString * _Nonnull)message
                 from:(NSString * _Nullable)fromuid
        withExtraData:(NSString * _Nullable)extraData;

Note:

Only when the local user is within the notification range specified when calling sendChatMsg:to:withExtraData: (if not specified, everyone in the channel will be notified). Will receive the callback

rtcEngine:onPubMsg:msgId:from:withData:associatedWithUser:associatedWithMsg:ts:withExtraData:isHistory:

Custom message publishing callback

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
         onPubMsg:(NSString * _Nonnull)msgName
            msgId:(NSString * _Nonnull)msgId
             from:(NSString * _Nullable)fromuid
         withData:(NSString * _Nullable)data
associatedWithUser:(NSString * _Nullable)uid
associatedWithMsg:(NSString * _Nullable)assMsgID
               ts:(NSUInteger)ts
    withExtraData:(NSString * _Nullable)extraData
        isHistory:(BOOL)isHistory;

Note:

Only when local users call pubMsg:msgId:to:withData:associatedWithUser:associatedWithMsg:save:extraData: within the specified notification range (notify if not specified Everyone in the channel), local users will receive the callback

rtcEngine:onPubMsg:msgId:from:withData:associatedWithUser:associatedWithMsg:ts:withExtraData:isHistory:seq:

Custom message publishing callback

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
         onPubMsg:(NSString * _Nonnull)msgName
            msgId:(NSString * _Nonnull)msgId
             from:(NSString * _Nullable)fromuid
         withData:(NSString * _Nullable)data
associatedWithUser:(NSString * _Nullable)uid
associatedWithMsg:(NSString * _Nullable)assMsgID
               ts:(NSUInteger)ts
    withExtraData:(NSString * _Nullable)extraData
        isHistory:(BOOL)isHistory
              seq:(NSInteger)seq;

Note:

Only when local users call pubMsg:msgId:to:withData:associatedWithUser:associatedWithMsg:save:extraData: within the specified notification range (notify if not specified Everyone in the channel), local users will receive the callback

rtcEngine:onDelMsg:msgId:from:withData:

Custom message delete callback

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
          onDelMsg:(NSString * _Nonnull)msgName
             msgId:(NSString * _Nonnull)msgId
              from:(NSString * _Nullable)fromuid
          withData:(NSString * _Nullable)data;

Note:

Only when the local user is within the notification range specified when calling delMsg:msgId:to: (not specified means notifying everyone in the channel). Will receive the callback

rtcEngine:onDelMsg:msgId:from:withData:ts:seq:

Custom message delete callback

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
          onDelMsg:(NSString * _Nonnull)msgName
             msgId:(NSString * _Nonnull)msgId
              from:(NSString * _Nullable)fromuid
          withData:(NSString * _Nullable)data
                ts:(NSUInteger)ts
               seq:(NSInteger)seq;

Note:

Only when the local user is within the notification range specified when calling delMsg:msgId:to: (not specified means notifying everyone in the channel). Will receive the callback

rtcEngine:onLocalUserEvicted:

Callback when local user is kicked out of the channel

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onLocalUserEvicted:(NSInteger)reason;

Details

When this callback is received, there may be two reasons:

• When another user called joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess:, the same uid as the local user was used, the server thought Both have the same identity, and the old user is kicked out of the channel. At this time, reason is 0
• A user called the evictUser:reason: interface to kick the local user out of the channel. At this time, reason is the reason value passed in when the other party calls

rtcEngine:onChannelForceClosed:reason:

The channel is closed by the server callback

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
onChannelForceClosed:(NSString * _Nonnull)channelID
           reason:(CloudHubCloseChannelReason)reason;

Details

When the cross-channel media stream forwarding status changes, the SDK will trigger the callback and report the current forwarding status and related error information

rtcEngineOnHistoryDataReady:

Callback after sending historical signaling

-(void)rtcEngineOnHistoryDataReady:(CloudHubRtcEngineKit * _Nonnull**)engine;

Details

When the historical signaling saved by the server is sent, the SDK will trigger the callback

Other event

rtcEngine:onServerTime:

Callback to return server time

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
      onServerTime:(NSUInteger)serverts;

rtcEngine:onDocAddr:serial:

Return the address of the courseware server

-(void)rtcEngine:(CloudHubRtcEngineKit * _Nonnull)engine
         onDocAddr:(NSString * _Nonnull)docaddr
            serial:(NSString * _Nonnull)serial;