List of SDK Methods

EnxRtc Class

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

Methods

The EnxRtc class methods are listed below.

Connection

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

Information

getRoomId()	To get room ID.
getClientId()	To get the Client ID of a user connected to a room.
getClientName()	To get Client Name of a user connected to a room.
getRole()	To get the role of a user connected to the room. For example, the moderator or the participant role.
whoAmI()	To get the connected user's information at an endpoint.
getUserList()	To get the list of users connected to a room.
isRoomActiveTalker()	To check if a room has active talkers.

Streaming

publish()	To publish a local stream to a connected room.
unpublish()	To unpublish a local stream.
subscribe()	To subscribe a remote stream to receive.
getMaxTalkers()	To get the number of talkers allowed to receive in the Active Talker list.
setTalkerCount()	To opt for number of talkers to receive in the Active Talker list.
getTalkerCount()	To get the number of talkers to receive in the Active Talker list.
setAudioOnlyMode()	To switch to an audio-only call if you do not want to receive video from others or publish your video.
getAdvancedOptions()	To get advanced options like battery updated, video quality changed. etc
setAdvancedOptions()	To set advanced options.
setScalingType()	To update the scaling type.
muteSubscribeStreamsAudio()	To mute/unmute audio of subscribed streams.
updateConfiguration()	To re-configure your stream by adding new or updating existing specification parameters of a stream.

Messaging and File Sharing

sendUserData()	To send messages to all or selected participants in a room.
sendMessage()	To send public and private chat messages.
sendFiles()	To send files to a specific user, group, or all users.
cancelUpload()	To cancel an ongoing upload of a file.
cancelAllUploads()	To cancel all uploads.
getAvailableFiles()	To get all the available files in a session to download.
downloadFile()	To download a file.
cancelDownload()	To cancel an ongoing download of a file.
cancelAllDownloads()	To cancel all downloads.

Moderator Controls

startRecord()	To start recording of a session.
stopRecord()	To stop ongoing recording of a session.
hardMute()	To hard-mute a room, where no participant is allowed to talk.
hardUnMute()	To hard-unmute a room.
lockRoom()	To lock a room to disallow further entry into the room.
unLockRoom()	To unlock a room to allow subsequent entry into the room.
dropUser()	To drop a user from a session.
destroy()	To conclude an ongoing session.
switchUserRole()	For the moderator to designate a connected participant to act as a moderator during a session.
switchRoomMode()	Allows a moderator to switch a room's mode of operation from Group to Lecture or vice versa during an ongoing conference.
approveAwaitedUser()	To allow a moderator to approve a user's entry.
denyAwaitedUser()	To decline a user's entry to a session.
pinUsers()	To allow the moderator to pin a user.
addSpotlightUsers()	To allow the moderator to spotlight a user, which pushes the user's stream to the top of the Active Talker list irrespective of the user's activity level.
hardMuteAudio()	To hard-mute a participant's audio.
hardMuteVideo()	To hard-mute a participant's video.
hardUnMuteAudio()	To lift the audio hard-mute restriction from the Participant
hardUnmuteVideo()	To lift the video hard-mute restriction from a participant.

Floor Access Control

requestFloor()	To request the moderator for floor access to publish.
cancelFloor()	For the participant to cancel the floor access request.
grantFloor()	To grant floor access to a participant allowing the participant to publish.
denyFloor()	To deny floor access to a participant who had requested for it.
finishFloor()	For the participant to finish floor access granted by the moderator.
releaseFloor()	For the moderator to terminate the floor access granted to some participants.

Devices

getDevices()	To get the list of connected audio devices.
getSelectedDevice()	To get the name of the given/selected device.
switchMediaDevice()	To switch to an alternate media device. A user can switch to alternate available microphone.
switchCamera()	To switch from rear to front camera and vice-versa to change stream source.

Stream Controls

muteSelfAudio()	To mute/unmute the audio of own published stream.
muteSelfVideo()	To mute/unmute the video of own published stream.

Manage Logging

enableLogs()	To enable the client-side logging.
postClientLogs()	To submit the logs of client endpoints to the EnableX Technical team for auditing.

Advance Features

startScreenShare()	To create a screen sharing stream.
stopScreenShare()	To stop the ongoing screen sharing.
setPlayerScalingType()	To choose stream scaling options within the video player.
extendConferenceDuration()	To extend the duration of a conference.
makeOutboundCall()	To make an outbound SIP/PSTN call from a session.
enableProximitySensor()	To enable the Proximity Sensor.
enableStats()	To get live statistics of each stream you are playing at any endpoint, irrespective of whether it a local stream or a subscribed stream.
subscribeForTalkerNotification()	To receive notification about the talkers in a room or the participants acting as a source of noise .
stopVideoTracksOnApplicationBackground()	To switch to a different application pushing your RTC application to the background.
startVideoTracksOnApplicationForeground()	To switch back to the different application pushing your RTC application to the foreground.
getReceiveVideoQuality()	To switch back to a different application pushing your RTC application to the foreground.

Flutter SDK Release Notes Get Media Devices