List of SDK Methods

EnxRtc Class

This class features a host of methods and event listeners to help application developers to create RTC applications. Using these methods, a client endpoint can connect to an EnableX session and manage different aspects to conduct a practical session.

Methods

The EnxRtc class methods are listed below.

Room Connection

• joinRoom() : To connect and join a room with a stream.
• disconnect() : To disconnect endpoint from a room.

Room Information

• getRoomId() : To get a Room ID
• getRoomMetadata() : To get a complete information about the room
• isConnected() : To know the status of the room if it is connected or not
• getMode() : To know whether the room is in group mode or lecture mode
• getClientId() : To get Client ID of the connected user to the room
• getClientName() : To get client name of the connected user to the room
• getRole() : To get role of the user connected to the room, viz. moderator or participant
• whoAmI() : To get connected user information at an endpoint
• getUserList() : To get a list of all the users connected to the room

Stream Configuration

• getMaxTalkers() : To get the maximum number of talkers allowed in the Active Talker list
• getTalkerCount() : To get the number of talkers in the Active Talker list
• setTalkerCount() : To set the number of talkers for the Active Talker list
• setAudioOnlyMode() : To change to an audio-only call, that is you neither want to receive anyone's video nor want to publish your video
• getAdvancedOptions() : To get advanced options like battery updated, video quality changed, and so on
• setAdvancedOptions() : To set advanced options
• muteSubscribeStreamsAudio() : To mute or unmute audio of a subscribed stream
• updateConfiguration() : To update the parameters of a stream
• getLocalStreamID() : To obtain the ID of the local stream

Messaging & File Sharing

• sendMessage() : To send public and private chat-messages
• sendFiles() : To send files to a specific user, a group, or all
• cancelUpload() : To cancel an ongoing uploading of a file
• cancelAllUploads() : To cancel all uploads
• getAvailableFiles() : To know which files are available for download
• downloadFile() : To download a file
• cancelDownload() : To cancel downloading a particular file
• cancelAllDownloads() : To cancel downloading of all files
• sendUserData() : To send messages to all or selected participants in a room

Moderator Controls

• startRecord() : To start the recording of a session
• stopRecord() : To stop the recording of a session
• hardMute() : To hard-mute a room where all the participants are on mute
• hardUnMute() : To lift the hard-mute restriction from the room
• lockRoom() : To lock a room preventing a new participant from joining the session
• unLockRoom() : To unlock a room and allow subsequent users to join the session
• dropUser() : To disconnect or force-drop a participant from a session
• destroy() : To stop or disconnect an ongoing session
• switchUserRole() : Allows a moderator to designate a connected participant to act as a moderator during a session

Screen Sharing

• addScreenShare() : To start screen sharing
• removeScreenShare() : To stop screen sharing
• hideScreenShareView() : To hide and unhide screen share view in the running conference

Canvas Streaming

• addCanvasScreen() : To start showing canvas streaming in a room
• removeCanvasScreen() : To stop showing canvas streaming in a room
• hideCanvasScreen() : To hide and unhide canvas view in the running conference

Annotations

• startAnnotation() : To initiate annotation
• stopAnnotation() : To stop annotation

Floor Access Control

• requestFloor() : Request moderator permission to access the floor and publish the local stream in the Lecture mode
• cancelFloor() : To cancel the request for floor access pending with the moderator
• grantFloor() : To grant floor access permission to participants allowing them to publish their local stream in the Lecture mode
• denyFloor() : To deny a participant's request for floor access in the Lecture mode
• finishFloor() : To finish the floor access for a participant
• releaseFloor() : To terminate the floor access granted to some participants.

:pcal Stream & Media Devices

• getDevices() : To find a list of devices such as a camera and a microphone attached to the device running the client application
• getSelectedDevice() : To get the currently selected or in-use audio device for the stream
• switchMediaDevice() : To switch the audio and video source of your published stream to another camera and microphone connected to your device

Stream Management

• muteSelfAudio() : To mute or unmute audio of a published stream
• muteSelfVideo() : To mute or unmute video of a published stream
• switchCamera() : To switch the video source of a local stream to another camera connected to the device
• initLocalView() : To display local stream
• initRemoteView() : To show remote streams
• hideSelfView() : To hide and unhide local stream view in the running conference
• hideRemoteView() : To hide and unhide remote stream view in the running conference
• resizeLocalView() : To resize the local view in the running conference
• resizeRemoteView() : To resize the remote view in the running conference

Manage Logging

• enableLogs() : To enable client side logging
• postClientLogs() : To submit client endpoint logs to EnableX team to audit

Handle Application Switch

• stopVideoTracksOnApplicationBackground() : To switch to different application pushing your RTC application to background
• startVideoTracksOnApplicationForeground() : To switch back to your RTC application

Manage Video

• setReceiveVideoQuality() : To opt to receive the desired video quality for available bandwidth
• getReceiveVideoQuality() : To get currently selected video quality
• adjustLayout() : To adjust video player layout in case you have received complete Active Talker view

Miscellaneous

• extendConferenceDuration() : To extend conference duration
• makeOutboundCall() : To initiate an outbound call to a PSTN number or SIP URI inviting the called participant to join the session on accepting the call
• enableProximitySensor() : To enable proximity sensor
• enableStats() : To enable or disable streaming stats for all the streams in a room.