• Docs /
• RTC /
• Audio and Video SDK /
• Electron /
• RtcEngine /

CloudHubSDK Electron

• Overview
• RtcEngine
• RtcEngineEvent
• RtcChannel
• RtcChannelEvent
• Enumerate

Channel management

initialize

Initialize the SDK engine.

rtcEngine.initialize ( appId ) ;

Details

Please call the interface method of the RtcEngine class on the main thread.

setChannelProfile

Set the channel scene.

rtcEngine.setChannelProfile ( profile ) ;

Details

RtcEngine will adopt different optimization strategies for different usage scenarios, such as smooth communication scenarios and image quality in live broadcast scenarios.

Note:

• Users in the same channel must use the same channel scene.
• This method must be called before joining the channel, and the channel scene cannot be set after entering the channel.

setClientRole

Set user roles.。

rtcEngine.setClientRole ( role ) ;

Details

Before joining the channel, the user needs to set the audience (default) or anchor role through this method. After joining the channel, the user can switch user roles through this method. If you call this method to switch user roles after joining a channel, after the call is successful, the onClientRoleChanged callback will be triggered locally; the remote side will trigger the onUserLeaved and onUserJoind callbacks.

Note: This method is only applicable to live broadcast scenes.

joinChannel

Join the channel.

rtcEngine.joinChannel ( token,channelId,info,uid ) ;

Details

This method allows users to join a call channel, users in the same channel can talk to each other, and multiple users can join the same channel to chat in groups. Apps that use different App IDs cannot communicate with each other. If the call is already in progress, the user must call leaveChannel to exit the current call before entering the next channel. After joining the channel, the onJoinChannel callback will be triggered locally; after the user in the communication scene and the host in the live broadcast scene join the channel, the remote end will trigger the onUserJoined callback.

Note: The uid cannot be repeated among users in the channel. If it is repeated, when a user with the same uid later enters, it will trigger the previous user to leave the channel automatically. At this time, the previous user will receive the onLocalUserEvicted callback.

leaveChannel

Leave the channel.

rtcEngine.leaveChannel ( ) ;

Details

Leave the channel, that is, hang up or exit the call.

After calling the joinChannel method, you must call leaveChannel to end the call, otherwise the next call cannot be started. You can call this method regardless of whether you are currently in a call. This method will release all resources related to the session. This method is an asynchronous operation and does not really exit the channel when the call returns. After successfully calling this method to leave the channel, the onLeaveChannel callback will be triggered locally; after the user in the communication scenario and the anchor in the live broadcast scenario leave the channel, the remote site will trigger the onUserLeaved callback.

renewToken

Update the token.

rtcEngine.renewToken ( token ) ;

Details

This method is used to update the Token. If the Token mechanism is enabled, the used Token will become invalid after a period of time. When any of the following occurs:

• onRequestToken callback；

• App should obtain the Token again, and then call the API to update the Token, otherwise the SDK will not be able to establish a connection with the server;

on

Bind listening events.

rtcEngine.on ( "onJoinChannel",onJoinChannel ) ;

Note:

You need to listen before the corresponding event is called. For example, when listening for joinChannel callbacks, you must listen for rtcEngine.on (“onJoinChannel”,onJoinChannel) before calling the JoinChannel method so that the callback will return after joining the room.

off

Unbind the listening event.

rtcEngine.off ( "onJoinChannel",onJoinChannel ) ;

offAll

Unbind event All listening events.

rtcEngine.offAll ( "joinchannel" ) ;

Audio management

setAudioQuality

Set the audio quality of the local transmission

int setAudioQuality( quality )

Parametric

return

• 0: Success
• Non 0: failure

adjustRecordingSignalVolume

Adjusts the volume of the signal captured by the microphone, You can call this method either before or after joining a channel.

rtcEngine.adjustRecordingSignalVolume(volume)

Parameters

Returns

• 0: Success.
• < 0: Failure.

adjustPlaybackSignalVolume

Adjusts the playback signal volume of all remote users, You can call this method either before or after joining a channel.

rtcEngine.adjustPlaybackSignalVolume(volume)

Parameters

Returns

