CloudHubRTS Electron

Overview

Interface class definition

RtsEngine Push-pull streamer management
RtsUpStream Contains the main Method of the pusher
RtsUpStreamEventHandler Used for pusher callback notification
RtsDownStream The main Method of including the puller
RtsDownStreamEventHandler Used for puller callback notification
RtsMixingUpstream Contains the main Method of the Mixing Upstream
RtsMixingUpstreamEventHandler Used for the Mixing Upstream callback notification
RtsServerStreamMixing Contains the main Method of the Server Stream Mixing
RtsServerStreamMixingEventHandler Used for the Server Stream Mixing callback notification
RtsDevicesManager Equipment management

Push-pull streamer management

Method	Description
RtsUpStream	Initialize push
RtsDownStream	Initial pull
RtsMixingUpstream	Initialize Client Mixing Upstream
RtsServerStreamMixing	Initialize Server Stream Mixing

Pusher management

Push streaming Method

Method	Description
getVersion	Get the version
getStreamID	Get a stream id
getClientId	Get user id
startPush	Start streaming
stopPush	Stop streaming
isPushing	Is it pushing?
setVideoQuality	Set push video quality
startCamera	Start camera capture
stopCamera	Stop camera capture
startMicrophone	Turn on audio capture
stopMicrophone	Stop audio capture
setAudioQuality	Set the audio quality of the local transmission
enableVolumeIndication	Enable user volume alert
setupLocalVideo	Play local video
removeLocalVideo	Stop playing local video
getSourceId	Push id
getUrl	Get URL address
setBeautyEffectOptions	Turn on or off the local beauty function, and set the beauty effect options
setVideoEffectOptions	Turn on or off advanced beauty, and set beauty effect options
startPlayMovie	Play local video
setupLocalMovie	Play local video
removeLocalMovie	Stop local video
stopPlayMovie	Stop playing local video
pauseMediaFile	Stop playing local video
getMovieInfo	Get basic information about local video
resumeMediaFile	Continue playing local video
getMovieDuration	Get movie duration
getMovieCurrentPosition	Get the progress of a local video
setMoviePosition	Set local movie playback progress
getScreenWindowsInfo	Get application window information
getScreenDisplaysInfo	Get screen information
startScreenCaptureByDisplayId	Start screen sharing
startScreenCaptureByWindowId	Share screen app via window information
stopScreenCapture	Stop screen sharing
startSpeakerCaptureWhileSharing	Share desktop, and turn on desktop sound
stopSpeakerCaptureWhileSharing	Share desktop, turn off desktop sound
getDeviceManager	Gets the device management object

Event	Description
onFirstlocalvideoframe	The first frame of the local video has been captured callback
onApierror	Occurs when a parameter error occurs
onVolumeindication	Speaker volume reminder callback. This callback reports the volume of each user posting audio data in the channel
onRtsstats	Current call statistics, call statistics
onAudiodevicestatechanged	Audio device status changes
onVideodevicestatechanged	Video device status changes
onVideosizechanged	Video size change
onPushstateupdated	Push stream status change
onFirstlocalaudioframe	The first frame of local audio has been captured callback
onLocalVideoStateChanged	Local video status change callback. When the local video status changes, the SDK will trigger the callback to report the current local video status
onLocalAudioStateChanged	Local audio status change callback. , When the status of local audio changes, (including local microphone recording status and audio encoding status)
onError	Occurs when an error occurs

Vocal effect

Method	Description
enableDeepLearningDenoise	Enables/Disables deep-learning noise reduction.

Puller management

Pull flow Method

Method	Description
getVersion	Get the version
getClientId	Get user id
startPull	Start to pull
stopPull	Stop streaming
isPulling	Is it pulling
resumeAudio	Resume playing audio
pauseAudio	Pause audio
pauseVideo	Stop playing video
resumeVideo	Resume playing video
enableVolumeIndication	Enable user volume alert
getUrl	Get URL address
setupRemoteVideo	Set up remote streaming
removeRemoteVideo	Stop playing remote video
getAudioPlaybackDevices	Get the list of speakers
getSourceId	Pull stream id
setAudioPlaybackDevice	Set up speakers
getPlaybackDeviceInfo	Obtain playback device information
getCurrentAudioPlaybackDevice	Get the current speaker
setAudioPlaybackVolume	Set the volume of the audio playback device
getAudioPlaybackVolume	Get the volume of the audio playback device
startAudioPlaybackDeviceTest	Test speaker
stopAudioPlaybackDeviceTest	Stop testing speakers
setStreamConfigs	Set stream configuration items
getDeviceManager	Gets the device management object

Event	Description
onVolumeindication	Speaker volume reminder callback
onRtsstats	Current call statistics, call statistics
onPullstateupdated	Pull flow state change
onVideosizechanged	Video size change
onRemoteVideoStateChanged	The remote video stream status has changed callback
onFirstremotevideoframe	Occurs when the first remote audio frame is decoded
onFirstremoteaudioframe	Occurs when the first remote audio frame is received
onRemoteAudioStateChanged	The remote audio stream status has changed callback

Client Mixing UpStream

RtsMixingUpstream

Method	Description
startPush	Starts pushing the mixing stream
stopPush	Stops pushing the mixing stream
getUrl	Gets the URL
getClientID	Gets a ClientID
configMixing	Configures the mixing
isPushing	Gets the state of the push stream
setupLocalVideo	Play a local mixing video
removeLocalVideo	Stop playing the local mixing video

Event	Description
onPushstateupdated	Occurs when the push status changes
onRtsstats	Occurs when statistics change
onError	Occurs when an error occurs

Server stream mixing

Mixing Method

Method	Description
startMixing	Starts mixing the server stream
stopMixing	Stops mixing the server stream
configMixing	Configures mixing the server stream

Event	Description
onError	Occurs when an error occurs

Audio and Video device

Method	Description
getVideoDevices	Get the camera list
getCurrentVideoDevice	Get the current camera
setVideoDevice	Set up the camera
getAudioPlaybackDevices	Get the list of speakers
setAudioPlaybackDevice	Set up speakers
getPlaybackDeviceInfo	Obtain playback device information (speaker)
getCurrentAudioPlaybackDevice	Get the current speaker
setAudioPlaybackVolume	Set the volume of the audio playback device
getAudioPlaybackVolume	Get the volume of the audio playback device
getAudioRecordingDevices	Get the microphone list
setAudioRecordingDevice	Set up the microphone
getRecordingDeviceInfo	Get recording device information (microphone)
getCurrentAudioRecordingDevice	Get the current microphone
getAudioRecordingVolume	Get the volume of the recording device
setAudioRecordingVolume	Set the volume of the recording device
startAudioPlaybackDeviceTest	Test speaker
stopAudioPlaybackDeviceTest	Stop testing speakers
startAudioRecordingDeviceTest	Start testing the microphone
stopAudioRecordingDeviceTest	Stop testing the microphone
getAudioPlaybackDeviceMute	Get the mute status of the audio playback device (no return value)
setAudioPlaybackDeviceMute	Mute unmute audio playback device
getAudioRecordingDeviceMute	Get the mute status of the recording device
setAudioRecordingDeviceMute	Mute unmute recording equipment