Handle a Local Stream

The React Native SDK provides the following methods to handle a local stream:

• publish(): To publih a local stream into a room.
• switchCamera(): To switch between rear and front camera as a source for the published stream.
• switchMediaDevice(): To switch the microphone.
• muteSelfAudio(): To mute and unmute audio from a local stream.
• muteSelfVideo(): To mute and unmute video from a local stream.
• setAdvancedOptions(): To set advanced options for stream configuration.

Publish a Local Stream

The local stream with audio and video needs to be initiated and published into the Room for other participants to see and hear you. Enx.publish() method is used to publish a local stream to the connected Room. After the local stream is published to the Room, all participants are notified with a callback named streamAdded.

Method: publish()

Callbacks

Sample Code

roomConnected:event=>{
	Enx.publish();	// Publish Stream
}

streamPublished:event=>{
	// To publisher - Stream has been published 
}

eventError : event=>{
	// To publisher - Failed to publish
}

streamAdded:event=>{
	// To others - New stream is added
}

Switch Camera, Microphone, and Speaker

A user can switch to alternate media devices to publish the user's streams. EnableX provides APIs to allow switching of media devices on the fly. You can switch between rear and front camera and to other available microphones.

Switch between Rear and Front Camera

To switch between the rear and front camera as a source of published stream, use the Enx.switchCamera() method.

Method: Enx.switchCamera(localStreamId)

Parameter: localStreamId: String. Id of the local stream whose source camera is being switched.

Sample Code

Enx.switchCamera(localStreamId);

Switch to Alternate Microphone

If a user wants to switch the microphone, which is used to create a published stream, to an alternate microphone, use the Enx.switchMediaDevice() method. This API requires the name of the new device that it needs to switch to. Use the Enx.getDevices() method to fetch the list of microphone names and create a UI for the new device selection.

Method: Enx.switchMediaDevice(micDevice)

Parameter: micDevice: String. Name of the new microphone device.

Callback: notifyDeviceUpdate: JSON Object. When the audio device update is complete. It returns the details of the switched microphone device.

Sample Code

Enx.switchMediaDevice( micDevice ); // To switch to new micDev

// To self: Device updated
notifyDeviceUpdate : event =>{
	// event = micDevice name
}

Mute or Unmute Audio in a Stream

Use the Enx.muteSelfAudio() method to mute and unmute audio from a local stream. When a user mutes or unmutes audio from their Published Stream, all other connected users of the room are notified with remoteStreamAudioMute and remoteStreamAudioUnmute callbacks, respectively. Listen to these events to update related UI elements.

Method: Enx.muteSelfAudio( localStreamId, muteState )

Parameters:

Callbacks:

Sample Code

Enx.muteSelfAudio(localStreamId, true);   //To mute audio
Enx.muteSelfAudio(localStreamId,false);   //To unMute audio

// To all participant - user muted audio 
remoteStreamAudioMute:event=>{
	// event = { "result":0, "clientId":"XXX", "msg":"user muted audio" } 
}

// To all participant - user unmuted audio
remoteStreamAudioUnMute:event=>{
	// event = { "result":0, "clientId":"XXX", "msg":"user unmuted audio" } 
}

// To self - Audio muted / unmuted
audioEvent:event=>{
	// event = { "msg":"Audio Off", "result":0 } 
	// event = { "msg":"Audio On", "result":0 } 
}

Mute or Unmute Video in a Stream

Use the Enx.muteSelfVideo() method to mute and unmute video from a local stream. When a user mutes or unmutes video from the user's published stream, all other connected users of the room are notified with remoteStreamVideoMute and remoteStreamVideoUnMute callbacks, respectively. Listen to these events to update the related UI elements.

Method: Enx.muteSelfVideo( localStreamId, muteState )

Parameters:

Callbacks:

Sample Code

Enx.muteSelfVideo(localStreamId, true);   //To mute video
Enx.muteSelfVideo(localStreamId,false);   //To unMute video

// To all participant - user muted video 
remoteStreamVideoMute:event=>{
	// event = { "result":0, "clientId":"XXX", "msg":"user muted video" } 
}

// To all participant - user unmuted video
remoteStreamVideoUnMute:event=>{
	// event = { "result":0, "clientId":"XXX", "msg":"user unmuted video" } 
}

// To self - Video muted / unmuted
videoEvent:event=>{
	// event = { "msg":"Video Off", "result":0 } 
	// event = { "msg":"Video On", "result":0 } 
}

Advanced Stream Options

The Enx.setAdvancedOptions(AdvanceOptions) and Enx.setAdvancedOptions(advanceOptions) methods notify the user of various events affecting their streaming process.

Method: setAdvancedOptions(AdvanceOptions)

Parameter

Callback

Sample Code

advanceOptions: {
	battery_updates: true,
	notify_video_resolution_change: true
} 

Enx.setAdvancedOptions(advanceOptions)

// Advance Options are updated
advancedOptionsUpdate: event => {
	/* event = 
	[ 
		{	"id":"battery_updates",
			"enable":true
		}, 
		{	"id":"notify-video-resolution-change",
			"enable":true
		} 
	]  */
}

Method: Enx.getAdvancedOptions(): To get advanced options.

Sample Code

Enx.getAdvancedOptions()

// Advance Options are updated
getAdvancedOptions: event => {
	/* event = 
	[ 
		{	"id":"battery_updates",
			"enable":true
		}, 
		{	"id":"notify-video-resolution-change",
			"enable":true
		} 
	]  */
}