• 0: Success.
• < 0: Failure.

adjustUserPlaybackSignalVolume

Adjusts the playback volume of a specified remote user, Call this method after joining a channel. You can call this method as many times as necessary to adjust the playback volume of different remote users, or to repeatedly adjust the playback volume of the same remote user.

rtcEngine.adjustUserPlaybackSignalVolume(uid, volume)

Parameters

Returns

• 0: Success.
• < 0: Failure.

enableLocalAudio

On/off local audio capture.

rtcEngine.enableLocalAudio ( mute ) ;

Details

This method does not affect the reception or playback of remote audio streams, and enableLocalAudio (false) is suitable for user scenarios where only listening but not sending.

muteLocalAudioStream

Turn on/off local audio transmission.

rtcEngine.muteLocalAudioStream ( mute ) ;

Details

This method is used to allow/prohibit sending local audio streams to the network. After the method is successfully called, the remote end will trigger the onRemoteAudioStateChanged callback. The reason is 5 (stop) /6 (send).

Note:

This method does not affect the recording state, and does not disable the microphone.

muteRemoteAudioStream

Receive/stop receiving the specified remote audio stream.

rtcEngine.muteRemoteAudioStream ( uid,mute ) ;

Details

After the method is successfully called, the onRemoteAudioStateChanged callback will be triggered locally, and the reason is 5 (stop) /6 (send)

muteAllRemoteAudioStreams

Receive/stop receiving all remote audio streams.

rtcEngine.muteAllRemoteAudioStreams ( mute ) ;

Details

After the method is successfully called, the onRemoteAudioStateChanged callback will be triggered locally, and the reason is 5 (stop) 6 (send)

Video management

enableVideo

Enable the video module.

rtcEngine.enableVideo ( ) ;

Details

This method is used to enable the video mode. It can be called before joining a channel or during a call. Calling enableVideo () before joining a channel will automatically turn on the video mode

disableVideo

Disable video module

rtcEngine.disableVideo ( ) ;

Details

This method is used to disable the video mode.

setVideoEncoderConfiguration

Set video encoding properties.

rtcEngine.setVideoEncoderConfiguration ( {width:100,height:100...} ) ;

Details

This method sets video encoding parameters. All the parameters set are the maximum values under ideal conditions. When the video engine cannot reach the maximum resolution or frame rate set due to equipment, network environment, etc., it will take the value closest to the maximum. By default, the rotation mode is adaptive. At this time, if the captured video is horizontal (width is greater than height), the output video is also horizontal, if the captured video is vertical, the output video is also vertical; if If the rotation mode is horizontal screen mode, the output video will remain horizontal, and the vertical screen collection data will be cropped; if the rotation mode is vertical screen, the output video will remain vertical screen, and the horizontal screen collection data will be cropped. When recording is turned on, the rotation mode should not be changed after setting.

setVideoMode

Set the display mode of the video.

rtcEngine.setVideoMode ( viewId: string, mode: number ) ;

Details

After playing the video, you can call this method to update the display mode of the video. This method only affects the video images seen by local users, and does not affect the video images published locally.

Note:

This method can be called multiple times during a call.

setLocalVideoMirror

Set the mirroring mode of the local video.

rtcEngine.setLocalVideoMirror ( mirror: boolean, options?: { viewId?: string }) ;

Details

After playing the local video, you can call this method to update the mirror mode of the local video. This method only affects the video images seen by the local users, and does not affect the locally published video images.

Note:

This method can be called multiple times during a call.

setupLocalVideo

Start playing local video.

rtcEngine.setupLocalVideo ( view: Element, options?: { deviceId?: string }) ;

Details

Call this method to start previewing the local video. You need to call enableVideo to start the local camera in advance. When you leave the channel and enter again, you need to call this method again to start previewing the local video again.

Note:

If you want to update the display or mirroring mode of the local video during a call, please use the setVideoMode / setLocalVideoMirror method.

removeLocalVideo

Stop playing local video.

rtcEngine.removeLocalVideo ( view: Element, options?: { deviceId?: string }) ;

setupRemoteVideo

Start playing the remote video.

rtcEngine.setupRemoteVideo ( uid: string, streamId: string, view: Element ) ;

