mediasfu-shared 1.0.6 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/HEADLESS_GUIDE.md +156 -0
- package/README.md +130 -62
- package/dist/ProducerClient/producerClientEmits/createDeviceClient.d.ts +23 -0
- package/dist/ProducerClient/producerClientEmits/createDeviceClient.d.ts.map +1 -0
- package/dist/ProducerClient/producerClientEmits/joinRoomClient.d.ts +22 -0
- package/dist/ProducerClient/producerClientEmits/joinRoomClient.d.ts.map +1 -0
- package/dist/ProducerClient/producerClientEmits/updateRoomParametersClient.d.ts +85 -0
- package/dist/ProducerClient/producerClientEmits/updateRoomParametersClient.d.ts.map +1 -0
- package/dist/consumers/addVideosGrid.d.ts +10 -0
- package/dist/consumers/addVideosGrid.d.ts.map +1 -0
- package/dist/consumers/autoAdjust.d.ts +41 -0
- package/dist/consumers/autoAdjust.d.ts.map +1 -0
- package/dist/consumers/calculateRowsAndColumns.d.ts +24 -0
- package/dist/consumers/calculateRowsAndColumns.d.ts.map +1 -0
- package/dist/consumers/changeVids.d.ts +252 -0
- package/dist/consumers/changeVids.d.ts.map +1 -0
- package/dist/consumers/checkGrid.d.ts +42 -0
- package/dist/consumers/checkGrid.d.ts.map +1 -0
- package/dist/consumers/checkPermission.d.ts +42 -0
- package/dist/consumers/checkPermission.d.ts.map +1 -0
- package/dist/consumers/checkScreenShare.d.ts +59 -0
- package/dist/consumers/checkScreenShare.d.ts.map +1 -0
- package/dist/consumers/closeAndResize.d.ts +157 -0
- package/dist/consumers/closeAndResize.d.ts.map +1 -0
- package/dist/consumers/compareActiveNames.d.ts +50 -0
- package/dist/consumers/compareActiveNames.d.ts.map +1 -0
- package/dist/consumers/compareScreenStates.d.ts +55 -0
- package/dist/consumers/compareScreenStates.d.ts.map +1 -0
- package/dist/consumers/connectIps.d.ts +66 -0
- package/dist/consumers/connectIps.d.ts.map +1 -0
- package/dist/consumers/connectLocalIps.d.ts +52 -0
- package/dist/consumers/connectLocalIps.d.ts.map +1 -0
- package/dist/consumers/connectRecvTransport.d.ts +64 -0
- package/dist/consumers/connectRecvTransport.d.ts.map +1 -0
- package/dist/consumers/connectSendTransport.d.ts +75 -0
- package/dist/consumers/connectSendTransport.d.ts.map +1 -0
- package/dist/consumers/connectSendTransportAudio.d.ts +62 -0
- package/dist/consumers/connectSendTransportAudio.d.ts.map +1 -0
- package/dist/consumers/connectSendTransportScreen.d.ts +72 -0
- package/dist/consumers/connectSendTransportScreen.d.ts.map +1 -0
- package/dist/consumers/connectSendTransportVideo.d.ts +75 -0
- package/dist/consumers/connectSendTransportVideo.d.ts.map +1 -0
- package/dist/consumers/consumerResume.d.ts +16 -0
- package/dist/consumers/consumerResume.d.ts.map +1 -0
- package/dist/consumers/controlMedia.d.ts +61 -0
- package/dist/consumers/controlMedia.d.ts.map +1 -0
- package/dist/consumers/createSendTransport.d.ts +80 -0
- package/dist/consumers/createSendTransport.d.ts.map +1 -0
- package/dist/consumers/disconnectSendTransportAudio.d.ts +79 -0
- package/dist/consumers/disconnectSendTransportAudio.d.ts.map +1 -0
- package/dist/consumers/disconnectSendTransportScreen.d.ts +61 -0
- package/dist/consumers/disconnectSendTransportScreen.d.ts.map +1 -0
- package/dist/consumers/disconnectSendTransportVideo.d.ts +72 -0
- package/dist/consumers/disconnectSendTransportVideo.d.ts.map +1 -0
- package/dist/consumers/dispStreams.d.ts +189 -0
- package/dist/consumers/dispStreams.d.ts.map +1 -0
- package/dist/consumers/frameworkConsumerContract.d.ts +2 -0
- package/dist/consumers/frameworkConsumerContract.d.ts.map +1 -0
- package/dist/consumers/generatePageContent.d.ts +68 -0
- package/dist/consumers/generatePageContent.d.ts.map +1 -0
- package/dist/consumers/getEstimate.d.ts +62 -0
- package/dist/consumers/getEstimate.d.ts.map +1 -0
- package/dist/consumers/getPipedProducersAlt.d.ts +62 -0
- package/dist/consumers/getPipedProducersAlt.d.ts.map +1 -0
- package/dist/consumers/getProducersPiped.d.ts +49 -0
- package/dist/consumers/getProducersPiped.d.ts.map +1 -0
- package/dist/consumers/getVideos.d.ts +49 -0
- package/dist/consumers/getVideos.d.ts.map +1 -0
- package/dist/consumers/gridLayout/addVideosGrid.engine.d.ts +19 -0
- package/dist/consumers/gridLayout/addVideosGrid.engine.d.ts.map +1 -0
- package/dist/consumers/gridLayout/prepopulateUserMedia.engine.d.ts +138 -0
- package/dist/consumers/gridLayout/prepopulateUserMedia.engine.d.ts.map +1 -0
- package/dist/consumers/index.cjs +80 -0
- package/dist/consumers/index.cjs.map +1 -0
- package/dist/consumers/index.d.ts +62 -0
- package/dist/consumers/index.d.ts.map +1 -0
- package/dist/consumers/index.js +80 -0
- package/dist/consumers/index.js.map +1 -0
- package/dist/consumers/mixStreams.d.ts +37 -0
- package/dist/consumers/mixStreams.d.ts.map +1 -0
- package/dist/consumers/onScreenChanges.d.ts +62 -0
- package/dist/consumers/onScreenChanges.d.ts.map +1 -0
- package/dist/consumers/prepopulateUserMedia.d.ts +10 -0
- package/dist/consumers/prepopulateUserMedia.d.ts.map +1 -0
- package/dist/consumers/processConsumerTransports.d.ts +73 -0
- package/dist/consumers/processConsumerTransports.d.ts.map +1 -0
- package/dist/consumers/processConsumerTransportsAudio.d.ts +57 -0
- package/dist/consumers/processConsumerTransportsAudio.d.ts.map +1 -0
- package/dist/consumers/rePort.d.ts +63 -0
- package/dist/consumers/rePort.d.ts.map +1 -0
- package/dist/consumers/reUpdateInter.d.ts +142 -0
- package/dist/consumers/reUpdateInter.d.ts.map +1 -0
- package/dist/consumers/readjust.d.ts +68 -0
- package/dist/consumers/readjust.d.ts.map +1 -0
- package/dist/consumers/receiveAllPipedTransports.d.ts +44 -0
- package/dist/consumers/receiveAllPipedTransports.d.ts.map +1 -0
- package/dist/consumers/receiveRoomMessages.d.ts +31 -0
- package/dist/consumers/receiveRoomMessages.d.ts.map +1 -0
- package/dist/consumers/reorderStreams.d.ts +98 -0
- package/dist/consumers/reorderStreams.d.ts.map +1 -0
- package/dist/consumers/requestScreenShare.d.ts +47 -0
- package/dist/consumers/requestScreenShare.d.ts.map +1 -0
- package/dist/consumers/resumePauseAudioStreams.d.ts +85 -0
- package/dist/consumers/resumePauseAudioStreams.d.ts.map +1 -0
- package/dist/consumers/resumePauseStreams.d.ts +68 -0
- package/dist/consumers/resumePauseStreams.d.ts.map +1 -0
- package/dist/consumers/resumeSendTransportAudio.d.ts +65 -0
- package/dist/consumers/resumeSendTransportAudio.d.ts.map +1 -0
- package/dist/consumers/signalNewConsumerTransport.d.ts +59 -0
- package/dist/consumers/signalNewConsumerTransport.d.ts.map +1 -0
- package/dist/consumers/socketReceiveMethods/joinConsumeRoom.d.ts +76 -0
- package/dist/consumers/socketReceiveMethods/joinConsumeRoom.d.ts.map +1 -0
- package/dist/consumers/socketReceiveMethods/newPipeProducer.d.ts +119 -0
- package/dist/consumers/socketReceiveMethods/newPipeProducer.d.ts.map +1 -0
- package/dist/consumers/socketReceiveMethods/producerClosed.d.ts +53 -0
- package/dist/consumers/socketReceiveMethods/producerClosed.d.ts.map +1 -0
- package/dist/consumers/startShareScreen.d.ts +58 -0
- package/dist/consumers/startShareScreen.d.ts.map +1 -0
- package/dist/consumers/stopShareScreen.d.ts +127 -0
- package/dist/consumers/stopShareScreen.d.ts.map +1 -0
- package/dist/consumers/streamSuccessAudio.d.ts +149 -0
- package/dist/consumers/streamSuccessAudio.d.ts.map +1 -0
- package/dist/consumers/streamSuccessAudioSwitch.d.ts +131 -0
- package/dist/consumers/streamSuccessAudioSwitch.d.ts.map +1 -0
- package/dist/consumers/streamSuccessScreen.d.ts +109 -0
- package/dist/consumers/streamSuccessScreen.d.ts.map +1 -0
- package/dist/consumers/streamSuccessVideo.d.ts +160 -0
- package/dist/consumers/streamSuccessVideo.d.ts.map +1 -0
- package/dist/consumers/switchUserAudio.d.ts +56 -0
- package/dist/consumers/switchUserAudio.d.ts.map +1 -0
- package/dist/consumers/switchUserVideo.d.ts +77 -0
- package/dist/consumers/switchUserVideo.d.ts.map +1 -0
- package/dist/consumers/switchUserVideoAlt.d.ts +69 -0
- package/dist/consumers/switchUserVideoAlt.d.ts.map +1 -0
- package/dist/consumers/translationConsumerSwitch.d.ts +67 -0
- package/dist/consumers/translationConsumerSwitch.d.ts.map +1 -0
- package/dist/consumers/trigger.d.ts +71 -0
- package/dist/consumers/trigger.d.ts.map +1 -0
- package/dist/consumers/updateMiniCardsGrid.d.ts +65 -0
- package/dist/consumers/updateMiniCardsGrid.d.ts.map +1 -0
- package/dist/consumers/updateParticipantAudioDecibels.d.ts +31 -0
- package/dist/consumers/updateParticipantAudioDecibels.d.ts.map +1 -0
- package/dist/getParticipantMedia-B0JS6d2b.js +3555 -0
- package/dist/getParticipantMedia-B0JS6d2b.js.map +1 -0
- package/dist/getParticipantMedia-CdcYqcbD.cjs +3554 -0
- package/dist/getParticipantMedia-CdcYqcbD.cjs.map +1 -0
- package/dist/index.cjs +2727 -13252
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +192 -11233
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2636 -13143
- package/dist/index.js.map +1 -1
- package/dist/index.native.cjs +352 -0
- package/dist/index.native.cjs.map +1 -0
- package/dist/index.native.d.ts +204 -0
- package/dist/index.native.d.ts.map +1 -0
- package/dist/index.native.js +352 -0
- package/dist/index.native.js.map +1 -0
- package/dist/joinLocalRoom-BdM1msQt.cjs +673 -0
- package/dist/joinLocalRoom-BdM1msQt.cjs.map +1 -0
- package/dist/joinLocalRoom-CvteNe4R.js +657 -0
- package/dist/joinLocalRoom-CvteNe4R.js.map +1 -0
- package/dist/joinRoomOnMediaSFU-CC8RVJgr.cjs +1222 -0
- package/dist/joinRoomOnMediaSFU-CC8RVJgr.cjs.map +1 -0
- package/dist/joinRoomOnMediaSFU-y6vJ1OBo.js +1223 -0
- package/dist/joinRoomOnMediaSFU-y6vJ1OBo.js.map +1 -0
- package/dist/methods/background/launchBackground.d.ts +10 -0
- package/dist/methods/background/launchBackground.d.ts.map +1 -0
- package/dist/methods/breakoutRooms/breakoutRoomUpdated.d.ts +67 -0
- package/dist/methods/breakoutRooms/breakoutRoomUpdated.d.ts.map +1 -0
- package/dist/methods/breakoutRooms/handleStartBreakout.d.ts +42 -0
- package/dist/methods/breakoutRooms/handleStartBreakout.d.ts.map +1 -0
- package/dist/methods/breakoutRooms/handleStopBreakout.d.ts +33 -0
- package/dist/methods/breakoutRooms/handleStopBreakout.d.ts.map +1 -0
- package/dist/methods/breakoutRooms/index.d.ts +5 -0
- package/dist/methods/breakoutRooms/index.d.ts.map +1 -0
- package/dist/methods/breakoutRooms/launchBreakoutRooms.d.ts +25 -0
- package/dist/methods/breakoutRooms/launchBreakoutRooms.d.ts.map +1 -0
- package/dist/methods/coHost/launchCoHost.d.ts +25 -0
- package/dist/methods/coHost/launchCoHost.d.ts.map +1 -0
- package/dist/methods/coHostMethods/index.d.ts +3 -0
- package/dist/methods/coHostMethods/index.d.ts.map +1 -0
- package/dist/methods/coHostMethods/modifyCoHostSettings.d.ts +49 -0
- package/dist/methods/coHostMethods/modifyCoHostSettings.d.ts.map +1 -0
- package/dist/methods/displaySettings/index.d.ts +2 -0
- package/dist/methods/displaySettings/index.d.ts.map +1 -0
- package/dist/methods/displaySettings/launchDisplaySettings.d.ts +25 -0
- package/dist/methods/displaySettings/launchDisplaySettings.d.ts.map +1 -0
- package/dist/methods/displaySettings/modifyDisplaySettings.d.ts +106 -0
- package/dist/methods/displaySettings/modifyDisplaySettings.d.ts.map +1 -0
- package/dist/methods/exit/confirmExit.d.ts +38 -0
- package/dist/methods/exit/confirmExit.d.ts.map +1 -0
- package/dist/methods/exit/index.d.ts +3 -0
- package/dist/methods/exit/index.d.ts.map +1 -0
- package/dist/methods/exit/launchConfirmExit.d.ts +23 -0
- package/dist/methods/exit/launchConfirmExit.d.ts.map +1 -0
- package/dist/methods/index.cjs +3975 -0
- package/dist/methods/index.cjs.map +1 -0
- package/dist/methods/index.d.ts +66 -0
- package/dist/methods/index.d.ts.map +1 -0
- package/dist/methods/index.js +3976 -0
- package/dist/methods/index.js.map +1 -0
- package/dist/methods/mediaSettings/launchMediaSettings.d.ts +38 -0
- package/dist/methods/mediaSettings/launchMediaSettings.d.ts.map +1 -0
- package/dist/methods/menu/launchMenuModal.d.ts +22 -0
- package/dist/methods/menu/launchMenuModal.d.ts.map +1 -0
- package/dist/methods/message/index.d.ts +2 -0
- package/dist/methods/message/index.d.ts.map +1 -0
- package/dist/methods/message/launchMessages.d.ts +24 -0
- package/dist/methods/message/launchMessages.d.ts.map +1 -0
- package/dist/methods/message/sendMessage.d.ts +63 -0
- package/dist/methods/message/sendMessage.d.ts.map +1 -0
- package/dist/methods/panelists/focusPanelists.d.ts +24 -0
- package/dist/methods/panelists/focusPanelists.d.ts.map +1 -0
- package/dist/methods/panelists/index.d.ts +4 -0
- package/dist/methods/panelists/index.d.ts.map +1 -0
- package/dist/methods/panelists/launchPanelists.d.ts +7 -0
- package/dist/methods/panelists/launchPanelists.d.ts.map +1 -0
- package/dist/methods/panelists/updatePanelists.d.ts +35 -0
- package/dist/methods/panelists/updatePanelists.d.ts.map +1 -0
- package/dist/methods/participants/index.d.ts +4 -0
- package/dist/methods/participants/index.d.ts.map +1 -0
- package/dist/methods/participants/launchParticipants.d.ts +22 -0
- package/dist/methods/participants/launchParticipants.d.ts.map +1 -0
- package/dist/methods/participants/messageParticipants.d.ts +43 -0
- package/dist/methods/participants/messageParticipants.d.ts.map +1 -0
- package/dist/methods/participants/muteParticipants.d.ts +41 -0
- package/dist/methods/participants/muteParticipants.d.ts.map +1 -0
- package/dist/methods/participants/removeParticipants.d.ts +47 -0
- package/dist/methods/participants/removeParticipants.d.ts.map +1 -0
- package/dist/methods/permissions/index.d.ts +4 -0
- package/dist/methods/permissions/index.d.ts.map +1 -0
- package/dist/methods/permissions/launchPermissions.d.ts +7 -0
- package/dist/methods/permissions/launchPermissions.d.ts.map +1 -0
- package/dist/methods/permissions/updateParticipantPermission.d.ts +25 -0
- package/dist/methods/permissions/updateParticipantPermission.d.ts.map +1 -0
- package/dist/methods/permissions/updatePermissionConfig.d.ts +22 -0
- package/dist/methods/permissions/updatePermissionConfig.d.ts.map +1 -0
- package/dist/methods/polls/handleCreatePoll.d.ts +39 -0
- package/dist/methods/polls/handleCreatePoll.d.ts.map +1 -0
- package/dist/methods/polls/handleEndPoll.d.ts +34 -0
- package/dist/methods/polls/handleEndPoll.d.ts.map +1 -0
- package/dist/methods/polls/handleVotePoll.d.ts +39 -0
- package/dist/methods/polls/handleVotePoll.d.ts.map +1 -0
- package/dist/methods/polls/index.d.ts +4 -0
- package/dist/methods/polls/index.d.ts.map +1 -0
- package/dist/methods/polls/launchPoll.d.ts +22 -0
- package/dist/methods/polls/launchPoll.d.ts.map +1 -0
- package/dist/methods/polls/pollUpdated.d.ts +38 -0
- package/dist/methods/polls/pollUpdated.d.ts.map +1 -0
- package/dist/methods/prejoin/handleCreateRoom.d.ts +77 -0
- package/dist/methods/prejoin/handleCreateRoom.d.ts.map +1 -0
- package/dist/methods/prejoin/handleJoinRoom.d.ts +56 -0
- package/dist/methods/prejoin/handleJoinRoom.d.ts.map +1 -0
- package/dist/methods/prejoin/index.d.ts +5 -0
- package/dist/methods/prejoin/index.d.ts.map +1 -0
- package/dist/methods/recording/checkPauseState.d.ts +34 -0
- package/dist/methods/recording/checkPauseState.d.ts.map +1 -0
- package/dist/methods/recording/checkResumeState.d.ts +30 -0
- package/dist/methods/recording/checkResumeState.d.ts.map +1 -0
- package/dist/methods/recording/confirmRecording.d.ts +46 -0
- package/dist/methods/recording/confirmRecording.d.ts.map +1 -0
- package/dist/methods/recording/launchRecording.d.ts +56 -0
- package/dist/methods/recording/launchRecording.d.ts.map +1 -0
- package/dist/methods/recording/recordPauseTimer.d.ts +31 -0
- package/dist/methods/recording/recordPauseTimer.d.ts.map +1 -0
- package/dist/methods/recording/recordResumeTimer.d.ts +29 -0
- package/dist/methods/recording/recordResumeTimer.d.ts.map +1 -0
- package/dist/methods/recording/recordStartTimer.d.ts +45 -0
- package/dist/methods/recording/recordStartTimer.d.ts.map +1 -0
- package/dist/methods/recording/recordUpdateTimer.d.ts +29 -0
- package/dist/methods/recording/recordUpdateTimer.d.ts.map +1 -0
- package/dist/methods/recording/startRecording.d.ts +122 -0
- package/dist/methods/recording/startRecording.d.ts.map +1 -0
- package/dist/methods/recording/stopRecording.d.ts +36 -0
- package/dist/methods/recording/stopRecording.d.ts.map +1 -0
- package/dist/methods/recording/timeLeftRecording.d.ts +13 -0
- package/dist/methods/recording/timeLeftRecording.d.ts.map +1 -0
- package/dist/methods/recording/updateRecording.d.ts +49 -0
- package/dist/methods/recording/updateRecording.d.ts.map +1 -0
- package/dist/methods/requests/hostRequestResponse.d.ts +33 -0
- package/dist/methods/requests/hostRequestResponse.d.ts.map +1 -0
- package/dist/methods/requests/index.d.ts +2 -0
- package/dist/methods/requests/index.d.ts.map +1 -0
- package/dist/methods/requests/launchRequests.d.ts +22 -0
- package/dist/methods/requests/launchRequests.d.ts.map +1 -0
- package/dist/methods/requests/respondToRequests.d.ts +38 -0
- package/dist/methods/requests/respondToRequests.d.ts.map +1 -0
- package/dist/methods/settings/index.d.ts +3 -0
- package/dist/methods/settings/index.d.ts.map +1 -0
- package/dist/methods/settings/launchSettings.d.ts +22 -0
- package/dist/methods/settings/launchSettings.d.ts.map +1 -0
- package/dist/methods/settings/modifySettings.d.ts +45 -0
- package/dist/methods/settings/modifySettings.d.ts.map +1 -0
- package/dist/methods/socketReceive/allMembers.d.ts +117 -0
- package/dist/methods/socketReceive/allMembers.d.ts.map +1 -0
- package/dist/methods/socketReceive/allMembersRest.d.ts +122 -0
- package/dist/methods/socketReceive/allMembersRest.d.ts.map +1 -0
- package/dist/methods/socketReceive/allWaitingRoomMembers.d.ts +24 -0
- package/dist/methods/socketReceive/allWaitingRoomMembers.d.ts.map +1 -0
- package/dist/methods/socketReceive/banParticipant.d.ts +44 -0
- package/dist/methods/socketReceive/banParticipant.d.ts.map +1 -0
- package/dist/methods/socketReceive/controlMediaHost.d.ts +62 -0
- package/dist/methods/socketReceive/controlMediaHost.d.ts.map +1 -0
- package/dist/methods/socketReceive/disconnect.d.ts +24 -0
- package/dist/methods/socketReceive/disconnect.d.ts.map +1 -0
- package/dist/methods/socketReceive/disconnectUserSelf.d.ts +29 -0
- package/dist/methods/socketReceive/disconnectUserSelf.d.ts.map +1 -0
- package/dist/methods/socketReceive/getDomains.d.ts +48 -0
- package/dist/methods/socketReceive/getDomains.d.ts.map +1 -0
- package/dist/methods/socketReceive/meetingEnded.d.ts +27 -0
- package/dist/methods/socketReceive/meetingEnded.d.ts.map +1 -0
- package/dist/methods/socketReceive/meetingStillThere.d.ts +19 -0
- package/dist/methods/socketReceive/meetingStillThere.d.ts.map +1 -0
- package/dist/methods/socketReceive/panelistReceiveMethods.d.ts +66 -0
- package/dist/methods/socketReceive/panelistReceiveMethods.d.ts.map +1 -0
- package/dist/methods/socketReceive/participantRequested.d.ts +28 -0
- package/dist/methods/socketReceive/participantRequested.d.ts.map +1 -0
- package/dist/methods/socketReceive/permissionReceiveMethods.d.ts +23 -0
- package/dist/methods/socketReceive/permissionReceiveMethods.d.ts.map +1 -0
- package/dist/methods/socketReceive/personJoined.d.ts +24 -0
- package/dist/methods/socketReceive/personJoined.d.ts.map +1 -0
- package/dist/methods/socketReceive/producerMediaClosed.d.ts +66 -0
- package/dist/methods/socketReceive/producerMediaClosed.d.ts.map +1 -0
- package/dist/methods/socketReceive/producerMediaPaused.d.ts +70 -0
- package/dist/methods/socketReceive/producerMediaPaused.d.ts.map +1 -0
- package/dist/methods/socketReceive/producerMediaResumed.d.ts +53 -0
- package/dist/methods/socketReceive/producerMediaResumed.d.ts.map +1 -0
- package/dist/methods/socketReceive/reInitiateRecording.d.ts +33 -0
- package/dist/methods/socketReceive/reInitiateRecording.d.ts.map +1 -0
- package/dist/methods/socketReceive/receiveMessage.d.ts +36 -0
- package/dist/methods/socketReceive/receiveMessage.d.ts.map +1 -0
- package/dist/methods/socketReceive/recordingNotice.d.ts +98 -0
- package/dist/methods/socketReceive/recordingNotice.d.ts.map +1 -0
- package/dist/methods/socketReceive/roomRecordParams.d.ts +60 -0
- package/dist/methods/socketReceive/roomRecordParams.d.ts.map +1 -0
- package/dist/methods/socketReceive/screenProducerId.d.ts +36 -0
- package/dist/methods/socketReceive/screenProducerId.d.ts.map +1 -0
- package/dist/methods/socketReceive/startRecords.d.ts +31 -0
- package/dist/methods/socketReceive/startRecords.d.ts.map +1 -0
- package/dist/methods/socketReceive/stoppedRecording.d.ts +24 -0
- package/dist/methods/socketReceive/stoppedRecording.d.ts.map +1 -0
- package/dist/methods/socketReceive/translationReceiveMethods.d.ts +227 -0
- package/dist/methods/socketReceive/translationReceiveMethods.d.ts.map +1 -0
- package/dist/methods/socketReceive/updateConsumingDomains.d.ts +60 -0
- package/dist/methods/socketReceive/updateConsumingDomains.d.ts.map +1 -0
- package/dist/methods/socketReceive/updateMediaSettings.d.ts +28 -0
- package/dist/methods/socketReceive/updateMediaSettings.d.ts.map +1 -0
- package/dist/methods/socketReceive/updatedCoHost.d.ts +38 -0
- package/dist/methods/socketReceive/updatedCoHost.d.ts.map +1 -0
- package/dist/methods/socketReceive/userWaiting.d.ts +30 -0
- package/dist/methods/socketReceive/userWaiting.d.ts.map +1 -0
- package/dist/methods/stream/clickAudio.d.ts +71 -0
- package/dist/methods/stream/clickAudio.d.ts.map +1 -0
- package/dist/methods/stream/clickChat.d.ts +11 -0
- package/dist/methods/stream/clickChat.d.ts.map +1 -0
- package/dist/methods/stream/clickScreenShare.d.ts +45 -0
- package/dist/methods/stream/clickScreenShare.d.ts.map +1 -0
- package/dist/methods/stream/clickVideo.d.ts +101 -0
- package/dist/methods/stream/clickVideo.d.ts.map +1 -0
- package/dist/methods/stream/index.d.ts +5 -0
- package/dist/methods/stream/index.d.ts.map +1 -0
- package/dist/methods/stream/switchAudio.d.ts +40 -0
- package/dist/methods/stream/switchAudio.d.ts.map +1 -0
- package/dist/methods/stream/switchVideo.d.ts +56 -0
- package/dist/methods/stream/switchVideo.d.ts.map +1 -0
- package/dist/methods/stream/switchVideoAlt.d.ts +55 -0
- package/dist/methods/stream/switchVideoAlt.d.ts.map +1 -0
- package/dist/methods/utils/SoundPlayer.d.ts +19 -0
- package/dist/methods/utils/SoundPlayer.d.ts.map +1 -0
- package/dist/methods/utils/checkLimitsAndMakeRequest.d.ts +30 -0
- package/dist/methods/utils/checkLimitsAndMakeRequest.d.ts.map +1 -0
- package/dist/methods/utils/createResponseJoinRoom.d.ts +24 -0
- package/dist/methods/utils/createResponseJoinRoom.d.ts.map +1 -0
- package/dist/methods/utils/createRoomOnMediaSFU.d.ts +28 -0
- package/dist/methods/utils/createRoomOnMediaSFU.d.ts.map +1 -0
- package/dist/methods/utils/formatNumber.d.ts +21 -0
- package/dist/methods/utils/formatNumber.d.ts.map +1 -0
- package/dist/methods/utils/generateRandomMessages.d.ts +11 -0
- package/dist/methods/utils/generateRandomMessages.d.ts.map +1 -0
- package/dist/methods/utils/generateRandomParticipants.d.ts +10 -0
- package/dist/methods/utils/generateRandomParticipants.d.ts.map +1 -0
- package/dist/methods/utils/generateRandomPolls.d.ts +7 -0
- package/dist/methods/utils/generateRandomPolls.d.ts.map +1 -0
- package/dist/methods/utils/generateRandomRequestList.d.ts +10 -0
- package/dist/methods/utils/generateRandomRequestList.d.ts.map +1 -0
- package/dist/methods/utils/generateRandomWaitingRoomList.d.ts +4 -0
- package/dist/methods/utils/generateRandomWaitingRoomList.d.ts.map +1 -0
- package/dist/methods/utils/getModalPosition.d.ts +7 -0
- package/dist/methods/utils/getModalPosition.d.ts.map +1 -0
- package/dist/methods/utils/getOverlayPosition.d.ts +22 -0
- package/dist/methods/utils/getOverlayPosition.d.ts.map +1 -0
- package/dist/methods/utils/getParticipantMedia.d.ts +55 -0
- package/dist/methods/utils/getParticipantMedia.d.ts.map +1 -0
- package/dist/methods/utils/headless/getCurrentParams.d.ts +27 -0
- package/dist/methods/utils/headless/getCurrentParams.d.ts.map +1 -0
- package/dist/methods/utils/headless/getMediaStreams.d.ts +96 -0
- package/dist/methods/utils/headless/getMediaStreams.d.ts.map +1 -0
- package/dist/methods/utils/headless/getRoomReadiness.d.ts +25 -0
- package/dist/methods/utils/headless/getRoomReadiness.d.ts.map +1 -0
- package/dist/methods/utils/headless/headlessTypes.d.ts +89 -0
- package/dist/methods/utils/headless/headlessTypes.d.ts.map +1 -0
- package/dist/methods/utils/headless/index.d.ts +29 -0
- package/dist/methods/utils/headless/index.d.ts.map +1 -0
- package/dist/methods/utils/headless/mediaPermissions.d.ts +53 -0
- package/dist/methods/utils/headless/mediaPermissions.d.ts.map +1 -0
- package/dist/methods/utils/headless/mediaProduction.d.ts +177 -0
- package/dist/methods/utils/headless/mediaProduction.d.ts.map +1 -0
- package/dist/methods/utils/headless/moderation.d.ts +157 -0
- package/dist/methods/utils/headless/moderation.d.ts.map +1 -0
- package/dist/methods/utils/headless/participantState.d.ts +128 -0
- package/dist/methods/utils/headless/participantState.d.ts.map +1 -0
- package/dist/methods/utils/headless/playback.d.ts +106 -0
- package/dist/methods/utils/headless/playback.d.ts.map +1 -0
- package/dist/methods/utils/headless/roomActions.d.ts +88 -0
- package/dist/methods/utils/headless/roomActions.d.ts.map +1 -0
- package/dist/methods/utils/headless/sessionControls.d.ts +159 -0
- package/dist/methods/utils/headless/sessionControls.d.ts.map +1 -0
- package/dist/methods/utils/headless/sessionExtras.d.ts +291 -0
- package/dist/methods/utils/headless/sessionExtras.d.ts.map +1 -0
- package/dist/methods/utils/headless/sessionFeatures.d.ts +159 -0
- package/dist/methods/utils/headless/sessionFeatures.d.ts.map +1 -0
- package/dist/methods/utils/headless/viewerSession.d.ts +125 -0
- package/dist/methods/utils/headless/viewerSession.d.ts.map +1 -0
- package/dist/methods/utils/headless/virtualBackground.d.ts +72 -0
- package/dist/methods/utils/headless/virtualBackground.d.ts.map +1 -0
- package/dist/methods/utils/initialValuesState.d.ts +388 -0
- package/dist/methods/utils/initialValuesState.d.ts.map +1 -0
- package/dist/methods/utils/joinRoomOnMediaSFU.d.ts +56 -0
- package/dist/methods/utils/joinRoomOnMediaSFU.d.ts.map +1 -0
- package/dist/methods/utils/liveSubtitle.d.ts +36 -0
- package/dist/methods/utils/liveSubtitle.d.ts.map +1 -0
- package/dist/methods/utils/meetingTimeRemaining.d.ts +15 -0
- package/dist/methods/utils/meetingTimeRemaining.d.ts.map +1 -0
- package/dist/methods/utils/meetingTimer/startMeetingProgressTimer.d.ts +35 -0
- package/dist/methods/utils/meetingTimer/startMeetingProgressTimer.d.ts.map +1 -0
- package/dist/methods/utils/producer/aParams.d.ts +3 -0
- package/dist/methods/utils/producer/aParams.d.ts.map +1 -0
- package/dist/methods/utils/producer/hParams.d.ts +3 -0
- package/dist/methods/utils/producer/hParams.d.ts.map +1 -0
- package/dist/methods/utils/producer/screenParams.d.ts +3 -0
- package/dist/methods/utils/producer/screenParams.d.ts.map +1 -0
- package/dist/methods/utils/producer/vParams.d.ts +3 -0
- package/dist/methods/utils/producer/vParams.d.ts.map +1 -0
- package/dist/methods/utils/producer/videoCaptureConstraints.d.ts +145 -0
- package/dist/methods/utils/producer/videoCaptureConstraints.d.ts.map +1 -0
- package/dist/methods/utils/resolveMediaSFURoomApi.d.ts +4 -0
- package/dist/methods/utils/resolveMediaSFURoomApi.d.ts.map +1 -0
- package/dist/methods/utils/sleep.d.ts +21 -0
- package/dist/methods/utils/sleep.d.ts.map +1 -0
- package/dist/methods/utils/translationLanguages.d.ts +100 -0
- package/dist/methods/utils/translationLanguages.d.ts.map +1 -0
- package/dist/methods/utils/validateAlphanumeric.d.ts +21 -0
- package/dist/methods/utils/validateAlphanumeric.d.ts.map +1 -0
- package/dist/methods/utils/virtualBackgroundCompositor.d.ts +21 -0
- package/dist/methods/utils/virtualBackgroundCompositor.d.ts.map +1 -0
- package/dist/methods/utils/webrtc.d.ts +18 -0
- package/dist/methods/utils/webrtc.d.ts.map +1 -0
- package/dist/methods/waiting/index.d.ts +2 -0
- package/dist/methods/waiting/index.d.ts.map +1 -0
- package/dist/methods/waiting/launchWaiting.d.ts +23 -0
- package/dist/methods/waiting/launchWaiting.d.ts.map +1 -0
- package/dist/methods/waiting/respondToWaiting.d.ts +40 -0
- package/dist/methods/waiting/respondToWaiting.d.ts.map +1 -0
- package/dist/methods/welcome/handleWelcomeRequest.d.ts +47 -0
- package/dist/methods/welcome/handleWelcomeRequest.d.ts.map +1 -0
- package/dist/methods/welcome/index.d.ts +3 -0
- package/dist/methods/welcome/index.d.ts.map +1 -0
- package/dist/methods/whiteboard/captureCanvasStream.d.ts +38 -0
- package/dist/methods/whiteboard/captureCanvasStream.d.ts.map +1 -0
- package/dist/methods/whiteboard/handleStartWhiteboard.d.ts +31 -0
- package/dist/methods/whiteboard/handleStartWhiteboard.d.ts.map +1 -0
- package/dist/methods/whiteboard/handleStopWhiteboard.d.ts +25 -0
- package/dist/methods/whiteboard/handleStopWhiteboard.d.ts.map +1 -0
- package/dist/methods/whiteboard/index.d.ts +5 -0
- package/dist/methods/whiteboard/index.d.ts.map +1 -0
- package/dist/methods/whiteboard/launchConfigureWhiteboard.d.ts +23 -0
- package/dist/methods/whiteboard/launchConfigureWhiteboard.d.ts.map +1 -0
- package/dist/producers/producerEmits/joinConRoom.d.ts +54 -0
- package/dist/producers/producerEmits/joinConRoom.d.ts.map +1 -0
- package/dist/producers/producerEmits/joinLocalRoom.d.ts +30 -0
- package/dist/producers/producerEmits/joinLocalRoom.d.ts.map +1 -0
- package/dist/producers/producerEmits/joinRoom.d.ts +35 -0
- package/dist/producers/producerEmits/joinRoom.d.ts.map +1 -0
- package/dist/readme/mediasfu-platform-capabilities.webp +0 -0
- package/dist/sockets/SocketManager.d.ts +102 -0
- package/dist/sockets/SocketManager.d.ts.map +1 -0
- package/dist/translationConsumerSwitch-C20MfNNq.cjs +509 -0
- package/dist/translationConsumerSwitch-C20MfNNq.cjs.map +1 -0
- package/dist/translationConsumerSwitch-zKuS5wgH.js +510 -0
- package/dist/translationConsumerSwitch-zKuS5wgH.js.map +1 -0
- package/dist/types/index.cjs +85 -0
- package/dist/types/index.cjs.map +1 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +85 -0
- package/dist/types/index.js.map +1 -0
- package/dist/types/shared-base-types.d.ts +656 -0
- package/dist/types/shared-base-types.d.ts.map +1 -0
- package/dist/types/types.d.ts +124 -0
- package/dist/types/types.d.ts.map +1 -0
- package/dist/updateParticipantAudioDecibels-DLd8Y-Fh.js +5392 -0
- package/dist/updateParticipantAudioDecibels-DLd8Y-Fh.js.map +1 -0
- package/dist/updateParticipantAudioDecibels-DPmHiy3K.cjs +5391 -0
- package/dist/updateParticipantAudioDecibels-DPmHiy3K.cjs.map +1 -0
- package/dist/validateAlphanumeric-DKn5BsUP.cjs +15 -0
- package/dist/validateAlphanumeric-DKn5BsUP.cjs.map +1 -0
- package/dist/validateAlphanumeric-Dk1JB80W.js +16 -0
- package/dist/validateAlphanumeric-Dk1JB80W.js.map +1 -0
- package/package.json +106 -99
- package/src/ProducerClient/producerClientEmits/createDeviceClient.ts +1 -2
- package/src/ProducerClient/producerClientEmits/updateRoomParametersClient.ts +1 -1
- package/src/consumers/connectIps.ts +1 -1
- package/src/consumers/connectRecvTransport.ts +1 -1
- package/src/consumers/connectSendTransport.ts +1 -1
- package/src/consumers/connectSendTransportAudio.ts +1 -1
- package/src/consumers/connectSendTransportScreen.ts +5 -2
- package/src/consumers/connectSendTransportVideo.ts +1 -1
- package/src/consumers/createSendTransport.ts +34 -29
- package/src/consumers/disconnectSendTransportAudio.ts +1 -1
- package/src/consumers/disconnectSendTransportScreen.ts +1 -1
- package/src/consumers/disconnectSendTransportVideo.ts +1 -1
- package/src/consumers/index.ts +61 -0
- package/src/consumers/resumeSendTransportAudio.ts +1 -1
- package/src/consumers/signalNewConsumerTransport.ts +1 -2
- package/src/consumers/socketReceiveMethods/joinConsumeRoom.ts +1 -1
- package/src/consumers/socketReceiveMethods/newPipeProducer.ts +1 -1
- package/src/consumers/streamSuccessAudio.ts +1 -2
- package/src/consumers/streamSuccessAudioSwitch.ts +1 -2
- package/src/consumers/streamSuccessVideo.ts +35 -6
- package/src/index.native.ts +24 -1
- package/src/index.ts +7 -0
- package/src/methods/exit/confirmExit.ts +11 -4
- package/src/methods/socketReceive/getDomains.ts +1 -1
- package/src/methods/utils/getParticipantMedia.ts +112 -0
- package/src/methods/utils/headless/getCurrentParams.ts +44 -0
- package/src/methods/utils/headless/getMediaStreams.ts +256 -0
- package/src/methods/utils/headless/getRoomReadiness.ts +49 -0
- package/src/methods/utils/headless/headlessTypes.ts +102 -0
- package/src/methods/utils/headless/index.ts +28 -0
- package/src/methods/utils/headless/mediaPermissions.ts +124 -0
- package/src/methods/utils/headless/mediaProduction.ts +505 -0
- package/src/methods/utils/headless/moderation.ts +455 -0
- package/src/methods/utils/headless/participantState.ts +254 -0
- package/src/methods/utils/headless/playback.ts +336 -0
- package/src/methods/utils/headless/roomActions.ts +230 -0
- package/src/methods/utils/headless/sessionControls.ts +335 -0
- package/src/methods/utils/headless/sessionExtras.ts +593 -0
- package/src/methods/utils/headless/sessionFeatures.ts +480 -0
- package/src/methods/utils/headless/viewerSession.ts +246 -0
- package/src/methods/utils/headless/virtualBackground.ts +280 -0
- package/src/methods/utils/resolveMediaSFURoomApi.ts +2 -2
- package/src/methods/utils/virtualBackgroundCompositor.ts +53 -0
- package/src/methods/whiteboard/captureCanvasStream.ts +2 -2
- package/src/producers/producerEmits/joinConRoom.ts +1 -1
- package/src/producers/producerEmits/joinRoom.ts +1 -1
- package/src/types/index.ts +1 -0
- package/src/types/shared-base-types.ts +2 -3
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"moderation.d.ts","sourceRoot":"","sources":["../../../../src/methods/utils/headless/moderation.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAsB,MAAM,iBAAiB,CAAC;AAEtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD,2DAA2D;AAC3D,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,cAAc,GAAG,MAAM,GAAG,SAAS,CAAC;AAE3E,MAAM,WAAW,qBAAqB;IACpC,0DAA0D;IAC1D,MAAM,EAAE,OAAO,CAAC;IAChB,sDAAsD;IACtD,QAAQ,EAAE,OAAO,CAAC;IAClB,sDAAsD;IACtD,eAAe,EAAE,OAAO,CAAC;IACzB,kCAAkC;IAClC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,qBAAqB;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,gDAAgD;IAChD,oBAAoB,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,MAAM,4BAA4B,GAAG,CACzC,OAAO,EAAE,eAAe,KACrB,qBAAqB,CAAC;AAY3B;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,UAAU,GACX,EAAE,eAAe,GAAG,qBAAqB,CAczC;AAqBD,MAAM,WAAW,0BAA2B,SAAQ,eAAe;IACjE,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,iCAAiC;IACjC,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,aAAa,GAAG,KAAK,CAAC;CACjD;AAED,MAAM,MAAM,uBAAuB,GAAG,CACpC,OAAO,EAAE,0BAA0B,KAChC,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,UAAU,EACV,IAAS,EACT,EAAO,EACP,IAAI,GACL,EAAE,0BAA0B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA8B5D;AAED,MAAM,WAAW,0BAA2B,SAAQ,eAAe;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,wEAAwE;AACxE,wBAAgB,eAAe,CAC7B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAED,wEAAwE;AACxE,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAED,0EAA0E;AAC1E,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAED,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,mEAAmE;IACnE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,aAAa,GAAG,KAAK,CAAC;CAClD;AAED,MAAM,MAAM,gBAAgB,GAAG,CAC7B,OAAO,EAAE,mBAAmB,KACzB,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,EACjC,UAAU,EACV,IAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAwBrD;AAED,MAAM,MAAM,qBAAqB,GAAG,CAClC,OAAO,EAAE,0BAA0B,KAChC,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,UAAU,EACV,IAAS,EACT,EAAO,GACR,EAAE,0BAA0B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA4B5D;AAED,MAAM,WAAW,kCAAmC,SAAQ,eAAe;IACzE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,+BAA+B,GAAG,CAC5C,OAAO,EAAE,kCAAkC,KACxC,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;;;;;;;GAYG;AACH,wBAAsB,2BAA2B,CAAC,EAChD,UAAU,EACV,IAAS,EACT,EAAO,EACP,KAAK,GACN,EAAE,kCAAkC,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA6BpE;AAED,MAAM,WAAW,kCAAmC,SAAQ,eAAe;IACzE,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,+BAA+B,GAAG,CAC5C,OAAO,EAAE,kCAAkC,KACxC,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;GAIG;AACH,wBAAsB,2BAA2B,CAAC,EAChD,UAAU,EACV,SAAc,EACd,IAAS,EACT,OAAO,GACR,EAAE,kCAAkC,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA+BpE;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;CAC1B;AAED,MAAM,MAAM,aAAa,GAAG,CAC1B,OAAO,EAAE,gBAAgB,KACtB,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;;;;;GAUG;AACH,wBAAsB,SAAS,CAAC,EAC9B,UAAU,EACV,IAAI,EACJ,KAAiC,GAClC,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA6BlD"}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { Participant } from '../../../types/types';
|
|
2
|
+
import { HeadlessOptions } from './headlessTypes';
|
|
3
|
+
export interface ParticipantMediaState {
|
|
4
|
+
participant: Participant | null;
|
|
5
|
+
/** The participant's own display name, or '' when unresolved. */
|
|
6
|
+
name: string;
|
|
7
|
+
/** True when this row is the local user. */
|
|
8
|
+
isSelf: boolean;
|
|
9
|
+
/** True when the participant is a host (islevel '2'). */
|
|
10
|
+
isHost: boolean;
|
|
11
|
+
/** True when the participant is publishing a camera. */
|
|
12
|
+
hasVideo: boolean;
|
|
13
|
+
/** True when the participant is publishing a microphone. */
|
|
14
|
+
hasAudio: boolean;
|
|
15
|
+
/** True when the participant's microphone is muted. */
|
|
16
|
+
muted: boolean;
|
|
17
|
+
/** The camera producer id, or '' when not publishing. */
|
|
18
|
+
videoProducerId: string;
|
|
19
|
+
/** The microphone producer id, or '' when not publishing. */
|
|
20
|
+
audioProducerId: string;
|
|
21
|
+
}
|
|
22
|
+
export interface GetParticipantMediaStateOptions extends HeadlessOptions {
|
|
23
|
+
/** Match by display name. */
|
|
24
|
+
name?: string;
|
|
25
|
+
/** Match by participant id. Takes precedence over `name`. */
|
|
26
|
+
id?: string;
|
|
27
|
+
}
|
|
28
|
+
export type GetParticipantMediaStateType = (options: GetParticipantMediaStateOptions) => ParticipantMediaState;
|
|
29
|
+
/**
|
|
30
|
+
* Whether a participant is publishing, and what to label them.
|
|
31
|
+
*
|
|
32
|
+
* "Is this person on camera?" is not `participant.muted` and not the presence of
|
|
33
|
+
* a stream in your grid — it is whether `videoID` holds a real producer
|
|
34
|
+
* reference. MediaSFU writes the string `'none'` rather than an empty value when
|
|
35
|
+
* there is no producer, which is why a naive truthiness check reports everyone
|
|
36
|
+
* as publishing.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* import { getParticipantMediaState } from 'mediasfu-shared';
|
|
41
|
+
*
|
|
42
|
+
* const paul = getParticipantMediaState({ parameters, name: 'Paul' });
|
|
43
|
+
* if (paul.hasVideo) renderCamera(paul.videoProducerId);
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
export declare function getParticipantMediaState({ parameters, name, id, }: GetParticipantMediaStateOptions): ParticipantMediaState;
|
|
47
|
+
export type ListParticipantMediaStatesType = (options: HeadlessOptions) => ParticipantMediaState[];
|
|
48
|
+
/** {@link getParticipantMediaState} for everyone currently in the room. */
|
|
49
|
+
export declare function listParticipantMediaStates({ parameters, }: HeadlessOptions): ParticipantMediaState[];
|
|
50
|
+
export interface ActiveSpeaker {
|
|
51
|
+
/** Loudest participant's display name, or '' when the room is quiet. */
|
|
52
|
+
name: string;
|
|
53
|
+
/** That participant's average loudness. */
|
|
54
|
+
level: number;
|
|
55
|
+
participant: Participant | null;
|
|
56
|
+
}
|
|
57
|
+
export type GetActiveSpeakerType = (options: HeadlessOptions) => ActiveSpeaker;
|
|
58
|
+
/**
|
|
59
|
+
* The loudest participant right now.
|
|
60
|
+
*
|
|
61
|
+
* Reads `audioDecibels`, which the SDK maintains per participant. MediaSFU's own
|
|
62
|
+
* grids treat roughly 127.5 as the noise floor, so quieter rooms report no
|
|
63
|
+
* active speaker rather than flickering between people.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* const speaker = getActiveSpeaker({ parameters });
|
|
68
|
+
* if (speaker.name) highlight(speaker.name);
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
export declare function getActiveSpeaker({ parameters }: HeadlessOptions): ActiveSpeaker;
|
|
72
|
+
export interface MediaDeviceList {
|
|
73
|
+
cameras: MediaDeviceInfo[];
|
|
74
|
+
microphones: MediaDeviceInfo[];
|
|
75
|
+
}
|
|
76
|
+
export type ListMediaDevicesType = (options: HeadlessOptions) => Promise<MediaDeviceList>;
|
|
77
|
+
/**
|
|
78
|
+
* Cameras and microphones available for a device picker.
|
|
79
|
+
*
|
|
80
|
+
* Uses the SDK's own `getMediaDevicesList` when the bag exposes it, so the
|
|
81
|
+
* result reflects the same `mediaDevices` instance the SDK captures with;
|
|
82
|
+
* otherwise falls back to `navigator.mediaDevices.enumerateDevices()`.
|
|
83
|
+
*
|
|
84
|
+
* Labels are blank until the user has granted permission once — call this after
|
|
85
|
+
* the first successful capture if you need readable device names.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```ts
|
|
89
|
+
* const { cameras } = await listMediaDevices({ parameters });
|
|
90
|
+
* await runMediaControl({
|
|
91
|
+
* parameters,
|
|
92
|
+
* control: 'switchVideo',
|
|
93
|
+
* extra: { videoPreference: cameras[1].deviceId },
|
|
94
|
+
* });
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
export declare function listMediaDevices({ parameters, }: HeadlessOptions): Promise<MediaDeviceList>;
|
|
98
|
+
export interface SelectedDevices {
|
|
99
|
+
/** Device id of the camera currently in use, or '' when none is selected. */
|
|
100
|
+
cameraId: string;
|
|
101
|
+
/** Device id of the microphone currently in use, or '' when none is selected. */
|
|
102
|
+
microphoneId: string;
|
|
103
|
+
/** Cameras the SDK has enumerated for this room. */
|
|
104
|
+
cameras: MediaDeviceInfo[];
|
|
105
|
+
/** Microphones the SDK has enumerated for this room. */
|
|
106
|
+
microphones: MediaDeviceInfo[];
|
|
107
|
+
}
|
|
108
|
+
export type GetSelectedDevicesType = (options: HeadlessOptions) => SelectedDevices;
|
|
109
|
+
/**
|
|
110
|
+
* Which camera and microphone the SDK is actually using, plus the device lists
|
|
111
|
+
* it has already enumerated.
|
|
112
|
+
*
|
|
113
|
+
* Unlike {@link listMediaDevices} this is synchronous and needs no permission
|
|
114
|
+
* prompt: it reads `userDefaultVideoInputDevice` / `userDefaultAudioInputDevice`
|
|
115
|
+
* and the `videoInputs` / `audioInputs` the SDK populated during setup. Use it
|
|
116
|
+
* to mark the current entry in a device picker; use `listMediaDevices` when you
|
|
117
|
+
* need a freshly enumerated list.
|
|
118
|
+
*
|
|
119
|
+
* @example
|
|
120
|
+
* ```tsx
|
|
121
|
+
* const { cameras, cameraId } = getSelectedDevices({ parameters });
|
|
122
|
+
* <select value={cameraId} onChange={(e) => room.controls.selectCamera(e.target.value)}>
|
|
123
|
+
* {cameras.map((d) => <option key={d.deviceId} value={d.deviceId}>{d.label}</option>)}
|
|
124
|
+
* </select>
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
export declare function getSelectedDevices({ parameters }: HeadlessOptions): SelectedDevices;
|
|
128
|
+
//# sourceMappingURL=participantState.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"participantState.d.ts","sourceRoot":"","sources":["../../../../src/methods/utils/headless/participantState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAsB,MAAM,iBAAiB,CAAC;AAkBtE,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,MAAM,EAAE,OAAO,CAAC;IAChB,yDAAyD;IACzD,MAAM,EAAE,OAAO,CAAC;IAChB,wDAAwD;IACxD,QAAQ,EAAE,OAAO,CAAC;IAClB,4DAA4D;IAC5D,QAAQ,EAAE,OAAO,CAAC;IAClB,uDAAuD;IACvD,KAAK,EAAE,OAAO,CAAC;IACf,yDAAyD;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,6DAA6D;IAC7D,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,+BAAgC,SAAQ,eAAe;IACtE,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,4BAA4B,GAAG,CACzC,OAAO,EAAE,+BAA+B,KACrC,qBAAqB,CAAC;AAE3B;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,UAAU,EACV,IAAS,EACT,EAAO,GACR,EAAE,+BAA+B,GAAG,qBAAqB,CA0BzD;AAED,MAAM,MAAM,8BAA8B,GAAG,CAC3C,OAAO,EAAE,eAAe,KACrB,qBAAqB,EAAE,CAAC;AAE7B,2EAA2E;AAC3E,wBAAgB,0BAA0B,CAAC,EACzC,UAAU,GACX,EAAE,eAAe,GAAG,qBAAqB,EAAE,CAS3C;AAED,MAAM,WAAW,aAAa;IAC5B,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,eAAe,KAAK,aAAa,CAAC;AAE/E;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,aAAa,CAkB/E;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,WAAW,EAAE,eAAe,EAAE,CAAC;CAChC;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,eAAe,KACrB,OAAO,CAAC,eAAe,CAAC,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,GACX,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAqB5C;AAED,MAAM,WAAW,eAAe;IAC9B,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,YAAY,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,wDAAwD;IACxD,WAAW,EAAE,eAAe,EAAE,CAAC;CAChC;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,EAAE,eAAe,KAAK,eAAe,CAAC;AAEnF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,eAAe,CAQnF"}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { HeadlessOptions } from './headlessTypes';
|
|
2
|
+
/**
|
|
3
|
+
* Explicit playback: HLS and WHEP.
|
|
4
|
+
*
|
|
5
|
+
* **This is deliberately not part of the media-card surface.** WebRTC media is
|
|
6
|
+
* *auto-consumed* — the SDK subscribes for you, and `getRemoteVideoStreams` /
|
|
7
|
+
* `getAudioGridComponents` hand you what already arrived. HLS and WHEP are the
|
|
8
|
+
* opposite: nothing is consumed until you ask, because each one opens a
|
|
9
|
+
* connection the room did not ask for and would otherwise pay for.
|
|
10
|
+
*
|
|
11
|
+
* So the API here is imperative — `attachPlayback` / `detachPlayback` — rather
|
|
12
|
+
* than a reactive getter. Mixing these into the media cards would mean every
|
|
13
|
+
* room silently opened an HLS or WHEP connection whether or not anything
|
|
14
|
+
* rendered it.
|
|
15
|
+
*
|
|
16
|
+
* When to reach for which:
|
|
17
|
+
*
|
|
18
|
+
* | | latency | cost per viewer | use it for |
|
|
19
|
+
* | --- | --- | --- | --- |
|
|
20
|
+
* | WebRTC (auto) | sub-second | an SFU consumer | anyone who takes part |
|
|
21
|
+
* | WHEP | sub-second | an SFU consumer | standards-based egress to non-SDK players |
|
|
22
|
+
* | HLS | seconds | a CDN request | audiences too large to fan out over the SFU |
|
|
23
|
+
*
|
|
24
|
+
* A large passive audience on HLS is the reason this exists: it moves the
|
|
25
|
+
* expensive part — media fan-out — off the SFU.
|
|
26
|
+
*/
|
|
27
|
+
export type PlaybackProtocol = 'hls' | 'whep';
|
|
28
|
+
export interface PlaybackSource {
|
|
29
|
+
protocol: PlaybackProtocol;
|
|
30
|
+
url: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Playback URLs the server has published for this room.
|
|
34
|
+
*
|
|
35
|
+
* Returns nothing when the room has none — HLS and WHEP are provisioned
|
|
36
|
+
* server-side, so absence means "not enabled for this room", not an error.
|
|
37
|
+
*/
|
|
38
|
+
export declare function getPlaybackSources({ parameters }: HeadlessOptions): PlaybackSource[];
|
|
39
|
+
/** A running playback. Always `detachPlayback` it — none of this is garbage-collected. */
|
|
40
|
+
export interface PlaybackHandle {
|
|
41
|
+
protocol: PlaybackProtocol;
|
|
42
|
+
url: string;
|
|
43
|
+
/** The media, when the protocol produces one directly (WHEP). */
|
|
44
|
+
stream: MediaStream | null;
|
|
45
|
+
/** Release the connection, the player, and the element's source. */
|
|
46
|
+
detach: () => void;
|
|
47
|
+
}
|
|
48
|
+
export interface AttachPlaybackOptions {
|
|
49
|
+
/** Playback URL, or a `PlaybackSource` from `getPlaybackSources`. */
|
|
50
|
+
source: string | PlaybackSource;
|
|
51
|
+
/** The element to play into. Required for HLS; optional for WHEP. */
|
|
52
|
+
video?: HTMLVideoElement | null;
|
|
53
|
+
/** Force a protocol. Inferred from the URL when omitted. */
|
|
54
|
+
protocol?: PlaybackProtocol;
|
|
55
|
+
/**
|
|
56
|
+
* Factory returning an hls.js instance, e.g. `() => new Hls({ lowLatencyMode: true })`.
|
|
57
|
+
*
|
|
58
|
+
* Required for HLS anywhere except Safari, and injected rather than imported
|
|
59
|
+
* so hls.js never becomes a dependency of this SDK — most rooms never play
|
|
60
|
+
* HLS, and React Native cannot use it at all.
|
|
61
|
+
*/
|
|
62
|
+
hlsFactory?: () => any;
|
|
63
|
+
/** Extra headers for the WHEP POST, e.g. an auth token. */
|
|
64
|
+
headers?: Record<string, string>;
|
|
65
|
+
/** ICE servers for WHEP. Defaults to the room's own when available. */
|
|
66
|
+
iceServers?: RTCIceServer[];
|
|
67
|
+
}
|
|
68
|
+
export type AttachPlaybackType = (options: AttachPlaybackOptions) => Promise<PlaybackHandle>;
|
|
69
|
+
/**
|
|
70
|
+
* Start an explicit playback.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* import Hls from 'hls.js';
|
|
75
|
+
*
|
|
76
|
+
* const [source] = getPlaybackSources({ parameters });
|
|
77
|
+
* const handle = await attachPlayback({
|
|
78
|
+
* source,
|
|
79
|
+
* video: videoRef.current,
|
|
80
|
+
* hlsFactory: () => new Hls({ lowLatencyMode: true }),
|
|
81
|
+
* });
|
|
82
|
+
* // later, always:
|
|
83
|
+
* detachPlayback(handle);
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
export declare function attachPlayback({ source, video, protocol, hlsFactory, headers, iceServers, }: AttachPlaybackOptions): Promise<PlaybackHandle>;
|
|
87
|
+
/** Stop a playback and release everything it holds. Safe to call twice. */
|
|
88
|
+
export declare function detachPlayback(handle: PlaybackHandle | null | undefined): void;
|
|
89
|
+
export interface PublishWhipOptions {
|
|
90
|
+
/** The WHIP endpoint. */
|
|
91
|
+
url: string;
|
|
92
|
+
/** The stream to publish. */
|
|
93
|
+
stream: MediaStream;
|
|
94
|
+
headers?: Record<string, string>;
|
|
95
|
+
iceServers?: RTCIceServer[];
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Publish a stream to a WHIP endpoint.
|
|
99
|
+
*
|
|
100
|
+
* The symmetric counterpart of WHEP, and equally explicit. This is *not* how
|
|
101
|
+
* you publish into a MediaSFU room — use `produceMedia` for that, which goes
|
|
102
|
+
* through the room's own transport and respects its capture entitlements. WHIP
|
|
103
|
+
* is for pushing to a standards-based ingest that is not this room.
|
|
104
|
+
*/
|
|
105
|
+
export declare function publishWhip({ url, stream, headers, iceServers, }: PublishWhipOptions): Promise<PlaybackHandle>;
|
|
106
|
+
//# sourceMappingURL=playback.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"playback.d.ts","sourceRoot":"","sources":["../../../../src/methods/utils/headless/playback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAsB,MAAM,iBAAiB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,MAAM,CAAC;AAE9C,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,cAAc,EAAE,CASpF;AAED,0FAA0F;AAC1F,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,iEAAiE;IACjE,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;IAC3B,oEAAoE;IACpE,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,qEAAqE;IACrE,MAAM,EAAE,MAAM,GAAG,cAAc,CAAC;IAChC,qEAAqE;IACrE,KAAK,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC;IACvB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,uEAAuE;IACvE,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;CAC7B;AAkJD,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7F;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EACN,KAAK,EACL,QAAQ,EACR,UAAU,EACV,OAAO,EACP,UAAU,GACX,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,CAUjD;AAED,2EAA2E;AAC3E,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAG9E;AAMD,MAAM,WAAW,kBAAkB;IACjC,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,6BAA6B;IAC7B,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,EAChC,GAAG,EACH,MAAM,EACN,OAAY,EACZ,UAAU,GACX,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAsC9C"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { HeadlessOptions } from './headlessTypes';
|
|
2
|
+
export interface HeadlessActionResult {
|
|
3
|
+
ok: boolean;
|
|
4
|
+
/** Empty when `ok`; otherwise a short, user-safe explanation. */
|
|
5
|
+
error: string;
|
|
6
|
+
}
|
|
7
|
+
export interface LeaveRoomOptions extends HeadlessOptions {
|
|
8
|
+
/** Ban the member on the way out. Requires host privileges. */
|
|
9
|
+
ban?: boolean;
|
|
10
|
+
/** Whether a host exit should end the room for everyone. Defaults to true. */
|
|
11
|
+
endRoomOnHostExit?: boolean;
|
|
12
|
+
}
|
|
13
|
+
export type LeaveRoomType = (options: LeaveRoomOptions) => Promise<HeadlessActionResult>;
|
|
14
|
+
/**
|
|
15
|
+
* Leave the room from a headless surface.
|
|
16
|
+
*
|
|
17
|
+
* Without this you have to pull `socket`, `localSocket`, `member` and `roomName`
|
|
18
|
+
* off the bag yourself and hand them to `confirmExit` — four chances to pass a
|
|
19
|
+
* stale value, and a silent no-op when you do.
|
|
20
|
+
*
|
|
21
|
+
* Never throws: a failed exit comes back as `{ ok: false, error }` so a Leave
|
|
22
|
+
* button can report why rather than appearing to work.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* import { leaveRoom } from 'mediasfu-shared';
|
|
27
|
+
*
|
|
28
|
+
* const result = await leaveRoom({
|
|
29
|
+
* parameters: parameterStore.getCurrent(),
|
|
30
|
+
* endRoomOnHostExit: false,
|
|
31
|
+
* });
|
|
32
|
+
* if (!result.ok) setNotice(result.error);
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
export declare function leaveRoom({ parameters, ban, endRoomOnHostExit, }: LeaveRoomOptions): Promise<HeadlessActionResult>;
|
|
36
|
+
export interface SendChatMessageOptions extends HeadlessOptions {
|
|
37
|
+
message: string;
|
|
38
|
+
/** Specific recipients. Empty (default) sends to the group. */
|
|
39
|
+
receivers?: string[];
|
|
40
|
+
/** Send to everyone. Defaults to true when `receivers` is empty. */
|
|
41
|
+
group?: boolean;
|
|
42
|
+
}
|
|
43
|
+
export type SendChatMessageType = (options: SendChatMessageOptions) => Promise<HeadlessActionResult>;
|
|
44
|
+
/**
|
|
45
|
+
* Send a chat message from a headless surface.
|
|
46
|
+
*
|
|
47
|
+
* `sendMessage` takes eleven fields that all have to be lifted off the bag in
|
|
48
|
+
* the right combination; this resolves them for you, including the
|
|
49
|
+
* `localSocket`-before-`socket` preference the SDK uses for chat.
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* import { sendChatMessage } from 'mediasfu-shared';
|
|
54
|
+
*
|
|
55
|
+
* await sendChatMessage({ parameters, message: 'Hello everyone' });
|
|
56
|
+
* await sendChatMessage({ parameters, message: 'Just you', receivers: ['Paul'] });
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
export declare function sendChatMessage({ parameters, message, receivers, group, }: SendChatMessageOptions): Promise<HeadlessActionResult>;
|
|
60
|
+
export interface RunMediaControlOptions extends HeadlessOptions {
|
|
61
|
+
/** Which control to run. */
|
|
62
|
+
control: 'clickAudio' | 'clickVideo' | 'clickScreenShare' | 'switchAudio' | 'switchVideo' | 'switchVideoAlt';
|
|
63
|
+
/** Extra arguments, e.g. `{ audioPreference: deviceId }` for `switchAudio`. */
|
|
64
|
+
extra?: Record<string, any>;
|
|
65
|
+
}
|
|
66
|
+
export type RunMediaControlType = (options: RunMediaControlOptions) => Promise<HeadlessActionResult>;
|
|
67
|
+
/**
|
|
68
|
+
* Invoke a media control safely from a headless surface.
|
|
69
|
+
*
|
|
70
|
+
* Gates on {@link getRoomReadiness} first — firing `clickVideo` before the
|
|
71
|
+
* transport exists fails silently and looks like a dead button — then resolves
|
|
72
|
+
* the control off the current bag rather than a snapshot the caller captured
|
|
73
|
+
* earlier.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* import { runMediaControl } from 'mediasfu-shared';
|
|
78
|
+
*
|
|
79
|
+
* await runMediaControl({ parameters, control: 'clickVideo' });
|
|
80
|
+
* await runMediaControl({
|
|
81
|
+
* parameters,
|
|
82
|
+
* control: 'switchVideo',
|
|
83
|
+
* extra: { videoPreference: deviceId },
|
|
84
|
+
* });
|
|
85
|
+
* ```
|
|
86
|
+
*/
|
|
87
|
+
export declare function runMediaControl({ parameters, control, extra, }: RunMediaControlOptions): Promise<HeadlessActionResult>;
|
|
88
|
+
//# sourceMappingURL=roomActions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"roomActions.d.ts","sourceRoot":"","sources":["../../../../src/methods/utils/headless/roomActions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAsB,MAAM,iBAAiB,CAAC;AAItE,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,OAAO,CAAC;IACZ,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;CACf;AAcD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,+DAA+D;IAC/D,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,8EAA8E;IAC9E,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,MAAM,aAAa,GAAG,CAC1B,OAAO,EAAE,gBAAgB,KACtB,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,SAAS,CAAC,EAC9B,UAAU,EACV,GAAW,EACX,iBAAwB,GACzB,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAyBlD;AAED,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,oEAAoE;IACpE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,MAAM,mBAAmB,GAAG,CAChC,OAAO,EAAE,sBAAsB,KAC5B,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,eAAe,CAAC,EACpC,UAAU,EACV,OAAO,EACP,SAAc,EACd,KAAK,GACN,EAAE,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAiCxD;AAED,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,4BAA4B;IAC5B,OAAO,EACH,YAAY,GACZ,YAAY,GACZ,kBAAkB,GAClB,aAAa,GACb,aAAa,GACb,gBAAgB,CAAC;IACrB,+EAA+E;IAC/E,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,MAAM,MAAM,mBAAmB,GAAG,CAChC,OAAO,EAAE,sBAAsB,KAC5B,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,eAAe,CAAC,EACpC,UAAU,EACV,OAAO,EACP,KAAK,GACN,EAAE,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAkCxD"}
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import { HeadlessOptions } from './headlessTypes';
|
|
2
|
+
import { HeadlessActionResult } from './roomActions';
|
|
3
|
+
export interface SwitchDeviceOptions extends HeadlessOptions {
|
|
4
|
+
/** `deviceId` from `listMediaDevices()`. */
|
|
5
|
+
deviceId: string;
|
|
6
|
+
}
|
|
7
|
+
export type SwitchCameraType = (options: SwitchDeviceOptions) => Promise<HeadlessActionResult>;
|
|
8
|
+
/**
|
|
9
|
+
* Switch to a different camera.
|
|
10
|
+
*
|
|
11
|
+
* Pairs with `listMediaDevices()` / `getSelectedDevices()`, which could
|
|
12
|
+
* previously only report devices with no way to act on them.
|
|
13
|
+
*
|
|
14
|
+
* Goes through the SDK's own `switchUserVideo`, so the producer track is
|
|
15
|
+
* replaced on the existing transport — remote viewers see the new camera
|
|
16
|
+
* without the call renegotiating — and host restrictions still apply. A refusal
|
|
17
|
+
* (blocked by the host, audio-only event) is returned as `ok: false` with the
|
|
18
|
+
* reason rather than resolving silently.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const { video } = await listMediaDevices();
|
|
23
|
+
* await switchCamera({ parameters, deviceId: video[1].deviceId });
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
export declare function switchCamera({ parameters, deviceId, }: SwitchDeviceOptions): Promise<HeadlessActionResult>;
|
|
27
|
+
/**
|
|
28
|
+
* Flip between the front and rear cameras.
|
|
29
|
+
*
|
|
30
|
+
* This toggles — the SDK's `switchVideoAlt` swaps whichever facing mode is
|
|
31
|
+
* current and takes no target, so there is no way to ask for "front"
|
|
32
|
+
* specifically. Use `switchCamera` with a deviceId when you need to land on a
|
|
33
|
+
* particular camera; use this on mobile, where device ids are unstable across
|
|
34
|
+
* sessions but the flip gesture is what users expect.
|
|
35
|
+
*/
|
|
36
|
+
export declare function flipCamera({ parameters }: HeadlessOptions): Promise<HeadlessActionResult>;
|
|
37
|
+
export type SwitchMicrophoneType = (options: SwitchDeviceOptions) => Promise<HeadlessActionResult>;
|
|
38
|
+
/** Switch to a different microphone. The audio counterpart of `switchCamera`. */
|
|
39
|
+
export declare function switchMicrophone({ parameters, deviceId, }: SwitchDeviceOptions): Promise<HeadlessActionResult>;
|
|
40
|
+
/** 'allow' — anyone may; 'approval' — must ask the host; 'disallow' — nobody may. */
|
|
41
|
+
export type RoomPolicyValue = 'allow' | 'approval' | 'disallow';
|
|
42
|
+
export interface SetRoomMediaPolicyOptions extends HeadlessOptions {
|
|
43
|
+
audio?: RoomPolicyValue;
|
|
44
|
+
video?: RoomPolicyValue;
|
|
45
|
+
screenshare?: RoomPolicyValue;
|
|
46
|
+
chat?: RoomPolicyValue;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Set what participants are allowed to do — the room-wide policy behind the
|
|
50
|
+
* SDK's settings modal.
|
|
51
|
+
*
|
|
52
|
+
* This is the *rule*, not a one-off action: `setParticipantMedia` (moderation)
|
|
53
|
+
* turns one person's camera off now, whereas `video: 'approval'` here means
|
|
54
|
+
* everyone must ask before turning one on. `getMediaPermissions()` reads the
|
|
55
|
+
* same four values back.
|
|
56
|
+
*
|
|
57
|
+
* Host only. Any value left undefined keeps its current setting.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* await setRoomMediaPolicy({ parameters, audio: 'approval', screenshare: 'disallow' });
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
export declare function setRoomMediaPolicy({ parameters, audio, video, screenshare, chat, }: SetRoomMediaPolicyOptions): Promise<HeadlessActionResult>;
|
|
65
|
+
export interface ChatMessage {
|
|
66
|
+
sender: string;
|
|
67
|
+
message: string;
|
|
68
|
+
timestamp: string;
|
|
69
|
+
/** Recipients — empty/[] means it went to everyone. */
|
|
70
|
+
receivers: string[];
|
|
71
|
+
/** True when this is a direct message rather than a room-wide one. */
|
|
72
|
+
direct: boolean;
|
|
73
|
+
/** True when the local user sent it. */
|
|
74
|
+
mine: boolean;
|
|
75
|
+
}
|
|
76
|
+
export interface GetChatMessagesOptions extends HeadlessOptions {
|
|
77
|
+
/** 'all' (default), 'group' for room-wide only, or 'direct' for DMs only. */
|
|
78
|
+
scope?: 'all' | 'group' | 'direct';
|
|
79
|
+
/** Only messages exchanged with this person. Implies direct messages. */
|
|
80
|
+
withPerson?: string;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Read the chat.
|
|
84
|
+
*
|
|
85
|
+
* `sendChatMessage` existed with no way to read replies, so a headless surface
|
|
86
|
+
* could talk but not listen. Direct messages are flagged and filterable, since
|
|
87
|
+
* rendering a DM in the room-wide thread leaks it to the wrong audience.
|
|
88
|
+
*
|
|
89
|
+
* Call from `onMediaChanged` or a render to get the current list.
|
|
90
|
+
*/
|
|
91
|
+
export declare function getChatMessages({ parameters, scope, withPerson, }: GetChatMessagesOptions): ChatMessage[];
|
|
92
|
+
export interface PendingApprovals {
|
|
93
|
+
/** People held in the waiting room. */
|
|
94
|
+
waiting: {
|
|
95
|
+
name: string;
|
|
96
|
+
id: string;
|
|
97
|
+
}[];
|
|
98
|
+
/** Requests to unmute, turn a camera on, share, or chat. */
|
|
99
|
+
requests: {
|
|
100
|
+
id: string;
|
|
101
|
+
name: string;
|
|
102
|
+
icon: string;
|
|
103
|
+
username: string;
|
|
104
|
+
}[];
|
|
105
|
+
/** Total items needing a host decision. */
|
|
106
|
+
total: number;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Everything currently awaiting a host decision.
|
|
110
|
+
*
|
|
111
|
+
* `respondToWaitingParticipant` and `respondToParticipantRequest` could act on
|
|
112
|
+
* these but nothing could list them, so a headless host had no way to know a
|
|
113
|
+
* decision was pending. Badge `total` and render the two lists.
|
|
114
|
+
*/
|
|
115
|
+
export declare function getPendingApprovals({ parameters }: HeadlessOptions): PendingApprovals;
|
|
116
|
+
export interface SessionTimer {
|
|
117
|
+
/** Elapsed wall time, formatted by the SDK (e.g. "12:04"). */
|
|
118
|
+
elapsed: string;
|
|
119
|
+
/**
|
|
120
|
+
* True while the server is asking whether you are still there — see
|
|
121
|
+
* `getPresenceCheck`, which you must answer or be disconnected.
|
|
122
|
+
*/
|
|
123
|
+
presenceCheckPending: boolean;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* How long the session has been running.
|
|
127
|
+
*
|
|
128
|
+
* Deliberately does not report "time remaining": the server sends that on the
|
|
129
|
+
* `meetingTimeRemaining` event, which the SDK forwards straight to `showAlert`
|
|
130
|
+
* without storing it. There is no field to read, and inventing one from the
|
|
131
|
+
* last alert would be a guess. Watch `showAlert` if you need the warning.
|
|
132
|
+
*/
|
|
133
|
+
export declare function getSessionTimer({ parameters }: HeadlessOptions): SessionTimer;
|
|
134
|
+
export interface PresenceCheck {
|
|
135
|
+
/** True while the "are you still there?" check is waiting on an answer. */
|
|
136
|
+
pending: boolean;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Whether the server is currently asking if you are still there.
|
|
140
|
+
*
|
|
141
|
+
* **This matters more headlessly than it looks.** On an idle room the server
|
|
142
|
+
* emits `meetingStillThere`, and the SDK opens a modal that counts down and
|
|
143
|
+
* then emits `disconnectUser`. With `returnUI={false}` that modal is still
|
|
144
|
+
* mounted — inside a root collapsed to 0×0 — so the countdown runs invisibly
|
|
145
|
+
* and the session is dropped with nothing shown and nothing to click.
|
|
146
|
+
*
|
|
147
|
+
* Poll this (from `onMediaChanged`, or a timer) and call `confirmStillHere`
|
|
148
|
+
* to stay in the room.
|
|
149
|
+
*/
|
|
150
|
+
export declare function getPresenceCheck({ parameters }: HeadlessOptions): PresenceCheck;
|
|
151
|
+
/**
|
|
152
|
+
* Answer the "are you still there?" check and stay in the room.
|
|
153
|
+
*
|
|
154
|
+
* Closing the check is the whole answer — the SDK only disconnects on the
|
|
155
|
+
* countdown expiring, so cancelling it is what keeps the session alive. Safe to
|
|
156
|
+
* call when nothing is pending.
|
|
157
|
+
*/
|
|
158
|
+
export declare function confirmStillHere({ parameters }: HeadlessOptions): HeadlessActionResult;
|
|
159
|
+
//# sourceMappingURL=sessionControls.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessionControls.d.ts","sourceRoot":"","sources":["../../../../src/methods/utils/headless/sessionControls.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAsB,MAAM,iBAAiB,CAAC;AAEtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAuCrD,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAE/F;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,YAAY,CAAC,EACjC,UAAU,EACV,QAAQ,GACT,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAIrD;AAED;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAG/F;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEnG,iFAAiF;AACjF,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,EACV,QAAQ,GACT,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAIrD;AAMD,qFAAqF;AACrF,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;AAEhE,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,KAAK,EACL,KAAK,EACL,WAAW,EACX,IAAI,GACL,EAAE,yBAAyB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA+B3D;AAMD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,sEAAsE;IACtE,MAAM,EAAE,OAAO,CAAC;IAChB,wCAAwC;IACxC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,6EAA6E;IAC7E,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACnC,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,KAAa,EACb,UAAe,GAChB,EAAE,sBAAsB,GAAG,WAAW,EAAE,CA2BxC;AAED,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACxC,4DAA4D;IAC5D,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzE,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,gBAAgB,CAkBrF;AAED,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;CAC/B;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,YAAY,CAM7E;AAED,MAAM,WAAW,aAAa;IAC5B,2EAA2E;IAC3E,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,aAAa,CAG/E;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,oBAAoB,CAQtF"}
|