Utilities

The React Native SDK provides the following methods for managing different aspects of video sessions:

• makeOutboundCall(): To initiate an outbound call to a PSTN number or a SIP URI while being in a session.
• changeToAudioOnly(): To switch to an audio-only call.
• onPause(): To switch the RTC application to the background.
• onResume(): To switch the RTC application to the foreground.
• captureScreenShot(): To take a snapshot of a video stream in your application.
• postClientLogs(): To share console log with EnableX tech team for audit.
• clientDiagnostics(): To detect any issue causing the RTC to fail.
• enableProximitySensor(): To detect the proximity.

Dialing Out to Phone and SIP Endpoint from a Video Room

The Enx.makeOutboundCall() method allows you to initiate an outbound call to a PSTN number or a SIP URI while in the session, inviting the called participant to join the session on accepting the call.

Method: makeOutboundCall(number,callerId)

Parameters

Callbacks

Error Codes and Exceptions

Audio Only Mode for a Video Room

The Enx.changeToAudioOnly() method allows you to switch to an audio-only call where you can neither receive anybody's video nor publish your video. You can use this method as a toggle to switch between audio-only and audio-video calls. It does not affect video streams of others in the room.

Method: changeToAudioOnly( audioOnlyState )

Parameter: audioOnlyState: Boolean. Set it to true to switch to an audio-only call.
Set it to false to switch back to the audio-video call.

Sample Code

Enx.changeToAudioOnly(true);   // Switched to Audio-Only call
Enx.changeToAudioOnly(false);  // Switched back to Audio-Video call

Handle Application Switch

The following methods switch the RTC application to the background and vice versa. These methods allow you to configure whether to continue streaming or pause it after the switch.

Switch Application to Background

The following method switches the application to the background.

Method: Enx.onPause(localMuteState, remoteMuteState)

Parameters

Sample Code

// When application goes to Background 
this.setState({localMuteState : false});
this.setState({remoteMuteState : false}); 
Enx.onPause( localMuteState, remoteMuteState );

Switch Application to Foreground

The following method switches the application to the foreground:

Method: Enx.onResume(localUnmuteState, remoteUnmuteState)

Parameters

Sample Code

// When application comes back to Foreground 
this.setState({localUnmuteState : true});
this.setState({remoteUnmuteState : true});  
Enx.onResume( localUnmuteState, remoteUnmuteState);

Take Image Snapshot of a Video Stream

The Enx.captureScreenShot() method takes a snapshot of a video stream in your application. The image is returned as a bitmap image to the callback.

Method: Enx.captureScreenShot(streamId)

Parameter: streamId: String. ID of the stream from which the snapshot is to be taken.

Callback: capturedView: String. Receives base64 encoded string for the captured raw bitmap.

Sample Code

Enx.captureScreenShot(localStreamId);

capturedView: event => {
	this.setState({
		base64Icon: event
	});
}

// To show captured snapshot
<Image 
	style={{ width: 50, height: 50 }}
	source={{ uri: `data:image/png;b ase64,${this.state.base64Icon}`}}
/>

Share Log with EnableX

The Enx.postClientLogs() method is used to share console log with EnableX tech team for audit. The method sends 200KB of the most recent console log to EnableX.

Method: postClientLogs()

Callback: logsUploaded: When logs are posted to EnableX.

Note: You must enable console logging to share console logs. The Enx.enableLogs() method enables logging.

Method: enableLogs(loggingState)

Parameter: loggingState: Boolean. Set it to true to enable logging. Otherwise, set it to false.

Sample Code

Enx.enableLogs(true); // Enable Logging
Enx.postClientLogs(); // Post Log to EnableX

logsUploaded : event =>{
 // Logs uploaded
 // event = { msg:'success', result:0 } 
}

Pre-Call Test (WebRTC Diagnostic API)

The Enx.clientDiagnostics() method acts as a diagnostic tool to detect any issue causing the RTC to fail. The API runs through predefined test cases related to WebRTC issues and reports asynchronously through an event as it passes through each test. These test cases are organized in "Test Groups" as listed below.

Note: Camera, Microphone, and Bandwidth test groups marked with * are not available in SDK v1.9.6.

You can also build a UI using the following API to initiate the tests and generate a diagnostic report.

Method: clientDiagnostics(clientOptions)

Delegate Methods

Explanation of Test Results

EnableX Proximity Sensor

The Enx.enableProximitySensor() enables the camera to detect proximity. On most devices, the proximity sensor is implemented as a boolean sensor.

• It returns two values: NEAR or FAR.
• Thresholding is performed on the LUX value, that is, the light sensor's LUX value is compared with a threshold value.
• A LUX value more than the threshold value means the proximity sensor returns FAR.
• For any value less than the threshold value, the sensor returns NEAR.

Method: enableProximitySensor(boolean status)

Parameter: status: Boolean. Set it to true to enable Proximity Sensor.
Otherwise, set it to false.

Sample Code

Enx.enableProximitySensor(true); // Enable Sensor