Details

Call this method to start playing the remote video. You need to call enableVideo in advance to enable the video engine.

removeRemoteVideo

Stop playing the remote video.

rtcEngine.removeRemoteVideo ( uid: string, streamId: string ) ;

enableLocalVideo

This method disables or re-enables local video capture and does not affect the reception of remote video.

enableLocalVideo ( enable: boolean, options?: { deviceId?: string }) ;

Details

After calling enableVideo, the local video is enabled by default. You can call enableLocalVideo (false) to turn off local video capture. If you want to turn it back on after turning it off, you can call enableLocalVideo (true).

After successfully disabling or enabling local video capture.

muteLocalVideoStream

Send/stop sending local video stream.

rtcEngine.muteLocalVideoStream ( mute: boolean, options?: { deviceId?: string }) ;

Details

Optional, where deviceId is the camera ID corresponding to the sending/stopping video stream

Note:

When this method is called, the SDK no longer sends the local video stream, but the camera is still working. This method does not affect the acquisition of local video streams and does not disable the camera.

muteRemoteVideoStream

Receive/stop receiving the specified remote user video stream.

rtcEngine.muteRemoteVideoStream(streamId, mute); 

Details

After the method is successfully called, the onRemoteVideoStateChanged callback will be triggered locally, and the reason is 3 (stop) / 4 (send)

muteAllRemoteVideoStreams

Whether to receive/stop receiving all remote user video streams.

rtcEngine.muteAllRemoteVideoStreams ( mute ) ;

Details

After the method is successfully called, the onRemoteVideoStateChanged callback will be triggered locally, and the reason is 3 (stop) / 4 (send)

Video pre-process and post-process

setBeautyEffectOptions

Enable or disable the local beautifying function and set the beautifying effect options.

rtcEngine.setBeautyEffectOptions ( enable, options, deviceId = '' ) ;

setVideoEffectOptions

Turn on or off the advanced beauty function and set the beauty effect option.

rtcEngine.setVideoEffectOptions ( enable, options, deviceId = '' ) ;

Details

A successful call to this method returns a number,

• 0：Success
• < 0：Failure

Multi-channel management

createChannel

Create and get an IChannel object.

You can call this method multiple times to create multiple IChannel objects, and then call the joinChannel method in each IChannel object to join multiple channels at the same time.

After joining multiple channels, you can subscribe to the audio and video streams of each channel simultaneously. However, only one channel can release one sound and video stream at a time.

virtual IChannel* createChannel ( const char * channelId )

Parameters

return

• Method called successfully, returns a pointer to the IChannel object
• Method call fails, returns a NULL pointer
• If channelId is null, the SDK will return ERR_REFUSED.

Details

• There is no default value for this parameter. Be sure to set a value for it.
• Do not set this parameter to null character “”, otherwise SDK will return ERR_REFUSED.

Screen sharing

getScreenDisplaysInfo

Obtain screen information This section describes how to obtain the screen ID and related information of the system (macOS or Windows). You can use the obtained screen ID to share the screen. You don’t have to pay attention to the content of the returned object, just use it for screen sharing.

console.log ( rtcEngine.getScreenDisplaysInfo ( )) ;

getScreenWindowsInfo

Obtain window information This method obtains the ID and related information of a system window (macOS or Windows). Needed to pay attention to the specific content of the returned object, directly using the get into the window ID as startScreenCaptureByDisplayId excludeWindow parameters, Specific reference startScreenCaptureByDisplayId.

console.log ( rtcEngine.getScreenWindowsInfo ( )) ;

startScreenCaptureByDisplayId

Start desktop sharing.

  rtcEngine.startScreenCaptureByDisplayId ( displayId,excludeWindow... ) ;

Returns value

• -1 Description Failed to start desktop sharing
• 0 Desktop sharing succeeds
• 5 Refusing desktop sharing

startScreenCaptureByWindowId

Share the screen through window information

rtcEngine.startScreenCaptureByWindowId ( windowId,excludeWindow... ) ;

Returns value

• -1 Failed to share the screen through window information
• 0 Sharing the screen through window information succeeded. Procedure
• 5 Deny screen sharing through Windows

