@voxeet/react-components
Advanced tools
Readme
npm i @voxeet/voxeet-web-sdk @voxeet/react-components @voxeet/react-redux-5.1.1@5.1.1 --save
yarn add @voxeet/voxeet-web-sdk @voxeet/react-components @voxeet/react-redux-5.1.1@5.1.1
sameSite cookie warning.This version only work with Voxeet SDK V2 (Please contact us to use it) ! IMPORTANT ! This version is on alpha, some issues can appear. DO NOT PUSH IN PRODUCTION.
pstnNumbers is now empty, you need to use your own PSTN numbers in order to use this feature
Format :[
{
Code: "US",
Number: "YOUR_PSTN_NUMBER",
},
];
umd to commonjs2react-redux v7.X, VoxeetProvider is now exposed inside the react-components to prevent version conflicts (Use the VoxeetProvider instead )videoCodec default is now H264closeSessionAtHangUp, option to choose if the session should be automatically close at hang up (default: true)invitedUsers in order to find user easily in the AttendeesListinvitedUsers, add the possibilidy to give an array of users who can be invited during the conference. (externalId mandatory)pstnNumbers, use http://cdn.voxeet.com/pstn/numbers to get phone numbers for PSTN and give an array of needed numbers in this propertydisableSounds propscustomLocalizedStringsshareActions you can add videopresentation), a video can now be shared to other attendees. Only the video presenter can control the video, other attendees will receive actions (Play/Pause/Seek).attendeesWaiting.autoRecording (if it's not already start).autoHls (if it's not already start).A redux reducer needs to be added to your store.
import { reducer as voxeetReducer } from "@voxeet/react-components";
const reducers = combineReducers({
voxeet: voxeetReducer,
});
import React from "react";
import ReactDOM from "react-dom";
import thunkMidleware from "redux-thunk";
import { combineReducers, createStore, applyMiddleware } from "redux";
import {
ConferenceRoom,
VoxeetProvider,
reducer as voxeetReducer,
} from "@voxeet/react-components";
// Import Style
import "@voxeet/react-components/dist/voxeet-react-components.css"; // Can you be customize, refer to https://github.com/voxeet/voxeet-assets-react-components
const reducers = combineReducers({
voxeet: voxeetReducer,
});
const configureStore = () =>
createStore(reducers, applyMiddleware(thunkMidleware));
const settings = {
consumerKey: "consumerKey",
consumerSecret: "consumerSecret",
conferenceAlias: "Sample",
};
ReactDOM.render(
<VoxeetProvider store={configureStore()}>
<ConferenceRoom
isWidget
consumerKey={settings.consumerKey}
consumerSecret={settings.consumerSecret}
conferenceAlias={settings.conferenceAlias}
/>
</VoxeetProvider>,
document.getElementById("app")
);
where consumerKey and consumerSecret or oauthToken (retrieve by backend) are your credentials and conferenceAlias the conference you want to join.
The Widget is translate in english and french. The language will be automatically choose base on your browser language.
| Name | Type | Default | Description |
|---|---|---|---|
sdk | Function | VoxeetSDK if you want to use an external Voxeet SDK | |
consumerKey | String | The consumer key | |
consumerSecret | String | The consumer secret | |
oauthToken | String | The oauth token retrieve from your backend (prevent using consumerKey/consumerSecret in frontend) ! Make sure to use this `refreshTokenCallback props of the widget too ! | |
refreshTokenCallback | func | Provide this function that return a promise with the refreshed token, when this one expire | |
conferenceAlias | String | The conference you whant to join | |
logo | String | Voxeet Logo | Display your logo inside the react components by using this props. |
chromeExtensionId | String | Id of chrome screenshare extension, a message will be prompt when the user will try to screenshare (Inline installation is no longer supported) | |
displayActions | Array | ["mute" ,"recording", "share", "video", "live", "attendees", "chat", "pstn"] | You can disable some actions buttons. Example : displayActions={["mute", "video"]} will allow to video and mute button (Strings : "mute", "video", "share", "recording", "live", "attendees", "chat") |
shareActions | Array | ["screenshare" ,"filepresentation", "videopresentation"] | You can choose which button will be display, it's possible to do a screenshare, file presentation or video presentation ! If you set the displayActions you need to add the 'share' button to allow actions. |
liveRecordingEnabled | Boolean | false | Ability to record a conference in live. Generate an MP4 video of the conference. Can be retrieve by a webhook (a small delay might be necessary for process the video) |
disableSounds | Boolean | false | Disable sounds during the conference (mute/unmute, record, conference join, conference left) |
customLocalizedStrings | Object | Custom strings, described below | |
pstnNumbers | Array | Custom PSTN Numbers | |
pinCode | String | Pin code for PSTN call | |
isWidget | Boolean | true | Indicate if component used like widget or embedded in your app |
chromeExtensionId | String | null | The Id from your Chrome Web Extension to screenshare (needed only on Chrome) |
autoRecording | Boolean | false | Automatically record the conference when joining the conference (if it's not already start) |
closeSessionAtHangUp | Boolean | true | Automatically close the session of the current user when hang up |
isModal | Boolean | false | Indicate if component displayed like modal |
loadingScreen | Component | LoadingScreen | Put your own loading screen instead of Voxeet loading screen |
isWebinar | Boolean | false | Launch the widget in Webinar mode, only admin can speak (Restriction in "tiles" mode) |
autoJoin | Boolean | false | Join automatically conference |
preConfig | Boolean | false | Show a pop up before entering inside the Conference to configure your devices (audio, video) |
videoCodec | String | H264 | Specify video codec "H264" or "VP8" => H264 is needed for video on Safari |
isListener | Boolean | false | Enter in conference in listener mode |
displayModes | Array | ["list", "tiles", "speaker"] | Indicate which mode is allowed (modes will be in the same order as the array) |
invitedUsers | Array | [{name: "USERNAME", externalId:"EXTERNAL_ID", title: "TITLE"}] | Array of people who can be invited during the conference. If the other side, people need to be subscribe to the conference to receive the invitation |
isManualKickAllowed | Boolean | false | Authorize admin (conference creator) to kick users in conference |
isAdmin | Boolean | false | Current user who join the conference is the admin |
kickOnHangUp | Boolean | false | Kick all users when admin (conference creator) leave the conference |
userInfo | Object | { name: 'Guest ' + Math.floor((Math.random() * 100) + 1), externalId: '', avatarUrl: '' } | User informations for voxeet sdk |
conferenceReplayId | String | Replay automatically a conference | |
constraints | Object | { audio: true, video: false } | The webrtc constraints for the sdk |
actionsButtons | React Component | ActionsButtons - All buttons | A react component to customize the actions buttons |
handleOnLeave | Function | Function call on leave conference | |
handleOnConnect | Function | Function call when the current user is connected to the conference |
For more documentation on userInfo and constraints you can look at Voxeet Sdk
The default control buttons component is below, you can customize it for you needs. Just replace
import React, { Component } from "react";
import PropTypes from "prop-types";
import bowser from "bowser";
import { Buttons } from "@voxeet/react-components";
class ActionsButtons extends Component {
constructor(props) {
super(props);
}
render() {
const {
isBottomBar,
forceFullscreen,
isMuted,
isRecording,
isWidgetFullScreenOn,
toggleVideoPresentation,
videoEnabled,
isVideoPresentation,
videoPresentationEnabled,
displayModal,
conferencePincode,
convertFilePresentation,
toggleMicrophone,
screenShareEnabled,
filePresentationEnabled,
toggleRecording,
toggleVideo,
toggleScreenShare,
attendeesSettingsOpened,
toggleAttendeesSettings,
toggleAttendeesList,
attendeesListOpened,
attendeesChatOpened,
toggleAttendeesChat,
recordingLocked,
toggleModal,
toggleAudio3D,
participants,
isWebinar,
isAdmin,
displayActions,
shareActions,
leave,
audio3DEnabled,
displayExternalLiveModal,
currentUser,
isFilePresentation,
isScreenshare,
isDemo,
} = this.props;
let nbParticipants = 0;
if (participants && participants.length) {
nbParticipants = participants.filter((p) => p.isConnected).length;
}
if ((!isWebinar && !currentUser.isListener) || (isWebinar && isAdmin))
nbParticipants += 1;
return (
<div>
<ul className="controls-left">
{!isWidgetFullScreenOn &&
!forceFullscreen &&
(!isWebinar || (isWebinar && isAdmin)) &&
displayActions.indexOf("mute") > -1 &&
!isDemo && (
<ToggleMicrophoneButton
isMuted={isMuted}
toggle={toggleMicrophone}
isBottomBar={isBottomBar}
tooltipPlace={isBottomBar ? "top" : "right"}
/>
)}
{!isWidgetFullScreenOn &&
!forceFullscreen &&
(!isWebinar || (isWebinar && isAdmin)) &&
displayActions.indexOf("video") > -1 &&
!isDemo && (
<ToggleVideoButton
videoEnabled={videoEnabled}
toggle={toggleVideo}
isBottomBar={isBottomBar}
tooltipPlace={isBottomBar ? "top" : "right"}
/>
)}
</ul>
<ul className="controls-center">
{!isWidgetFullScreenOn &&
!forceFullscreen &&
(!isWebinar || (isWebinar && isAdmin)) &&
displayActions.indexOf("recording") > -1 &&
!isDemo && (
<ToggleRecordingButton
isRecording={isRecording}
recordingLocked={recordingLocked}
toggle={toggleRecording}
isBottomBar={isBottomBar}
tooltipPlace={isBottomBar ? "top" : "right"}
/>
)}
{!isWidgetFullScreenOn &&
!forceFullscreen &&
(!isWebinar || (isWebinar && isAdmin)) &&
displayActions.indexOf("share") > -1 &&
!isDemo &&
shareActions.length > 0 && (
<ToggleScreenShareButton
screenShareEnabled={screenShareEnabled}
filePresentationEnabled={filePresentationEnabled}
videoPresentationEnabled={videoPresentationEnabled}
currentUserScreenShare={isScreenshare}
currentUserFilePresentation={isFilePresentation}
currentUserVideoPresentation={isVideoPresentation}
toggle={toggleScreenShare}
toggleVideoPresentation={toggleVideoPresentation}
convertFilePresentation={convertFilePresentation}
shareActions={shareActions}
isBottomBar={isBottomBar}
tooltipPlace={isBottomBar ? "top" : "right"}
/>
)}
{isBottomBar && (!isWebinar || (isWebinar && isAdmin)) && !isDemo && (
<li className="separator"></li>
)}
{isBottomBar && (
<HangUpButtonBottomBar leave={leave} tooltipPlace="top" />
)}
</ul>
<ul className="controls-right">
{!isWidgetFullScreenOn &&
!forceFullscreen &&
(!isWebinar || (isWebinar && isAdmin)) &&
displayActions.indexOf("pstn") > -1 &&
conferencePincode.length > 0 &&
!isDemo && (
<TogglePSTN
conferencePincode={conferencePincode}
isBottomBar={isBottomBar}
tooltipPlace={isBottomBar ? "top" : "right"}
/>
)}
{!isWidgetFullScreenOn &&
!forceFullscreen &&
(!isWebinar || (isWebinar && isAdmin)) &&
!bowser.msie &&
!currentUser.isListener && (
<ToggleSettingsButton
attendeesSettingsOpened={attendeesSettingsOpened}
toggle={toggleAttendeesSettings}
isBottomBar={isBottomBar}
tooltipPlace={isBottomBar ? "top" : "right"}
/>
)}
{displayActions.indexOf("attendees") > -1 && (
<ToggleAttendeesListButton
nbParticipants={nbParticipants}
tooltipPlace={isBottomBar ? "top" : "right"}
toggle={toggleAttendeesList}
isBottomBar={isBottomBar}
isOpen={attendeesListOpened}
/>
)}
{displayActions.indexOf("chat") > -1 && (
<ToggleAttendeesChatButton
tooltipPlace={isBottomBar ? "top" : "right"}
toggle={toggleAttendeesChat}
isBottomBar={isBottomBar}
isOpen={attendeesChatOpened}
/>
)}
</ul>
</div>
);
}
}
ActionsButtons.propTypes = {
isBottomBar: PropTypes.bool.isRequired,
forceFullscreen: PropTypes.bool.isRequired,
isMuted: PropTypes.bool.isRequired,
currentUser: PropTypes.object.isRequired,
isWebinar: PropTypes.bool.isRequired,
isAdmin: PropTypes.bool.isRequired,
videoEnabled: PropTypes.bool.isRequired,
screenShareEnabled: PropTypes.bool.isRequired,
filePresentationEnabled: PropTypes.bool.isRequired,
videoPresentationEnabled: PropTypes.bool.isRequired,
displayModal: PropTypes.bool.isRequired,
isScreenshare: PropTypes.bool.isRequired,
isVideoPresentation: PropTypes.bool.isRequired,
isFilePresentation: PropTypes.bool.isRequired,
displayActions: PropTypes.array.isRequired,
toggleAudio3D: PropTypes.func.isRequired,
recordingLocked: PropTypes.bool.isRequired,
audio3DEnabled: PropTypes.bool.isRequired,
isRecording: PropTypes.bool.isRequired,
isWidgetFullScreenOn: PropTypes.bool.isRequired,
toggleMicrophone: PropTypes.func.isRequired,
leave: PropTypes.func.isRequired,
toggleRecording: PropTypes.func.isRequired,
toggleVideo: PropTypes.func.isRequired,
toggleScreenShare: PropTypes.func.isRequired,
toggleVideoPresentation: PropTypes.func.isRequired,
convertFilePresentation: PropTypes.func.isRequired,
toggleModal: PropTypes.func.isRequired,
toggleMode: PropTypes.func.isRequired,
mode: PropTypes.string.isRequired,
toggleAttendeesList: PropTypes.func.isRequired,
attendeesListOpened: PropTypes.bool.isRequired,
toggleAttendeesChat: PropTypes.func.isRequired,
attendeesChatOpened: PropTypes.bool.isRequired,
toggleAttendeesSettings: PropTypes.func.isRequired,
attendeesSettingsOpened: PropTypes.bool.isRequired,
};
ActionsButtons.defaultProps = {
isBottomBar: false,
forceFullscreen: false,
};
export default ActionsButtons;
For english language (Be sure to use this keys to override default strings)
[en: {
noPstnNumbers: "There is no PSTN numbers...",
electronloading: "Voxeet is loading, please wait",
error: "Error",
errorPermissionDeniedMicrophone:
"An error occured when joining the conference. Please make sure to allow access to your microphone.",
errorPermissionDeniedMicrophoneCamera:
"An error occured when joining the conference. Please make sure to allow access to your microphone and camera.",
errorIE11:
"A plugin is mandatory for IE11, please download and install the plugin. When the installation is complete, please refresh this page.",
browerNotSupported: "This browser is currently not supported.",
installExtension: "Please install the screen share extension with this ",
noExtensionAvailable: "No Chrome Web Extension configure for screen share.",
microphoneOff: "Your microphone is muted.",
microphoneOn: "Your microphone is on.",
cameraOn: "Your camera is on.",
cameraOff: "Your camera is off.",
recordConferenceStart: "Your conference is being recorded.",
recordConferenceStop: "Your conference is no longer recorded.",
screenshareInProgress:
"You cannot screenshare while another user is screensharing.",
recordConferenceStartBy: "Your conference is being recorded by ",
recordConferenceStopBy: "Your conference is no longer recorded by ",
conferenceAlreadyRecord:
"Your conference is already being recorded by an other attendee.",
leave: "End",
audio: "3D Audio",
audioTitle: "Audio",
chat: "Chat",
nameConversation: "Name this conversation",
externalLive: "Live Broadcast",
fullscreen: "FullScreen",
minimize: "Minimize",
mute: "Mute",
displaymode: "Display mode",
pincode: "Call-in",
sendMessage: "Send",
pinCodeExplanations:
"Call this number below and provide the conference pin code to join the conference via PSTN.",
record: "Record",
shareAlreadyStarted:
"Someone is already sharing. Please stop it before start a new one.",
share: "Share",
screenshare: "Share Screen",
screenshareEntireScreen: "Share Entire Screen",
screenshareAWindow: "Share a Window",
screenshareOption: "Share Options",
settings: "Settings",
open: "Open",
close: "Close",
video: "Video",
camera: "Camera",
liveCall: "Live is running",
linkHls: "See your live",
broadcastLive: "Diffusion en cours",
externalUrl: "Configure your stream",
externalPassword: "Enter your password from your live",
launchLive: "Start your stream",
stopLive: "Stop your live stream",
geturl: "Get your stream url (on Youtube or Facebook)",
getpwd: "Get your stream password (on Youtube or Facebook)",
enterhere: "Enter your informations here :",
titleSettings: "Set preferred camera and microphone",
problemSettings: "If you are having problems, try restarting your browser.",
saveSettings: "Your preferences will automatically save.",
screensharerunning: "Happy Screen Sharing!",
tile: "Tile",
list: "List",
speaker: "Speaker",
displaymode: "Display mode",
changelayout: "Change layout",
attendees: "Attendees",
participantsHeder: "Participants ",
invitedHeder: "Invited",
here: "here",
hangtight: "We're waiting for other callers to arrive.",
join: "Join",
incall: "In call with :",
joincall: "Join Call",
expand: "Expand",
activecall: "Active call",
leavecall: "Leave call",
output: "Output",
input: "Input",
titlePreConfig: "Set up your devices",
addParticipant: "Add Participant",
presenter: "Attendees",
joined: "Joined",
invited: "Waiting on",
presenter: "Presenter",
listener: "Listener",
left: "Left",
noAudioDevice:
"No audio device detected. Please make sure to plug at least one microphone to access this conference.",
filepresentation: "Share a File",
prev: "Previous",
next: "Next",
errorFilePresentation:
"An error occured during the file presentation. Please check your file.",
videopresentation: "Share a Video",
placeholderVideoPresentation: "Video URL",
startVideoPresentationAutoplay: "Start video",
invitedUsers: "Waiting for invitation",
inviteUser: "Invite"
}]
More language can be added. Use an array prefixed with the correct language key. (en, fr, it, ...)
FAQs
## Installation
The npm package @voxeet/react-components receives a total of 283 weekly downloads. As such, @voxeet/react-components popularity was classified as not popular.
We found that @voxeet/react-components demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.