stopScreenCapture

Stop desktop sharing.

rtcEngine.stopScreenCapture ( ) ;

startSpeakerCaptureWhileSharing

Enable the desktop sound function when sharing a desktop

rtcEngine.startSpeakerCaptureWhileSharing ( ) ;

stopSpeakerCaptureWhileSharing

Disable the desktop sound when sharing a desktop

rtcEngine.stopSpeakerCaptureWhileSharing ( ) ;

Music file playback

startPlayMovie

Start playing a music file.

rtcEngine.startPlayMovie ( ) ;

stopPlayMovie

Stop playing a music file.

rtcEngine.stopPlayMovie ( ) ;

pausePlayMovie

Pause playing a music file.

rtcEngine.pausePlayMovie ( mediafile ) ;

resumePlayMovie

Resume playing a music file.

rtcEngine.resumePlayMovie ( mediafile ) ;

setupLocalMovie

Watch your own music files locally.

rtcEngine.setupLocalMovie ( ) ;

Note:

You need to call this method after calling startPlayMovie to take effect

removeLocalMovie

Cancel watching the music file you played.

rtcEngine.removeLocalMovie ( ) ;

Note:

Calling this method does not affect other people’s viewing

setMoviePosition

Set the current progress of the music

rtcEngine.setMoviePosition ( mediafile,pos ) ;

getMovieCurrentPosition

Get the current playing time of the media

int64_t getMovieCurrentPosition ( const char* mediafile )

Parameters

return

The current playing time of the media

getMovieInfo

Get media attributes

int getMovieInfo ( const char* mediafile,
                 bool& hasAudio,
                 bool& hasVideo )

Parameters

return

• 0: success
• Non-zero: failure

getMovieDuration

Get movie duration.

rtcEngine.getMovieDuration ( mediaFile ) ;

Details

A numeric value will be returned after the method is successfully called

Audio effect playback

getEffectsVolume

Get the volume of the playing sound effect file.

rtcEngine.getEffectsVolume ( ) ;

setEffectsVolume

Set the volume of playing sound effect files.

rtcEngine.setEffectsVolume ( volume ) ;

setVolumeOfEffect

Set the volume of a single sound effect file.

rtcEngine.setVolumeOfEffect ( soundId, volume ) ;

playEffect

Play the specified sound effect file.

This method plays the specified local or online sound effect file. In this method, you can set the number of times the sound effect file is played, the pitch, the spatial position and gain of the sound effect, and whether the remote user can hear the sound effect.

You can call this method multiple times. By passing in the soundID and filePath of different sound effect files, multiple sound effect files can be played at the same time to achieve sound effect superimposition. For the best user experience, we recommend that no more than 3 sound effect files are played at the same time.

After calling this method to play the sound effect, the SDK will trigger the audioEffectFinished callback.

rtcEngine.playEffect ( soundId, filePath, loopcount, gain, publish, startTimeMS, endTimeMS ) ;

stopEffect

Stop playing the specified sound effect file

rtcEngine.stopEffect ( soundId ) ;

stopAllEffects

Stop playing all sound effect files.

rtcEngine.stopAllEffects ( ) ;

preloadEffect

Preload sound effect files.

rtcEngine.preloadEffect ( soundId: number, filePath: string ) : number;

unloadEffect

Release the sound file.

rtcEngine.unloadEffect ( soundId: number ) : number;

pauseEffect

Pause the sound effect file playback.

rtcEngine.pauseEffect ( soundId ) ;

pauseAllEffects

Pause all audio file playback

rtcEngine.pauseAllEffects ( ) ;

resumeEffect

Resume playing the specified sound effect file

rtcEngine.resumeEffect ( soundId ) ;

resumeAllEffects

Resume playing the specified sound effect file.

rtcEngine.resumeAllEffects ( ) ;

Vocal effects

setLocalVoicePitch

Set the local voice tone

rtcEngine.setLocalVoicePitch ( pitch ) ;

Parameters

return

• 0: Success
• Not 0：Failure.

setLocalVoiceEqualization

Example Set local voice and sound balancing

rtcEngine.setLocalVoiceEqualization ( bandFrequency, bandGain )

Parameters

return

• 0: Success
• Not 0：Failure.

setLocalVoiceReverb

Set local sound reverb

rtcEngine.setLocalVoiceReverb ( reverbKey, value ) ;

Parameters

return

• 0: Success
• Not 0：Failure.

setAudioEffectPreset

Set the SDK’s preset voice sounds.

rtcEngine.setAudioEffectPreset ( preset ) : number

Parameters

return

• 0: Success
• Not 0：Failure.

enableDeepLearningDenoise

Enable or disable AI noise reduction mode.

rtcEngine.enableDeepLearningDenoise ( enabled ) ;

Parameters

return

• 0: Success
• Not 0：Failure.

CDN push

addPublishStreamUrl

Increase the bypass push address.

After calling this method, the SDK will trigger the streamPublished callback locally to report the status of adding the bypass push address.

rtcEngine.addPublishStreamUrl ( url ) ;

Note:

This method is only applicable to the host in the live broadcast scene, please call this method after joining the channel.
1. Make sure that the bypass push function is enabled.
2. This method can only add one bypass push address each time. If you need to push multiple streams, you need to call this method multiple times.

removePublishStreamUrl

Delete the bypass streaming address.

After calling this method, the SDK will trigger the streamUnpublished callback locally to report the status of deleting the bypass push address.

rtcEngine.removePublishStreamUrl ( url: string ) ;

Note:

This method is only applicable to anchors in live broadcast scenarios.
1. This method can only delete one bypass ingest address each time. If you need to delete multiple streams, you need to call this method multiple times.
2. The ingest address does not support special characters such as Chinese.

setLiveTranscoding

Set live transcoding

When this method is called to update the Transcoding parameter, the SDK triggers the transcodingUpdated callback.

rtcEngine.setLiveTranscoding ( transcoding: TranscodingConfig ) ;

Cross-channel media circulation (interactive live broadcast only)

startChannelMediaRelay

The method can be used to realize cross-channel communication and other scenarios

rtcEngine.startChannelMediaRelay ( config ) ;

Details

DestChannelInfos if you want to send the stream to multiple target channels, you can add multiple keys to data.destChannelInfos.After a successful call this method, the channel, the SDK will trigger channelMediaRelayStateChanged callback, and report the current across the channel in the callback media flow state. The target channel will receive the onUserJoined callback,

updateChannelMediaRelay

Update channels for media circulation

rtcEngine.updateChannelMediaRelay ( config ) ;

Details

Call this method if you want to send the stream to multiple target channels or exit the current channel after you have successfully started forwarding media streams across channels.

stopChannelMediaRelay

Stop cross-channel media circulation.

rtcEngine.stopChannelMediaRelay ( ) ;

Details

Once stopped, the anchor will exit all target channels.

Volume indication

enableAudioVolumeIndication

Enable to disable speaker volume prompts.

rtcEngine.enableAudioVolumeIndication ( interval ) ;

DualStream

enableDualStreamMode

Enable or disable the dualStream function

rtcEngine.enableDualStreamMode ( isOpen ) ;

setRemoteVideoStreamType

 Sets the type of video stream to subscribe to

rtcEngine.setRemoteVideoStreamType ( uid, streamType ) ;

setRemoteDefaultVideoStreamType

Sets the type of video stream to subscribe to by default

rtcEngine.setRemoteDefaultVideoStreamType ( type ) ;

Network test before calling

startLastmileProbeTest

Check network quality before a call starts

rtcEngine.startLastmileProbeTest ( config: LastmileProbeConfig ) ;

Details

After this method is enabled, the SDK reports the bandwidth, packet loss, network jitter, and round-trip delay of the upstream and downstream networks to the user. The SDK returns the following two callbacks at once:

• lastMileQuality：Return within 2 seconds depending on network conditions. The callback feedback the upstream and downstream network quality by scoring, closer to the subjective feelings of users.
• lastmileProbeResult：Return within 30 seconds depending on network conditions. This callback feeds back the upstream and downstream network quality with objective data and is therefore more objective.

This method is mainly used in the following two scenarios:

• Before joining a channel, users can use this method to judge and predict whether the current uplink network quality is good enough.
• In the live broadcast scenario, when the user role wants to switch from the audience to the master, you can call this method to judge and predict whether the current uplink network quality is good enough.

Note:

This method will consume a certain amount of network traffic and affect the call quality, so we recommend not to use this method and enableLastmileTest together.
1. After calling this method, do not call other methods until you receive the lastMileQuality and lastmileProbeResult callbacks; otherwise, the method may fail to execute due to too many API operations.
2. In live broadcast scenarios, if the local user plays the main channel, do not invoke this method after joining the channel.

stopLastmileProbeTest

Last Mile network quality detection before stopping a call.

rtcEngine.stopLastmileProbeTest ( ) ;

Audio playback device management

setAudioPlaybackDevice

Set the loudspeaker.

rtcEngine.setAudioPlaybackDevice ( deviceId ) ;

getAudioPlaybackDevices

Gets the speaker list.

console.log ( rtcEngine.getAudioPlaybackDevices ( )) ;

getCurrentAudioPlaybackDevice

Gets the current speaker.

console.log ( rtcEngine.getCurrentAudioPlaybackDevice ( ))

setAudioPlaybackDeviceMute

Mute/unmute audio playback device

rtcEngine.setAudioPlaybackDeviceMute( mute )

Parameters

getAudioPlaybackDeviceMute

Get the mute status of the audio playback device

rtcEngine.getAudioPlaybackDeviceMute()

setAudioPlaybackVolume

Set the volume of the audio playback device

rtcEngine.setAudioPlaybackVolume(volume)

Parameters

getAudioPlaybackVolume

Get the volume of the audio playback device

rtcEngine.getAudioPlaybackVolume()

return

• volume 0-255

startAudioPlaybackDeviceTest

The speaker detection starts.

rtcEngine.startAudioPlaybackDeviceTest ( deviceId,filePath,options ) ;

stopAudioPlaybackDeviceTest

Stop speaker detection.

rtcEngine.stopAudioPlaybackDeviceTest ( ) ;

startAudioDeviceLoopbackTest

Starts the audio device loopback test.

This method tests whether the local audio devices are working properly. After calling this method, the microphone captures the local audio and plays it through the speaker.

Note: This method tests the local audio devices and does not report the network conditions.

rtcEngine.startAudioDeviceLoopbackTest ( interval ) ;

Parameters

Returns

• 0: Success.
• 0: Failure.

stopAudioDeviceLoopbackTest

Stops the audio device loopback test.

rtcEngine.stopAudioDeviceLoopbackTest ( ) ;

Returns

• 0: Success.
• 0: Failure.

Audio recording device management

setAudioRecordingDevice

Set up the microphone

rtcEngine.setAudioRecordingDevice ( deviceId ) ;

getAudioRecordingDevices

Get the microphone list.

console.log ( rtcEngine.getAudioRecordingDevices ( )) ;

getCurrentAudioRecordingDevice

Gets the current microphone.

console.log ( rtcEngine.getCurrentAudioRecordingDevice ( ))

setAudioRecordingDeviceMute

Mute unmute recording equipment

rtcEngine.setAudioRecordingDeviceMute(mute)

Parameters

getAudioRecordingDeviceMute

Get the mute status of the recording device

rtcEngine.getAudioRecordingDeviceMute()

return

• true / false

setAudioRecordingVolume

Set the volume of the recording device

rtcEngine.setAudioRecordingVolume(volume)

Parameters

getAudioRecordingVolume

Get the volume of the recording device

rtcEngine.getAudioRecordingVolume()

return

• volume 0-255

startAudioRecordingDeviceTest

Start microphone detection.

rtcEngine.startAudioRecordingDeviceTest ( deviceId,interval ) ;

stopAudioRecordingDeviceTest

Stop the microphone detection.

rtcEngine.stopAudioRecordingDeviceTest ( ) ;

Video device management

enableMultiStream

Enable multiple cameras

rtcEngine.enableMultiStream ( enable: boolean ) ;

setVideoDevice

Set the camera.

rtcEngine.setVideoDevice ( deviceId ) ;

getVideoDevices

Gets the camera list.

console.log ( rtcEngine.getVideoDevices ( )) ;

getCurrentVideoDevice

Gets the current camera.

console.log ( rtcEngine.getCurrentVideoDevice ( )) ;

startVideoDeviceTest

Start camera detection.

rtcEngine.startVideoDeviceTest ( deviceId,view,onCallback ) ;

stopVideoDeviceTest

Stop camera detection.

rtcEngine.stopVideoDeviceTest ( ) ;

Release management

publish

Start to publish local audio and video.

rtcEngine.publish ( options?: { deviceId?: string, streamInfo?: {} }) ;

Details

Publish your own audio and video to the channel for others to watch and listen. After the release is successful, the local will receive the onLocalVideoStateChanged callback. The remote end will receive the onRemoteVideoStateChanged callback

Note:

This method can only be called after joining the channel successfully.

unPublish

Stop publishing local audio and video.

rtcEngine.unPublish ( options?: { deviceId?: string }) ;

Details

Stop publishing your own audio and video. After you stop publishing, you will receive the onLocalVideoStateChanged callback locally. If the remote end will receive the onRemoteVideoStateChanged callback.

Note:

This method can only be called after joining the channel successfully.

Recording methods

startServerRecord

Start recording

rtcEngine.startServerRecord ( ) ;

Details

The onRecordMsg event is returned after the call is successful. For details, see onRecordMsg 事件

stopServerRecord

To stop recording

rtcEngine.stopServerRecord ( ) ;

Details

The onRecordMsg event is returned after the successful call. For details, see onRecordMsg 事件

pauseServerRecord

The stop

rtcEngine.pauseServerRecord ( ) ;

Details

The onRecordMsg event is returned after the call is successful. For details, see onRecordMsg 事件

resumeServerRecord

Restore the recording

rtcEngine.resumeServerRecord ( ) ;

Details

OnRecordMsg event is returned after the call is successful. For details, see onRecordMsg 事件

Advanced signaling method

Note:

These methods must all be called after joining the channel successfully.

setProperty

Sets custom properties for a user in a channel.

rtcEngine.setProperty ( uid,toId,prop ) ;

Details

There are two ways to set custom properties:

• When a user joins a channel, specify properties in the joinchannel;
• After the user enters the channel, calling setProperty, the user receives the onSetProperty callback.

After the setting is successful, both the notified user and the set user will receive the notification. In addition, the new user entering the channel will also get these properties of the user in the onuserjoined callback.

Note：

• If different attributes of the same user are specified multiple times, these attributes will be recorded and sent to the user newly entering the channel through the onuserjoined callback.
• If the same attribute of the same user is specified multiple times, the later set attribute overrides the previously set attribute. For example, repeat the settings for user a twice and pass in {“test”: true} and {“test”: false} respectively. Then user B who newly enters the channel will get the attribute {“test”: false} of user a in the onuserjoined callback about user a.

sendChatMsg

Send a chat message.

rtcEngine.setChatMsg ( toId,message,extraData ) ;

Parameters

Details

You can usually use extraData to pass information about fonts, avatars, and so on. Users within the channel will receive the onChatMsg callback.

pubMsg

Publish a custom message.

rtcEngine.pubMsg ( msgName,msgId... ) ;

Details

The pubMsg mechanism is similar to a message board and is used to save and synchronize the business status within the channel. Both users already in the channel and new users can receive custom messages already published in the current channel through the pubMsg callback.

Note：

The message will only be saved in recorded playback if toId is ’__all‘ or ‘allExceptSender ' and save is true

delMsg

Example Delete a custom message.

rtcEngine.delMsg ( msgName,msgId... ) ;

Details

After the call is successful, users already in the channel will receive the onDelMsg message.

Note：

Deleting a message that does not exist fails.

evictUser

Kick a user out of the channel.

rtcEngine.evictUser ( uid,reason ) ;

Details

After a successful call, the kicked user receives the onLocalUserEvicted callback. Other users will receive the onUserLeaved callback.

Other methods

getVersion

Obtain the SDK version number.

rtcEngine.getVersion ( ) ;