@ale-rainbow/web-sdk 5.1.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/README.md +44 -0
- package/lib/index.d.ts +8 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +501 -0
- package/lib/index.js.map +7 -0
- package/lib/libs/index.d.ts +3 -0
- package/lib/libs/index.d.ts.map +1 -0
- package/lib/libs/strophe/strophe-plugin.d.ts +13 -0
- package/lib/libs/strophe/strophe-plugin.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.d.ts +35 -0
- package/lib/libs/strophe/strophe.jingle.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.sdp.d.ts +44 -0
- package/lib/libs/strophe/strophe.jingle.sdp.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.session.d.ts +624 -0
- package/lib/libs/strophe/strophe.jingle.session.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.session.stats.d.ts +791 -0
- package/lib/libs/strophe/strophe.jingle.session.stats.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.lastactivity.d.ts +9 -0
- package/lib/libs/strophe/strophe.lastactivity.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.mam.d.ts +11 -0
- package/lib/libs/strophe/strophe.mam.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.ping.d.ts +39 -0
- package/lib/libs/strophe/strophe.ping.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.rsm.d.ts +24 -0
- package/lib/libs/strophe/strophe.rsm.d.ts.map +1 -0
- package/lib/libs/strophe/types.d.ts +23 -0
- package/lib/libs/strophe/types.d.ts.map +1 -0
- package/lib/models/authSettings.model.d.ts +38 -0
- package/lib/models/authSettings.model.d.ts.map +1 -0
- package/lib/models/bubble.model.d.ts +1114 -0
- package/lib/models/bubble.model.d.ts.map +1 -0
- package/lib/models/bubbleConferenceRecap.model.d.ts +532 -0
- package/lib/models/bubbleConferenceRecap.model.d.ts.map +1 -0
- package/lib/models/call.model.d.ts +1271 -0
- package/lib/models/call.model.d.ts.map +1 -0
- package/lib/models/callLog.model.d.ts +361 -0
- package/lib/models/callLog.model.d.ts.map +1 -0
- package/lib/models/channel.model.d.ts +692 -0
- package/lib/models/channel.model.d.ts.map +1 -0
- package/lib/models/channelMessage.model.d.ts +300 -0
- package/lib/models/channelMessage.model.d.ts.map +1 -0
- package/lib/models/cli.model.d.ts +59 -0
- package/lib/models/cli.model.d.ts.map +1 -0
- package/lib/models/common/context.d.ts +37 -0
- package/lib/models/common/context.d.ts.map +1 -0
- package/lib/models/common/error.d.ts +26 -0
- package/lib/models/common/error.d.ts.map +1 -0
- package/lib/models/common/fileDescriptor.d.ts +317 -0
- package/lib/models/common/fileDescriptor.d.ts.map +1 -0
- package/lib/models/common/filePublicDownload.d.ts +26 -0
- package/lib/models/common/filePublicDownload.d.ts.map +1 -0
- package/lib/models/common/fileViewer.d.ts +20 -0
- package/lib/models/common/fileViewer.d.ts.map +1 -0
- package/lib/models/common/index.d.ts +9 -0
- package/lib/models/common/index.d.ts.map +1 -0
- package/lib/models/common/theme.d.ts +185 -0
- package/lib/models/common/theme.d.ts.map +1 -0
- package/lib/models/common/themeColor.d.ts +47 -0
- package/lib/models/common/themeColor.d.ts.map +1 -0
- package/lib/models/common/userTheme.d.ts +42 -0
- package/lib/models/common/userTheme.d.ts.map +1 -0
- package/lib/models/company-invitation.model.d.ts +42 -0
- package/lib/models/company-invitation.model.d.ts.map +1 -0
- package/lib/models/company.model.d.ts +639 -0
- package/lib/models/company.model.d.ts.map +1 -0
- package/lib/models/contact.model.d.ts +1208 -0
- package/lib/models/contact.model.d.ts.map +1 -0
- package/lib/models/conversation.model.d.ts +768 -0
- package/lib/models/conversation.model.d.ts.map +1 -0
- package/lib/models/customManifest.model.d.ts +82 -0
- package/lib/models/customManifest.model.d.ts.map +1 -0
- package/lib/models/dataChannel.model.d.ts +178 -0
- package/lib/models/dataChannel.model.d.ts.map +1 -0
- package/lib/models/dial-in-phone-numbers.model.d.ts +18 -0
- package/lib/models/dial-in-phone-numbers.model.d.ts.map +1 -0
- package/lib/models/directoryContact.model.d.ts +205 -0
- package/lib/models/directoryContact.model.d.ts.map +1 -0
- package/lib/models/event.model.d.ts +14 -0
- package/lib/models/event.model.d.ts.map +1 -0
- package/lib/models/favorite.model.d.ts +94 -0
- package/lib/models/favorite.model.d.ts.map +1 -0
- package/lib/models/fileDocument.model.d.ts +345 -0
- package/lib/models/fileDocument.model.d.ts.map +1 -0
- package/lib/models/geoLoc.model.d.ts +6 -0
- package/lib/models/geoLoc.model.d.ts.map +1 -0
- package/lib/models/index.d.ts +46 -0
- package/lib/models/index.d.ts.map +1 -0
- package/lib/models/invitation.model.d.ts +88 -0
- package/lib/models/invitation.model.d.ts.map +1 -0
- package/lib/models/invoices.model.d.ts +76 -0
- package/lib/models/invoices.model.d.ts.map +1 -0
- package/lib/models/logEntry.model.d.ts +23 -0
- package/lib/models/logEntry.model.d.ts.map +1 -0
- package/lib/models/message.model.d.ts +400 -0
- package/lib/models/message.model.d.ts.map +1 -0
- package/lib/models/messageAdditionalContent.parsers.d.ts +32 -0
- package/lib/models/messageAdditionalContent.parsers.d.ts.map +1 -0
- package/lib/models/offer.model.d.ts +16 -0
- package/lib/models/offer.model.d.ts.map +1 -0
- package/lib/models/p2pRecap.model.d.ts +372 -0
- package/lib/models/p2pRecap.model.d.ts.map +1 -0
- package/lib/models/paymentMethods.model.d.ts +98 -0
- package/lib/models/paymentMethods.model.d.ts.map +1 -0
- package/lib/models/personalRoutine.model.d.ts +173 -0
- package/lib/models/personalRoutine.model.d.ts.map +1 -0
- package/lib/models/poll.model.d.ts +139 -0
- package/lib/models/poll.model.d.ts.map +1 -0
- package/lib/models/rainbow-auth.model.d.ts +137 -0
- package/lib/models/rainbow-auth.model.d.ts.map +1 -0
- package/lib/models/searchTextConvResults.model.d.ts +30 -0
- package/lib/models/searchTextConvResults.model.d.ts.map +1 -0
- package/lib/models/site.model.d.ts +165 -0
- package/lib/models/site.model.d.ts.map +1 -0
- package/lib/models/subscription.model.d.ts +592 -0
- package/lib/models/subscription.model.d.ts.map +1 -0
- package/lib/models/telephonyConfig.model.d.ts +144 -0
- package/lib/models/telephonyConfig.model.d.ts.map +1 -0
- package/lib/models/telephonyForward.model.d.ts +47 -0
- package/lib/models/telephonyForward.model.d.ts.map +1 -0
- package/lib/models/todo.model.d.ts +103 -0
- package/lib/models/todo.model.d.ts.map +1 -0
- package/lib/models/transcription.model.d.ts +59 -0
- package/lib/models/transcription.model.d.ts.map +1 -0
- package/lib/models/user.model.d.ts +1008 -0
- package/lib/models/user.model.d.ts.map +1 -0
- package/lib/models/userProfileTemplate.model.d.ts +735 -0
- package/lib/models/userProfileTemplate.model.d.ts.map +1 -0
- package/lib/models/usersList.model.d.ts +117 -0
- package/lib/models/usersList.model.d.ts.map +1 -0
- package/lib/models/webConferenceParticipant.model.d.ts +135 -0
- package/lib/models/webConferenceParticipant.model.d.ts.map +1 -0
- package/lib/models/webConferenceSession.model.d.ts +658 -0
- package/lib/models/webConferenceSession.model.d.ts.map +1 -0
- package/lib/models/webinar.model.d.ts +738 -0
- package/lib/models/webinar.model.d.ts.map +1 -0
- package/lib/models/webinarRecap.model.d.ts +118 -0
- package/lib/models/webinarRecap.model.d.ts.map +1 -0
- package/lib/node.d.ts +3 -0
- package/lib/node.d.ts.map +1 -0
- package/lib/node.js +423 -0
- package/lib/node.js.map +7 -0
- package/lib/node.sdk.d.ts +41 -0
- package/lib/node.sdk.d.ts.map +1 -0
- package/lib/plugins/admin.plugin.d.ts +6 -0
- package/lib/plugins/admin.plugin.d.ts.map +1 -0
- package/lib/plugins/bubbleConference.plugin.d.ts +6 -0
- package/lib/plugins/bubbleConference.plugin.d.ts.map +1 -0
- package/lib/plugins/bubbleTag.plugin.d.ts +6 -0
- package/lib/plugins/bubbleTag.plugin.d.ts.map +1 -0
- package/lib/plugins/bubbles.plugin.d.ts +6 -0
- package/lib/plugins/bubbles.plugin.d.ts.map +1 -0
- package/lib/plugins/businessDirectory.plugin.d.ts +6 -0
- package/lib/plugins/businessDirectory.plugin.d.ts.map +1 -0
- package/lib/plugins/callRecorder.plugin.d.ts +6 -0
- package/lib/plugins/callRecorder.plugin.d.ts.map +1 -0
- package/lib/plugins/calllog.plugin.d.ts +6 -0
- package/lib/plugins/calllog.plugin.d.ts.map +1 -0
- package/lib/plugins/calls.plugin.d.ts +6 -0
- package/lib/plugins/calls.plugin.d.ts.map +1 -0
- package/lib/plugins/channels.plugin.d.ts +6 -0
- package/lib/plugins/channels.plugin.d.ts.map +1 -0
- package/lib/plugins/dataChannel.plugin.d.ts +6 -0
- package/lib/plugins/dataChannel.plugin.d.ts.map +1 -0
- package/lib/plugins/deviceManagement.plugin.d.ts +6 -0
- package/lib/plugins/deviceManagement.plugin.d.ts.map +1 -0
- package/lib/plugins/favorites.plugin.d.ts +6 -0
- package/lib/plugins/favorites.plugin.d.ts.map +1 -0
- package/lib/plugins/fileDocument.plugin.d.ts +6 -0
- package/lib/plugins/fileDocument.plugin.d.ts.map +1 -0
- package/lib/plugins/helpCenter.plugin.d.ts +6 -0
- package/lib/plugins/helpCenter.plugin.d.ts.map +1 -0
- package/lib/plugins/index.d.ts +27 -0
- package/lib/plugins/index.d.ts.map +1 -0
- package/lib/plugins/microsoft0365Ad.plugin.d.ts +6 -0
- package/lib/plugins/microsoft0365Ad.plugin.d.ts.map +1 -0
- package/lib/plugins/pbxUsers.plugin.d.ts +6 -0
- package/lib/plugins/pbxUsers.plugin.d.ts.map +1 -0
- package/lib/plugins/personalDirectory.plugin.d.ts +6 -0
- package/lib/plugins/personalDirectory.plugin.d.ts.map +1 -0
- package/lib/plugins/plugin.d.ts +8 -0
- package/lib/plugins/plugin.d.ts.map +1 -0
- package/lib/plugins/polls.plugin.d.ts +6 -0
- package/lib/plugins/polls.plugin.d.ts.map +1 -0
- package/lib/plugins/rpc.plugin.d.ts +6 -0
- package/lib/plugins/rpc.plugin.d.ts.map +1 -0
- package/lib/plugins/telemetry.plugin.d.ts +6 -0
- package/lib/plugins/telemetry.plugin.d.ts.map +1 -0
- package/lib/plugins/telephony.plugin.d.ts +6 -0
- package/lib/plugins/telephony.plugin.d.ts.map +1 -0
- package/lib/plugins/telephonyConfig.plugin.d.ts +6 -0
- package/lib/plugins/telephonyConfig.plugin.d.ts.map +1 -0
- package/lib/plugins/transcription.plugin.d.ts +6 -0
- package/lib/plugins/transcription.plugin.d.ts.map +1 -0
- package/lib/plugins/usersList.plugin.d.ts +6 -0
- package/lib/plugins/usersList.plugin.d.ts.map +1 -0
- package/lib/plugins/virtualBackground.plugin.d.ts +6 -0
- package/lib/plugins/virtualBackground.plugin.d.ts.map +1 -0
- package/lib/plugins/webinar.plugin.d.ts +6 -0
- package/lib/plugins/webinar.plugin.d.ts.map +1 -0
- package/lib/rainbow.sdk.d.ts +309 -0
- package/lib/rainbow.sdk.d.ts.map +1 -0
- package/lib/services/admin/admin-alarm.service.d.ts +42 -0
- package/lib/services/admin/admin-alarm.service.d.ts.map +1 -0
- package/lib/services/admin/admin-company.service.d.ts +167 -0
- package/lib/services/admin/admin-company.service.d.ts.map +1 -0
- package/lib/services/admin/admin-department.service.d.ts +39 -0
- package/lib/services/admin/admin-department.service.d.ts.map +1 -0
- package/lib/services/admin/admin-invitation.service.d.ts +114 -0
- package/lib/services/admin/admin-invitation.service.d.ts.map +1 -0
- package/lib/services/admin/admin-management.service.d.ts +100 -0
- package/lib/services/admin/admin-management.service.d.ts.map +1 -0
- package/lib/services/admin/admin-rvcp.service.d.ts +43 -0
- package/lib/services/admin/admin-rvcp.service.d.ts.map +1 -0
- package/lib/services/admin/admin-site.service.d.ts +64 -0
- package/lib/services/admin/admin-site.service.d.ts.map +1 -0
- package/lib/services/admin/admin-subscription.service.d.ts +135 -0
- package/lib/services/admin/admin-subscription.service.d.ts.map +1 -0
- package/lib/services/admin/admin-tag.service.d.ts +79 -0
- package/lib/services/admin/admin-tag.service.d.ts.map +1 -0
- package/lib/services/admin/admin-user-profile.service.d.ts +76 -0
- package/lib/services/admin/admin-user-profile.service.d.ts.map +1 -0
- package/lib/services/admin/admin-user.service.d.ts +338 -0
- package/lib/services/admin/admin-user.service.d.ts.map +1 -0
- package/lib/services/admin/admin.common.d.ts +40 -0
- package/lib/services/admin/admin.common.d.ts.map +1 -0
- package/lib/services/admin/admin.service.d.ts +138 -0
- package/lib/services/admin/admin.service.d.ts.map +1 -0
- package/lib/services/admin/index.d.ts +14 -0
- package/lib/services/admin/index.d.ts.map +1 -0
- package/lib/services/bot/bot.service.d.ts +121 -0
- package/lib/services/bot/bot.service.d.ts.map +1 -0
- package/lib/services/bubbles/bubble.service.d.ts +889 -0
- package/lib/services/bubbles/bubble.service.d.ts.map +1 -0
- package/lib/services/bubbles/bubbleTag.service.d.ts +132 -0
- package/lib/services/bubbles/bubbleTag.service.d.ts.map +1 -0
- package/lib/services/bubbles/index.d.ts +3 -0
- package/lib/services/bubbles/index.d.ts.map +1 -0
- package/lib/services/call/call.service.d.ts +297 -0
- package/lib/services/call/call.service.d.ts.map +1 -0
- package/lib/services/call/callRecorder.service.d.ts +358 -0
- package/lib/services/call/callRecorder.service.d.ts.map +1 -0
- package/lib/services/call/index.d.ts +3 -0
- package/lib/services/call/index.d.ts.map +1 -0
- package/lib/services/callLog/callLog.service.d.ts +563 -0
- package/lib/services/callLog/callLog.service.d.ts.map +1 -0
- package/lib/services/callLog/index.d.ts +5 -0
- package/lib/services/callLog/index.d.ts.map +1 -0
- package/lib/services/callLog/p2pRecap.service.d.ts +206 -0
- package/lib/services/callLog/p2pRecap.service.d.ts.map +1 -0
- package/lib/services/channels/channel.service.d.ts +626 -0
- package/lib/services/channels/channel.service.d.ts.map +1 -0
- package/lib/services/channels/index.d.ts +3 -0
- package/lib/services/channels/index.d.ts.map +1 -0
- package/lib/services/citrix/citrix.service.d.ts +30 -0
- package/lib/services/citrix/citrix.service.d.ts.map +1 -0
- package/lib/services/citrix/index.d.ts +3 -0
- package/lib/services/citrix/index.d.ts.map +1 -0
- package/lib/services/company/company-directory.service.d.ts +222 -0
- package/lib/services/company/company-directory.service.d.ts.map +1 -0
- package/lib/services/conference/bubbleConference.service.d.ts +1237 -0
- package/lib/services/conference/bubbleConference.service.d.ts.map +1 -0
- package/lib/services/conference/bubbleConferenceRecap.service.d.ts +159 -0
- package/lib/services/conference/bubbleConferenceRecap.service.d.ts.map +1 -0
- package/lib/services/conference/index.d.ts +5 -0
- package/lib/services/conference/index.d.ts.map +1 -0
- package/lib/services/conference/webConferenceHelper.d.ts +25 -0
- package/lib/services/conference/webConferenceHelper.d.ts.map +1 -0
- package/lib/services/conversation/conversation.service.d.ts +723 -0
- package/lib/services/conversation/conversation.service.d.ts.map +1 -0
- package/lib/services/conversation/conversationServiceBulkHistoryHandler.d.ts +39 -0
- package/lib/services/conversation/conversationServiceBulkHistoryHandler.d.ts.map +1 -0
- package/lib/services/conversation/conversationServiceEventHandler.d.ts +78 -0
- package/lib/services/conversation/conversationServiceEventHandler.d.ts.map +1 -0
- package/lib/services/conversation/index.d.ts +3 -0
- package/lib/services/conversation/index.d.ts.map +1 -0
- package/lib/services/core/account.service.d.ts +98 -0
- package/lib/services/core/account.service.d.ts.map +1 -0
- package/lib/services/core/auth.service.d.ts +303 -0
- package/lib/services/core/auth.service.d.ts.map +1 -0
- package/lib/services/core/company.service.d.ts +30 -0
- package/lib/services/core/company.service.d.ts.map +1 -0
- package/lib/services/core/connection.service.d.ts +209 -0
- package/lib/services/core/connection.service.d.ts.map +1 -0
- package/lib/services/core/contact.service.d.ts +617 -0
- package/lib/services/core/contact.service.d.ts.map +1 -0
- package/lib/services/core/country.service.d.ts +66 -0
- package/lib/services/core/country.service.d.ts.map +1 -0
- package/lib/services/core/directorySearch.service.d.ts +305 -0
- package/lib/services/core/directorySearch.service.d.ts.map +1 -0
- package/lib/services/core/event.service.d.ts +31 -0
- package/lib/services/core/event.service.d.ts.map +1 -0
- package/lib/services/core/i18n.service.d.ts +19 -0
- package/lib/services/core/i18n.service.d.ts.map +1 -0
- package/lib/services/core/imageUtils.service.d.ts +15 -0
- package/lib/services/core/imageUtils.service.d.ts.map +1 -0
- package/lib/services/core/index.d.ts +19 -0
- package/lib/services/core/index.d.ts.map +1 -0
- package/lib/services/core/logger.service.d.ts +143 -0
- package/lib/services/core/logger.service.d.ts.map +1 -0
- package/lib/services/core/logging.service.d.ts +51 -0
- package/lib/services/core/logging.service.d.ts.map +1 -0
- package/lib/services/core/main.service.d.ts +124 -0
- package/lib/services/core/main.service.d.ts.map +1 -0
- package/lib/services/core/presenceHelper.service.d.ts +73 -0
- package/lib/services/core/presenceHelper.service.d.ts.map +1 -0
- package/lib/services/core/profile.service.d.ts +453 -0
- package/lib/services/core/profile.service.d.ts.map +1 -0
- package/lib/services/core/settings.service.d.ts +82 -0
- package/lib/services/core/settings.service.d.ts.map +1 -0
- package/lib/services/core/userInfo.service.d.ts +25 -0
- package/lib/services/core/userInfo.service.d.ts.map +1 -0
- package/lib/services/core/userNetwork.service.d.ts +171 -0
- package/lib/services/core/userNetwork.service.d.ts.map +1 -0
- package/lib/services/core/xmpp.service.d.ts +99 -0
- package/lib/services/core/xmpp.service.d.ts.map +1 -0
- package/lib/services/dataChannel/dataChannel.service.d.ts +102 -0
- package/lib/services/dataChannel/dataChannel.service.d.ts.map +1 -0
- package/lib/services/dataChannel/index.d.ts +3 -0
- package/lib/services/dataChannel/index.d.ts.map +1 -0
- package/lib/services/deviceManagement/deviceEchoFilter.d.ts +86 -0
- package/lib/services/deviceManagement/deviceEchoFilter.d.ts.map +1 -0
- package/lib/services/deviceManagement/deviceManagement.service.d.ts +290 -0
- package/lib/services/deviceManagement/deviceManagement.service.d.ts.map +1 -0
- package/lib/services/deviceManagement/index.d.ts +2 -0
- package/lib/services/deviceManagement/index.d.ts.map +1 -0
- package/lib/services/deviceManagement/webHidManager.service.d.ts +616 -0
- package/lib/services/deviceManagement/webHidManager.service.d.ts.map +1 -0
- package/lib/services/directory/directory.service.d.ts +108 -0
- package/lib/services/directory/directory.service.d.ts.map +1 -0
- package/lib/services/directory/index.d.ts +3 -0
- package/lib/services/directory/index.d.ts.map +1 -0
- package/lib/services/directory/office365ad.service.d.ts +74 -0
- package/lib/services/directory/office365ad.service.d.ts.map +1 -0
- package/lib/services/directory/personal-directory.service.d.ts +425 -0
- package/lib/services/directory/personal-directory.service.d.ts.map +1 -0
- package/lib/services/directory/phonebook.service.d.ts +43 -0
- package/lib/services/directory/phonebook.service.d.ts.map +1 -0
- package/lib/services/event-mixin.d.ts +75 -0
- package/lib/services/event-mixin.d.ts.map +1 -0
- package/lib/services/favorites/favorites.service.d.ts +313 -0
- package/lib/services/favorites/favorites.service.d.ts.map +1 -0
- package/lib/services/favorites/index.d.ts +3 -0
- package/lib/services/favorites/index.d.ts.map +1 -0
- package/lib/services/fileDocument/fileDocument.service.d.ts +229 -0
- package/lib/services/fileDocument/fileDocument.service.d.ts.map +1 -0
- package/lib/services/fileDocument/index.d.ts +5 -0
- package/lib/services/fileDocument/index.d.ts.map +1 -0
- package/lib/services/files/fileDescriptorEventHandler.service.d.ts +18 -0
- package/lib/services/files/fileDescriptorEventHandler.service.d.ts.map +1 -0
- package/lib/services/files/fileServer.service.d.ts +268 -0
- package/lib/services/files/fileServer.service.d.ts.map +1 -0
- package/lib/services/files/fileStorage.service.d.ts +426 -0
- package/lib/services/files/fileStorage.service.d.ts.map +1 -0
- package/lib/services/helpcenter/helpCenter.service.d.ts +207 -0
- package/lib/services/helpcenter/helpCenter.service.d.ts.map +1 -0
- package/lib/services/helpcenter/index.d.ts +4 -0
- package/lib/services/helpcenter/index.d.ts.map +1 -0
- package/lib/services/helpcenter/whatsNew.service.d.ts +47 -0
- package/lib/services/helpcenter/whatsNew.service.d.ts.map +1 -0
- package/lib/services/horizon/horizon.service.d.ts +31 -0
- package/lib/services/horizon/horizon.service.d.ts.map +1 -0
- package/lib/services/horizon/index.d.ts +3 -0
- package/lib/services/horizon/index.d.ts.map +1 -0
- package/lib/services/index.d.ts +35 -0
- package/lib/services/index.d.ts.map +1 -0
- package/lib/services/launcher/config/sdkLaunchConfig.d.ts +8 -0
- package/lib/services/launcher/config/sdkLaunchConfig.d.ts.map +1 -0
- package/lib/services/localTranslation/chromeTranslation.engine.d.ts +79 -0
- package/lib/services/localTranslation/chromeTranslation.engine.d.ts.map +1 -0
- package/lib/services/localTranslation/index.d.ts +6 -0
- package/lib/services/localTranslation/index.d.ts.map +1 -0
- package/lib/services/localTranslation/localTranslation.service.d.ts +129 -0
- package/lib/services/localTranslation/localTranslation.service.d.ts.map +1 -0
- package/lib/services/localTranslation/translationEngine.d.ts +81 -0
- package/lib/services/localTranslation/translationEngine.d.ts.map +1 -0
- package/lib/services/metrics/analytics.service.d.ts +63 -0
- package/lib/services/metrics/analytics.service.d.ts.map +1 -0
- package/lib/services/metrics/index.d.ts +2 -0
- package/lib/services/metrics/index.d.ts.map +1 -0
- package/lib/services/notifications/index.d.ts +2 -0
- package/lib/services/notifications/index.d.ts.map +1 -0
- package/lib/services/notifications/notificationCenter.service.d.ts +178 -0
- package/lib/services/notifications/notificationCenter.service.d.ts.map +1 -0
- package/lib/services/notifications/notificationsViewer.service.d.ts +46 -0
- package/lib/services/notifications/notificationsViewer.service.d.ts.map +1 -0
- package/lib/services/personalRoutines/personal-routines.service.d.ts +159 -0
- package/lib/services/personalRoutines/personal-routines.service.d.ts.map +1 -0
- package/lib/services/polls/index.d.ts +2 -0
- package/lib/services/polls/index.d.ts.map +1 -0
- package/lib/services/polls/polls.service.d.ts +139 -0
- package/lib/services/polls/polls.service.d.ts.map +1 -0
- package/lib/services/ringing/index.d.ts +2 -0
- package/lib/services/ringing/index.d.ts.map +1 -0
- package/lib/services/ringing/ringing.service.d.ts +535 -0
- package/lib/services/ringing/ringing.service.d.ts.map +1 -0
- package/lib/services/rpc/index.d.ts +2 -0
- package/lib/services/rpc/index.d.ts.map +1 -0
- package/lib/services/rpc/rpc.service.d.ts +75 -0
- package/lib/services/rpc/rpc.service.d.ts.map +1 -0
- package/lib/services/service.d.ts +9 -0
- package/lib/services/service.d.ts.map +1 -0
- package/lib/services/speechRecognitionService/speechRecognition.service.d.ts +87 -0
- package/lib/services/speechRecognitionService/speechRecognition.service.d.ts.map +1 -0
- package/lib/services/subscription/index.d.ts +4 -0
- package/lib/services/subscription/index.d.ts.map +1 -0
- package/lib/services/subscription/invoices.service.d.ts +78 -0
- package/lib/services/subscription/invoices.service.d.ts.map +1 -0
- package/lib/services/subscription/paymentMethods.service.d.ts +164 -0
- package/lib/services/subscription/paymentMethods.service.d.ts.map +1 -0
- package/lib/services/subscription/subscription.service.d.ts +510 -0
- package/lib/services/subscription/subscription.service.d.ts.map +1 -0
- package/lib/services/support/index.d.ts +2 -0
- package/lib/services/support/index.d.ts.map +1 -0
- package/lib/services/support/support.model.d.ts +143 -0
- package/lib/services/support/support.model.d.ts.map +1 -0
- package/lib/services/support/support.service.d.ts +162 -0
- package/lib/services/support/support.service.d.ts.map +1 -0
- package/lib/services/telemetry/index.d.ts +3 -0
- package/lib/services/telemetry/index.d.ts.map +1 -0
- package/lib/services/telemetry/jsonRPC.service.d.ts +25 -0
- package/lib/services/telemetry/jsonRPC.service.d.ts.map +1 -0
- package/lib/services/telemetry/telemetry.service.d.ts +22 -0
- package/lib/services/telemetry/telemetry.service.d.ts.map +1 -0
- package/lib/services/telephony/index.d.ts +4 -0
- package/lib/services/telephony/index.d.ts.map +1 -0
- package/lib/services/telephony/supervision.service.d.ts +277 -0
- package/lib/services/telephony/supervision.service.d.ts.map +1 -0
- package/lib/services/telephony/telephony.service.d.ts +1476 -0
- package/lib/services/telephony/telephony.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonyCcdAgent.service.d.ts +63 -0
- package/lib/services/telephony/telephonyCcdAgent.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonyHybridEventHandler.d.ts +360 -0
- package/lib/services/telephony/telephonyHybridEventHandler.d.ts.map +1 -0
- package/lib/services/telephony/telephonyKeys.service.d.ts +86 -0
- package/lib/services/telephony/telephonyKeys.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonySipWise.service.d.ts +543 -0
- package/lib/services/telephony/telephonySipWise.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonySipWiseEventHandler.d.ts +462 -0
- package/lib/services/telephony/telephonySipWiseEventHandler.d.ts.map +1 -0
- package/lib/services/telephonyConfig/index.d.ts +3 -0
- package/lib/services/telephonyConfig/index.d.ts.map +1 -0
- package/lib/services/telephonyConfig/telephonyConfig.service.d.ts +150 -0
- package/lib/services/telephonyConfig/telephonyConfig.service.d.ts.map +1 -0
- package/lib/services/todo/todo.service.d.ts +358 -0
- package/lib/services/todo/todo.service.d.ts.map +1 -0
- package/lib/services/transcription/index.d.ts +2 -0
- package/lib/services/transcription/index.d.ts.map +1 -0
- package/lib/services/transcription/liveTranscription.service.d.ts +94 -0
- package/lib/services/transcription/liveTranscription.service.d.ts.map +1 -0
- package/lib/services/ulrMetadata/urlMetadata.service.d.ts +51 -0
- package/lib/services/ulrMetadata/urlMetadata.service.d.ts.map +1 -0
- package/lib/services/users/index.d.ts +3 -0
- package/lib/services/users/index.d.ts.map +1 -0
- package/lib/services/users/user.service.d.ts +146 -0
- package/lib/services/users/user.service.d.ts.map +1 -0
- package/lib/services/users/usersLists.service.d.ts +239 -0
- package/lib/services/users/usersLists.service.d.ts.map +1 -0
- package/lib/services/utilities/browserDatabase.service.d.ts +69 -0
- package/lib/services/utilities/browserDatabase.service.d.ts.map +1 -0
- package/lib/services/utilities/errorHelper.service.d.ts +24 -0
- package/lib/services/utilities/errorHelper.service.d.ts.map +1 -0
- package/lib/services/utilities/index.d.ts +4 -0
- package/lib/services/utilities/index.d.ts.map +1 -0
- package/lib/services/utilities/utilities.service.d.ts +74 -0
- package/lib/services/utilities/utilities.service.d.ts.map +1 -0
- package/lib/services/virtualBackground/RBVirtualBackground.service.d.ts +228 -0
- package/lib/services/virtualBackground/RBVirtualBackground.service.d.ts.map +1 -0
- package/lib/services/virtualBackground/index.d.ts +4 -0
- package/lib/services/virtualBackground/index.d.ts.map +1 -0
- package/lib/services/virtualBackground/personalVideoBackground.d.ts +190 -0
- package/lib/services/virtualBackground/personalVideoBackground.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/canvas2D/canvas2DPipeline.d.ts +66 -0
- package/lib/services/virtualBackground/pipeline/canvas2D/canvas2DPipeline.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/blurStage.d.ts +88 -0
- package/lib/services/virtualBackground/pipeline/webgl2/blurStage.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/imageStage.d.ts +69 -0
- package/lib/services/virtualBackground/pipeline/webgl2/imageStage.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/jointBilateralFilter.d.ts +55 -0
- package/lib/services/virtualBackground/pipeline/webgl2/jointBilateralFilter.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/resizingStage.d.ts +59 -0
- package/lib/services/virtualBackground/pipeline/webgl2/resizingStage.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/softMax.d.ts +34 -0
- package/lib/services/virtualBackground/pipeline/webgl2/softMax.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webgl2Pipeline.d.ts +62 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webgl2Pipeline.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webglHelper.d.ts +56 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webglHelper.d.ts.map +1 -0
- package/lib/services/virtualBackground/virtualBackground.service.d.ts +399 -0
- package/lib/services/virtualBackground/virtualBackground.service.d.ts.map +1 -0
- package/lib/services/webinars/index.d.ts +10 -0
- package/lib/services/webinars/index.d.ts.map +1 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.model.d.ts +71 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.model.d.ts.map +1 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.service.d.ts +86 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.service.d.ts.map +1 -0
- package/lib/services/webinars/telemetry/webinarTelemetryDatabase.d.ts +31 -0
- package/lib/services/webinars/telemetry/webinarTelemetryDatabase.d.ts.map +1 -0
- package/lib/services/webinars/webinarAudioMixer.d.ts +45 -0
- package/lib/services/webinars/webinarAudioMixer.d.ts.map +1 -0
- package/lib/services/webinars/webinarConference.service.d.ts +323 -0
- package/lib/services/webinars/webinarConference.service.d.ts.map +1 -0
- package/lib/services/webinars/webinarConference.utils.d.ts +24 -0
- package/lib/services/webinars/webinarConference.utils.d.ts.map +1 -0
- package/lib/services/webinars/webinarParticipants.service.d.ts +43 -0
- package/lib/services/webinars/webinarParticipants.service.d.ts.map +1 -0
- package/lib/services/webinars/webinarSpeakers.service.d.ts +25 -0
- package/lib/services/webinars/webinarSpeakers.service.d.ts.map +1 -0
- package/lib/services/webinars/webinarStoryLine.service.d.ts +117 -0
- package/lib/services/webinars/webinarStoryLine.service.d.ts.map +1 -0
- package/lib/services/webinars/webinars.service.d.ts +600 -0
- package/lib/services/webinars/webinars.service.d.ts.map +1 -0
- package/lib/services/webrtc/index.d.ts +5 -0
- package/lib/services/webrtc/index.d.ts.map +1 -0
- package/lib/services/webrtc/webrtcConfigAndUtils.d.ts +170 -0
- package/lib/services/webrtc/webrtcConfigAndUtils.d.ts.map +1 -0
- package/lib/services/webrtc/webrtcP2P.service.d.ts +521 -0
- package/lib/services/webrtc/webrtcP2P.service.d.ts.map +1 -0
- package/lib/services/webrtc/webrtcP2PEventHandler.d.ts +55 -0
- package/lib/services/webrtc/webrtcP2PEventHandler.d.ts.map +1 -0
- package/lib/services/webrtcGateway/webrtcGateway.service.d.ts +605 -0
- package/lib/services/webrtcGateway/webrtcGateway.service.d.ts.map +1 -0
- package/lib/strophejs.d.ts +3 -0
- package/lib/strophejs.d.ts.map +1 -0
- package/lib/typings/helpers.d.ts +3 -0
- package/lib/typings/helpers.d.ts.map +1 -0
- package/lib/utils/allSettled.d.ts +2 -0
- package/lib/utils/allSettled.d.ts.map +1 -0
- package/lib/utils/anonymizer.d.ts +28 -0
- package/lib/utils/anonymizer.d.ts.map +1 -0
- package/lib/utils/branded.d.ts +4 -0
- package/lib/utils/branded.d.ts.map +1 -0
- package/lib/utils/browser.d.ts +231 -0
- package/lib/utils/browser.d.ts.map +1 -0
- package/lib/utils/index.d.ts +12 -0
- package/lib/utils/index.d.ts.map +1 -0
- package/lib/utils/mediaPermissionError.d.ts +2 -0
- package/lib/utils/mediaPermissionError.d.ts.map +1 -0
- package/lib/utils/promiseQueue.d.ts +10 -0
- package/lib/utils/promiseQueue.d.ts.map +1 -0
- package/lib/utils/randomString.d.ts +3 -0
- package/lib/utils/randomString.d.ts.map +1 -0
- package/lib/utils/recordingArchiveName.d.ts +13 -0
- package/lib/utils/recordingArchiveName.d.ts.map +1 -0
- package/lib/utils/serverTimestamp.d.ts +15 -0
- package/lib/utils/serverTimestamp.d.ts.map +1 -0
- package/lib/utils/stringifyError.d.ts +2 -0
- package/lib/utils/stringifyError.d.ts.map +1 -0
- package/lib/utils/video.d.ts +27 -0
- package/lib/utils/video.d.ts.map +1 -0
- package/lib/utils/wait.d.ts +2 -0
- package/lib/utils/wait.d.ts.map +1 -0
- package/lib/utils/xmlParser.d.ts +102 -0
- package/lib/utils/xmlParser.d.ts.map +1 -0
- package/lib/utils/xmlValidation.d.ts +119 -0
- package/lib/utils/xmlValidation.d.ts.map +1 -0
- package/package.json +58 -0
|
@@ -0,0 +1,791 @@
|
|
|
1
|
+
import type { JingleSession } from "./strophe.jingle.session";
|
|
2
|
+
export type CpuPressureState = "NOMINAL" | "FAIR" | "SERIOUS" | "CRITICAL";
|
|
3
|
+
/**
|
|
4
|
+
* Interface containing all stats related to the audio stats for the sessions output-rtp (outflow) + input-rtp (inflow)
|
|
5
|
+
*/
|
|
6
|
+
export interface WebrtcStatisticsSsrc {
|
|
7
|
+
type: string;
|
|
8
|
+
direction: string;
|
|
9
|
+
kind: string;
|
|
10
|
+
ssrc: string;
|
|
11
|
+
startedAt: string;
|
|
12
|
+
duration?: number;
|
|
13
|
+
measures?: number;
|
|
14
|
+
lastMeasures?: number;
|
|
15
|
+
codec?: string;
|
|
16
|
+
originator?: string;
|
|
17
|
+
rules?: any;
|
|
18
|
+
audioLevel?: AudioLevelStats;
|
|
19
|
+
mos?: MosLevelStats;
|
|
20
|
+
codecId?: string;
|
|
21
|
+
audioStats?: any;
|
|
22
|
+
packetStats?: any;
|
|
23
|
+
jitterMs?: any;
|
|
24
|
+
mediaSourceId?: string;
|
|
25
|
+
deltaPacketsLost?: number;
|
|
26
|
+
totalPacketsLost?: number;
|
|
27
|
+
deltaPackets?: number;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Per-ssrc baseline the L2 stall-detection burst (`getStatsFromDataL2`) keeps between ticks — one
|
|
31
|
+
* entry per remote audio participant on a shared PUBSUB session, seeded from the matching L1
|
|
32
|
+
* `WebrtcStatisticsSsrc.audioStats` baseline on the first L2 tick (see `startStatsL2`).
|
|
33
|
+
*/
|
|
34
|
+
export interface WebrtcStatisticsL2SsrcState {
|
|
35
|
+
totalPacketsLost: number;
|
|
36
|
+
totalAudioPacketsReceived?: number;
|
|
37
|
+
totalAudioPacketsLost?: number;
|
|
38
|
+
bytesReceived?: number;
|
|
39
|
+
}
|
|
40
|
+
export interface AudioLevelStats {
|
|
41
|
+
percentMuted: number;
|
|
42
|
+
percentQuiet: number;
|
|
43
|
+
percentBackground: number;
|
|
44
|
+
percentActive: number;
|
|
45
|
+
percentLoud: number;
|
|
46
|
+
}
|
|
47
|
+
export interface MosLevelStats {
|
|
48
|
+
percentVeryHigh: number;
|
|
49
|
+
percentHigh: number;
|
|
50
|
+
percentMedium: number;
|
|
51
|
+
percentLow: number;
|
|
52
|
+
percentMediocre: number;
|
|
53
|
+
mean: number;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* A white call is a connected call where one or both parties hear nothing
|
|
57
|
+
* for the whole connected duration (see RQRAINB-14350).
|
|
58
|
+
*/
|
|
59
|
+
export type WhiteCallDirection = "unknown" | "none" | "both" | "inbound" | "outbound";
|
|
60
|
+
export type WhiteCallReason = "unknown" | "none" | "nopackets" | "nosamples" | "novolume" | "inaudible";
|
|
61
|
+
export interface WhiteCallObservation {
|
|
62
|
+
direction: WhiteCallDirection;
|
|
63
|
+
reasonInbound: WhiteCallReason;
|
|
64
|
+
reasonOutbound: WhiteCallReason;
|
|
65
|
+
}
|
|
66
|
+
export interface WebrtcStatisticsNetwork {
|
|
67
|
+
/**
|
|
68
|
+
* Type of interface usedCan be "wifi", "vpn", "ethernet", "unknown", "cellular"
|
|
69
|
+
* From networkType in local-candidate report
|
|
70
|
+
*/
|
|
71
|
+
networkType?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Route used by the peer-connectionFormat: <local_address>: [type] (protocol) <-> <remote_address>: [type] (protocol)
|
|
74
|
+
* Computed from statistics in local_candidate and remote_candidate depending on the localCandidateId and remoteCandidateId in the candidate-pair report in use (selectedCandidatePairId in tranport report or selected=true in candidate-pair report
|
|
75
|
+
*/
|
|
76
|
+
candidatePair?: string;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Object containing all stats related to the output-rtp (outflow)
|
|
80
|
+
*/
|
|
81
|
+
export interface WebrtcStatisticsOutboundAudio {
|
|
82
|
+
/**
|
|
83
|
+
* The total of packets sent from the beginning of this RTP stream.From packetsSent in outbound-rtp report
|
|
84
|
+
*/
|
|
85
|
+
totalPacketsSent?: number;
|
|
86
|
+
/**
|
|
87
|
+
* The total of bytes sent from the beginning of this RTP stream.From bytesSent outbound-rtp report
|
|
88
|
+
*/
|
|
89
|
+
totalBytesSent?: number;
|
|
90
|
+
/**
|
|
91
|
+
* The delta of the audio KB sent between the current and the last iteration
|
|
92
|
+
*/
|
|
93
|
+
deltaAudioKBSent?: number;
|
|
94
|
+
/**
|
|
95
|
+
* The current encoder target in bits per second for this RTP stream.From targetBitrate in outbound-rtp report
|
|
96
|
+
*/
|
|
97
|
+
targetBitrate?: number;
|
|
98
|
+
/**
|
|
99
|
+
* Represents the audio level of the media source detected from the input device
|
|
100
|
+
*/
|
|
101
|
+
audioInputLevel?: number;
|
|
102
|
+
/**
|
|
103
|
+
* If exist, the value of the media identification-tag negotiated for this RTP streamFrom mid in inbound-rtp or outbound-rtp report
|
|
104
|
+
*/
|
|
105
|
+
mid?: number;
|
|
106
|
+
/**
|
|
107
|
+
* Name of the inbound codec used (eg: "opus")
|
|
108
|
+
* Computed from mimeType (remove "audio/") in the codec report associated to this RTP Stream (codecId from the inbound-rtp report)
|
|
109
|
+
*/
|
|
110
|
+
codec?: string;
|
|
111
|
+
/**
|
|
112
|
+
* The total of audio energy received or sent from the beginning of this RTP stream.
|
|
113
|
+
*/
|
|
114
|
+
totalAudioEnergy?: string;
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Object containing all stats related to the inbound-rtp (inflow)
|
|
118
|
+
*/
|
|
119
|
+
export interface WebrtcStatisticsInboundAudio {
|
|
120
|
+
/**
|
|
121
|
+
* The total of packets received from the beginning of this RTP stream.From packetsReceived in inbound-rtp report
|
|
122
|
+
*/
|
|
123
|
+
totalPacketsReceived?: number;
|
|
124
|
+
/**
|
|
125
|
+
* The total of packets discarded from the beginning of this RTP stream.From packetsDiscarded in inbound-rtp report
|
|
126
|
+
*/
|
|
127
|
+
totalPacketsReceivedDiscarded?: number;
|
|
128
|
+
/**
|
|
129
|
+
* The total of packets lost from the beginning of this RTP stream.From packetsLost in inbound-rtp report
|
|
130
|
+
*/
|
|
131
|
+
totalPacketsLost?: number;
|
|
132
|
+
/**
|
|
133
|
+
* The total of bytes received from the beginning of this RTP stream.From bytesReceived inbound-rtp report
|
|
134
|
+
*/
|
|
135
|
+
totalBytesReceived?: number;
|
|
136
|
+
/**
|
|
137
|
+
* The number of packets received for this RTP stream from the last measurement. Computed from packetsReceived in inbound-rtp report
|
|
138
|
+
*/
|
|
139
|
+
deltaPacketsReceived?: number;
|
|
140
|
+
/**
|
|
141
|
+
* The number of KB received for this RTP stream since the last measurement.
|
|
142
|
+
*/
|
|
143
|
+
deltaKBReceived?: number;
|
|
144
|
+
/**
|
|
145
|
+
* Mean of the round trip time during the last interval.Computed from totalRoundTripTime and roundTripTimeMeasurements in remote-outbound-rtp report
|
|
146
|
+
*/
|
|
147
|
+
roundTripTimeMs?: number;
|
|
148
|
+
/**
|
|
149
|
+
* Mean of the jitter buffer delay during the last interval.Computed From jitterBufferDelay and jitterBufferEmittedCount in inbound-rtp report
|
|
150
|
+
*/
|
|
151
|
+
jitterBufferMs?: number;
|
|
152
|
+
/**
|
|
153
|
+
* Value of the jitter for the current measurement.From jitter in inbound-rtp report
|
|
154
|
+
*/
|
|
155
|
+
jitterMs?: number;
|
|
156
|
+
/**
|
|
157
|
+
* Mean for the last interval. Computed from the codec used, the absolute delay computed and the packets lost.
|
|
158
|
+
*/
|
|
159
|
+
mos?: number;
|
|
160
|
+
/**
|
|
161
|
+
* Name of the inbound codec used (eg: "opus")
|
|
162
|
+
* Computed from mimeType (remove "audio/") in the codec report associated to this RTP Stream (codecId from the inbound-rtp report)
|
|
163
|
+
*/
|
|
164
|
+
codec?: string;
|
|
165
|
+
/**
|
|
166
|
+
* If exist, the value of the media identification-tag negotiated for this RTP streamFrom mid in inbound-rtp or outbound-rtp report
|
|
167
|
+
*/
|
|
168
|
+
mid?: number;
|
|
169
|
+
/**
|
|
170
|
+
* The MEAN MOS value for the current session
|
|
171
|
+
*/
|
|
172
|
+
meanMOS?: number;
|
|
173
|
+
/**
|
|
174
|
+
* Represents the audio level of the media source seen from the output device
|
|
175
|
+
*/
|
|
176
|
+
audioOutputLevel?: number;
|
|
177
|
+
/**
|
|
178
|
+
* Represents the absolute delay computed with: absoluteDelay:number = 20 + RTT/2 + JitterBufferDelay where
|
|
179
|
+
* 20 represents the packetization time (fixed value) in milliseconds
|
|
180
|
+
* RTT as computed in Compute the Round Trip Time in milliseconds
|
|
181
|
+
* JitterBufferDelay in milliseconds
|
|
182
|
+
*/
|
|
183
|
+
absDelayMs?: number;
|
|
184
|
+
/**
|
|
185
|
+
* A value indicating the current quality of the incoming audio based on the MOS value; Values are 0, 1, 2; as 0 is bad, 3 is good
|
|
186
|
+
*/
|
|
187
|
+
networkQualityValue?: number;
|
|
188
|
+
/**
|
|
189
|
+
* A SSRC Identifiant
|
|
190
|
+
*/
|
|
191
|
+
ssrc?: string;
|
|
192
|
+
/**
|
|
193
|
+
* The total of audio energy received or sent from the beginning of this RTP stream.
|
|
194
|
+
*/
|
|
195
|
+
totalAudioEnergy?: string;
|
|
196
|
+
/**
|
|
197
|
+
* Mean of the difference between the processing time and the buffer time during the last interval
|
|
198
|
+
*/
|
|
199
|
+
processingMs?: number;
|
|
200
|
+
/**
|
|
201
|
+
* Mean of the playout delay during the last interval
|
|
202
|
+
*/
|
|
203
|
+
playoutDelayMs?: number;
|
|
204
|
+
/**
|
|
205
|
+
* Counter. Inbound The total of FEC packets used from the beginning of this RTP stream.Computed from (fecPacketsReceived - fecPacketsDiscarded) (inbound-rtp report)
|
|
206
|
+
*/
|
|
207
|
+
totalFecPacketsUsed?: number;
|
|
208
|
+
/**
|
|
209
|
+
* Counter. Inbound The total of packets pulled out of the Jitter Buffer from the beginning of this RTP stream.From jitterBufferEmittedCount (inbound-rtp report)
|
|
210
|
+
*/
|
|
211
|
+
totalJitterBufferEmittedCount?: number;
|
|
212
|
+
/**
|
|
213
|
+
* Counter. Inbound The total of concealed samples from the beginning of this RTP stream.From concealedSamples (inbound-rtp report)
|
|
214
|
+
*/
|
|
215
|
+
totalConcealedSamples?: number;
|
|
216
|
+
/**
|
|
217
|
+
* Counter. Inbound The total of samples received from the beginning of this RTP stream.From samplesReceived (inbound-rtp report)
|
|
218
|
+
*/
|
|
219
|
+
totalSamplesReceived?: number;
|
|
220
|
+
/**
|
|
221
|
+
* Gauge (0..1). Inbound The average loudness for the last intervalComputed from Math.sqrt(totalAudioEnergy / totalSamplesDuration) (inbound-rtp report). With totalSamplesDuration in seconds.
|
|
222
|
+
*/
|
|
223
|
+
rms?: number;
|
|
224
|
+
/**
|
|
225
|
+
* Counter. Inbound The total of packets emitted for playout from the beginning of this RTP stream.From totalSamplesCount (media-playout report)
|
|
226
|
+
*/
|
|
227
|
+
totalSamplesCount?: number;
|
|
228
|
+
/**
|
|
229
|
+
* Gauge (0..100%). Inbound The percentage of synthesized samples played for the last interval of this RTP streamComputed from synthesizedSamplesDuration and totalSamplesDuration (media-playout report)
|
|
230
|
+
*/
|
|
231
|
+
synthesizedSamplesPlayed?: number;
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* Interface containing all stats related to the audio stats for the sessions output-rtp (outflow) + input-rtp (inflow)
|
|
235
|
+
*/
|
|
236
|
+
export interface WebrtcStatisticsAudio {
|
|
237
|
+
/**
|
|
238
|
+
* Object containing all stats related to the output-rtp (outflow)
|
|
239
|
+
*/
|
|
240
|
+
sent?: WebrtcStatisticsOutboundAudio;
|
|
241
|
+
/**
|
|
242
|
+
* Object containing all stats related to the inbound-rtp (inflow)
|
|
243
|
+
*/
|
|
244
|
+
received?: WebrtcStatisticsInboundAudio;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Interface containing all stats related to the OUTBOUND video stats for the sessions
|
|
248
|
+
* NOTE The same interface is also related to the screen sharing, as in terms of WEBRTC it's a VIDEO stream
|
|
249
|
+
*/
|
|
250
|
+
export interface WebrtcStatisticsOutboundVideo {
|
|
251
|
+
/**
|
|
252
|
+
* The total of packets sent from the beginning of this RTP stream. From packetsSent in outbound-rtp report
|
|
253
|
+
*/
|
|
254
|
+
totalPacketsSent?: number;
|
|
255
|
+
/**
|
|
256
|
+
* The total of bytes sent from the beginning of this RTP stream. From bytesSent outbound-rtp report
|
|
257
|
+
*/
|
|
258
|
+
totalBytesSent?: number;
|
|
259
|
+
/**
|
|
260
|
+
* The total time for encoding the media from the beginning of this RTP stream. From totalEncodeTime in outbound-rtp report
|
|
261
|
+
*/
|
|
262
|
+
totalEncodeTimeSeconds?: number;
|
|
263
|
+
/**
|
|
264
|
+
* The total number of video frames sent from the beginning of this RTP stream. From framesSent in outbound-rtp report
|
|
265
|
+
*/
|
|
266
|
+
totalFramesSent?: number;
|
|
267
|
+
/**
|
|
268
|
+
* The number of frames that were successfully encoded from the beginning of this RTP stream.From framesEncoded in outbound-rtp report
|
|
269
|
+
*/
|
|
270
|
+
totalFramesEncoded?: number;
|
|
271
|
+
/**
|
|
272
|
+
* The number of key frames that were successfully encoded from the beginning of this RTP stream.From keyFramesEncoded in outbound-rtp report
|
|
273
|
+
*/
|
|
274
|
+
totalKeyFramesEncoded?: number;
|
|
275
|
+
/**
|
|
276
|
+
* The number of Picture Loss Indication (PLI) requests sent (receiver) or received (sender) from the beginning of this RTP stream.
|
|
277
|
+
* From pliCount in outbound-rtp report
|
|
278
|
+
*/
|
|
279
|
+
totalPliCount?: number;
|
|
280
|
+
/**
|
|
281
|
+
* The number of Negative Acknowledgment (NACK) requests sent from the beginning of this RTP stream. From nackCount in outbound-rtp report
|
|
282
|
+
*/
|
|
283
|
+
totalNackCount?: number;
|
|
284
|
+
/**
|
|
285
|
+
* The current encoder target in bits per second for this RTP stream.From targetBitrate in outbound-rtp report
|
|
286
|
+
*/
|
|
287
|
+
targetBitrate?: number;
|
|
288
|
+
/**
|
|
289
|
+
* The number of horizontal pixels in a video frame for this RTP stream.From frameWidth in inbound-rtp or outbound-rtp report
|
|
290
|
+
*/
|
|
291
|
+
frameWidth?: number;
|
|
292
|
+
/**
|
|
293
|
+
* The number of vertical pixels in a video frame for this RTP stream.From frameHeigh in inbound-rtp or outbound-rtp report
|
|
294
|
+
*/
|
|
295
|
+
frameHeight?: number;
|
|
296
|
+
/**
|
|
297
|
+
* The number of individual video frames sent per second at a given time.
|
|
298
|
+
*/
|
|
299
|
+
framesPerSecond?: number;
|
|
300
|
+
/**
|
|
301
|
+
* The current reason for limiting the resolution and/or framerate. Acceptable values: bandwidth, cpu, other, none.
|
|
302
|
+
*/
|
|
303
|
+
qualityLimitationReason?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Object containing the details about all quality limitations durations during the session
|
|
306
|
+
*/
|
|
307
|
+
qualityLimitationDurations?: any;
|
|
308
|
+
/**
|
|
309
|
+
* If exist, the value of the media identification-tag negotiated for this RTP streamFrom mid in inbound-rtp or outbound-rtp report
|
|
310
|
+
*/
|
|
311
|
+
mid?: number;
|
|
312
|
+
/**
|
|
313
|
+
* The rate of retransmitted packets sent per second.
|
|
314
|
+
* This metric is useful for evaluating the stability and quality of a WebRTC connection by indicating how many packets needed to be resent to maintain data integrity.
|
|
315
|
+
*/
|
|
316
|
+
retransmittedPacketsSent?: number;
|
|
317
|
+
/**
|
|
318
|
+
* The average Quantization Parameter (QP) used for encoding a video stream, normalized by the number of frames encoded.
|
|
319
|
+
* The Quantization Parameter (QP) is a crucial factor in video compression and directly affects the quality and bitrate of the video.
|
|
320
|
+
* The Quantization Parameter (QP) controls the level of compression during video encoding. Lower QP values (e.g., around 10-20) correspond to higher video quality because the encoding process uses more bits to represent each frame.
|
|
321
|
+
* Higher QP values (e.g., 30-50) result in higher compression and lower video quality, as fewer bits are used per frame.
|
|
322
|
+
*/
|
|
323
|
+
qpValue?: number;
|
|
324
|
+
/**
|
|
325
|
+
* Name of the codec used (eg: "vp8")Computed from mimeType (remove "audio/") in the codec report associated to this RTP Stream (codecId from the inbound-rtp report)
|
|
326
|
+
*/
|
|
327
|
+
codec?: string;
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* Interface containing all stats related to the INBOUND video stats for the sessions
|
|
331
|
+
* NOTE The same interface is also related to the screen sharing, as in terms of WEBRTC it's a VIDEO stream
|
|
332
|
+
*/
|
|
333
|
+
export interface WebrtcStatisticsInboundVideo {
|
|
334
|
+
/**
|
|
335
|
+
* The total of packets received from the beginning of this RTP stream. From packetsReceived in inbound-rtp report
|
|
336
|
+
*/
|
|
337
|
+
totalPacketsReceived?: number;
|
|
338
|
+
/**
|
|
339
|
+
* The total of packets discarded from the beginning of this RTP stream.From packetsDiscarded in inbound-rtp report
|
|
340
|
+
*/
|
|
341
|
+
totalPacketsReceivedDiscarded?: number;
|
|
342
|
+
/**
|
|
343
|
+
* The total of packets lost from the beginning of this RTP stream.From packetsLost in inbound-rtp report
|
|
344
|
+
*/
|
|
345
|
+
totalPacketsLost?: number;
|
|
346
|
+
/**
|
|
347
|
+
* The total of bytes received from the beginning of this RTP stream.From bytesReceived inbound-rtp report
|
|
348
|
+
*/
|
|
349
|
+
totalBytesReceived?: number;
|
|
350
|
+
/**
|
|
351
|
+
* The number of KB received for this RTP stream since the last measurement.
|
|
352
|
+
*/
|
|
353
|
+
deltaKBReceived?: number;
|
|
354
|
+
/**
|
|
355
|
+
* The total time for decoding the media from the beginning of this RTP stream.From totalDecodeTime in inbound-rtp report
|
|
356
|
+
*/
|
|
357
|
+
totalDecodeTimeSeconds?: number;
|
|
358
|
+
/**
|
|
359
|
+
* The total number of video frames received from the beginning of this RTP stream.From framesReceived in inbound-rtp report
|
|
360
|
+
*/
|
|
361
|
+
totalFramesReceived?: number;
|
|
362
|
+
/**
|
|
363
|
+
* The number of frames that were successfully decoded from the beginning of this RTP stream.From framesDecoded in inbound-rtp report
|
|
364
|
+
*/
|
|
365
|
+
totalFramesDecoded?: number;
|
|
366
|
+
/**
|
|
367
|
+
* The number of key frames that were successfully decoded from the beginning of this RTP stream.From keyFramesDecoded in inbound-rtp report
|
|
368
|
+
*/
|
|
369
|
+
totalKeyFramesDecoded?: number;
|
|
370
|
+
/**
|
|
371
|
+
* The number of frames that were received but not displayed or processed (e.g., due to delays or quality degradation) from the beginning of this RTP stream.
|
|
372
|
+
* From framesDropped in inbound-rtp report
|
|
373
|
+
*/
|
|
374
|
+
totalFramesDropped?: number;
|
|
375
|
+
/**
|
|
376
|
+
* The number of video freeze experienced by the receiver from the beginning of this RTP stream.From freezeCount in inbound-rtp report
|
|
377
|
+
*/
|
|
378
|
+
totalFreezeCount?: number;
|
|
379
|
+
/**
|
|
380
|
+
* The number of Picture Loss Indication (PLI) requests sent (receiver) or received (sender) from the beginning of this RTP stream.
|
|
381
|
+
*/
|
|
382
|
+
totalPliCount?: number;
|
|
383
|
+
/**
|
|
384
|
+
* The number of Negative Acknowledgment (NACK) requests sent from the beginning of this RTP stream.From nackCount in outbound-rtp report
|
|
385
|
+
*/
|
|
386
|
+
totalNackCount?: number;
|
|
387
|
+
/**
|
|
388
|
+
* The number of horizontal pixels in a video frame for this RTP stream.From frameWidth in inbound-rtp or outbound-rtp report
|
|
389
|
+
*/
|
|
390
|
+
frameWidth?: number;
|
|
391
|
+
/**
|
|
392
|
+
* The number of vertical pixels in a video frame for this RTP stream. From frameHeigh in inbound-rtp or outbound-rtp report
|
|
393
|
+
*/
|
|
394
|
+
frameHeight?: number;
|
|
395
|
+
/**
|
|
396
|
+
* The number of individual video frames received per second at a given time.
|
|
397
|
+
*/
|
|
398
|
+
framesPerSecond?: number;
|
|
399
|
+
/**
|
|
400
|
+
* If exist, the value of the media identification-tag negotiated for this RTP streamFrom mid in inbound-rtp or outbound-rtp report
|
|
401
|
+
*/
|
|
402
|
+
mid?: number;
|
|
403
|
+
/**
|
|
404
|
+
* The number of times the media playback has been paused. A pause can happen due to various reasons, including network conditions, user actions, or system-level issues such as performance bottlenecks.
|
|
405
|
+
*/
|
|
406
|
+
pauseCount?: number;
|
|
407
|
+
/**
|
|
408
|
+
* Name of the codec used (eg: "vp8")Computed from mimeType (remove "audio/") in the codec report associated to this RTP Stream (codecId from the inbound-rtp report)
|
|
409
|
+
*/
|
|
410
|
+
codec?: string;
|
|
411
|
+
/**
|
|
412
|
+
* The RTP synchronization source identifying this stream. From ssrc in the inbound-rtp report.
|
|
413
|
+
* Logged for the same reason it is on the audio side: it is the only identifier shared with the SFU,
|
|
414
|
+
* so without it a video/sharing stream observed here cannot be matched against what Janus relayed.
|
|
415
|
+
* In a BUNDLE session audio and video travel on one transport but keep distinct ssrcs, so the audio
|
|
416
|
+
* one does NOT identify the video stream (CRRAINB-53618).
|
|
417
|
+
*/
|
|
418
|
+
ssrc?: string;
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Interface containing all stats related to the video stats for the sessions inbound/outbound
|
|
422
|
+
* NOTE The same interface is also related to the screen sharing, as in terms of WEBRTC it's a VIDEO stream
|
|
423
|
+
*/
|
|
424
|
+
export interface WebrtcStatisticsVideo {
|
|
425
|
+
/**
|
|
426
|
+
* Object containing all stats related to the outbound-rtp (outflow)
|
|
427
|
+
* NB In case of SIMULCAST (only available for Bubble Conferences), there're 3 substreams send to the distant party ("l", "m", "h" for low, medium, high);
|
|
428
|
+
*/
|
|
429
|
+
sent?: WebrtcStatisticsOutboundVideo & {
|
|
430
|
+
type: "singlecast";
|
|
431
|
+
} | {
|
|
432
|
+
type: "multicast";
|
|
433
|
+
l: WebrtcStatisticsOutboundVideo;
|
|
434
|
+
m: WebrtcStatisticsOutboundVideo;
|
|
435
|
+
h: WebrtcStatisticsOutboundVideo;
|
|
436
|
+
};
|
|
437
|
+
/**
|
|
438
|
+
* Object containing all stats related to the inbound-rtp (inflow)
|
|
439
|
+
*/
|
|
440
|
+
received?: WebrtcStatisticsInboundVideo;
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* The type of the session
|
|
444
|
+
*/
|
|
445
|
+
export declare enum WebrtcStatisticsType {
|
|
446
|
+
CONFERENCE = "Conference",
|
|
447
|
+
WEBINAR = "Webinar",
|
|
448
|
+
P2P = "P2P"
|
|
449
|
+
}
|
|
450
|
+
/**
|
|
451
|
+
* The current media type of the session based on the kind of Media Streams inside
|
|
452
|
+
*/
|
|
453
|
+
export declare enum WebrtcStatisticsMediaType {
|
|
454
|
+
/**
|
|
455
|
+
* Audio only
|
|
456
|
+
*/
|
|
457
|
+
AUDIO = "AUDIO",
|
|
458
|
+
/**
|
|
459
|
+
* BUNDLE (audio + video)
|
|
460
|
+
*/
|
|
461
|
+
BUNDLE = "BUNDLE",
|
|
462
|
+
/**
|
|
463
|
+
* Video only
|
|
464
|
+
*/
|
|
465
|
+
VIDEO = "VIDEO",
|
|
466
|
+
/**
|
|
467
|
+
* Screen Sharing only
|
|
468
|
+
*/
|
|
469
|
+
SHARING = "SHARING"
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* The type of the session in terms of media direction: publisher only / receiver only / both
|
|
473
|
+
*/
|
|
474
|
+
export declare enum WebrtcStatisticsSessionType {
|
|
475
|
+
/**
|
|
476
|
+
* Subscriber and publisher (bidirectionnal)
|
|
477
|
+
*/
|
|
478
|
+
PUBSUB = "PUBSUB",
|
|
479
|
+
/**
|
|
480
|
+
* Subscriber (or receiver) of the media
|
|
481
|
+
*/
|
|
482
|
+
SUBSCRIBER = "SUBSCRIBER",
|
|
483
|
+
/**
|
|
484
|
+
* Publisher of the media
|
|
485
|
+
*/
|
|
486
|
+
PUBLISHER = "PUBLISHER"
|
|
487
|
+
}
|
|
488
|
+
export interface WebrtcStatisticsData {
|
|
489
|
+
/**
|
|
490
|
+
* The current iteration number of getting the statistics.
|
|
491
|
+
*/
|
|
492
|
+
iteration?: number;
|
|
493
|
+
/**
|
|
494
|
+
* The stats layer that produced this entry.
|
|
495
|
+
*/
|
|
496
|
+
layer?: "L1" | "L2";
|
|
497
|
+
/**
|
|
498
|
+
* The interval duration getting the statistics
|
|
499
|
+
*/
|
|
500
|
+
intervalDuration?: number;
|
|
501
|
+
/**
|
|
502
|
+
* The type of the session related to the statistics;
|
|
503
|
+
*/
|
|
504
|
+
type?: WebrtcStatisticsType;
|
|
505
|
+
/**
|
|
506
|
+
* In case the session is part of a bubble conference
|
|
507
|
+
*/
|
|
508
|
+
conferenceId?: string;
|
|
509
|
+
/**
|
|
510
|
+
* In case the session is part of a webinar
|
|
511
|
+
*/
|
|
512
|
+
webinarId?: string;
|
|
513
|
+
/**
|
|
514
|
+
* The session media type
|
|
515
|
+
*/
|
|
516
|
+
mediaType?: WebrtcStatisticsMediaType;
|
|
517
|
+
/**
|
|
518
|
+
* The session type
|
|
519
|
+
*/
|
|
520
|
+
sessionType?: WebrtcStatisticsSessionType;
|
|
521
|
+
/**
|
|
522
|
+
* The audio data, if available
|
|
523
|
+
*/
|
|
524
|
+
audio?: WebrtcStatisticsAudio;
|
|
525
|
+
/**
|
|
526
|
+
* The video data, if available
|
|
527
|
+
*/
|
|
528
|
+
video?: WebrtcStatisticsVideo;
|
|
529
|
+
/**
|
|
530
|
+
* The sharing data, if available
|
|
531
|
+
*/
|
|
532
|
+
sharing?: WebrtcStatisticsVideo;
|
|
533
|
+
/**
|
|
534
|
+
* The network data, if available
|
|
535
|
+
*/
|
|
536
|
+
network?: WebrtcStatisticsNetwork;
|
|
537
|
+
/**
|
|
538
|
+
* In case of web conference, the remote publisher id
|
|
539
|
+
*/
|
|
540
|
+
publisherId?: string;
|
|
541
|
+
/**
|
|
542
|
+
* In case of web conference, the remote publisher name (anonymized)
|
|
543
|
+
*/
|
|
544
|
+
publisherName?: string;
|
|
545
|
+
/**
|
|
546
|
+
* Snapshot of the connection-state and counters that feed directly into the L2 stall-detection
|
|
547
|
+
* algorithm. Present only on L2 events (populated by {@link WebrtcSessionStatsHandler.getStatsFromDataL2}).
|
|
548
|
+
*
|
|
549
|
+
* These are the exact values read immediately after each L2 tick:
|
|
550
|
+
* - {@link WebrtcStallSetUpStats.iceConnectionState} and {@link WebrtcStallSetUpStats.dtlsConnectionState}
|
|
551
|
+
* gate whether the stall check runs at all.
|
|
552
|
+
* - {@link WebrtcStallSetUpStats.lastRoundTripTimeMeasurements} is the primary stall indicator
|
|
553
|
+
* (frozen ICE ping responses).
|
|
554
|
+
* - {@link WebrtcStallSetUpStats.bytesReceived} is the secondary indicator used when DTLS is connected.
|
|
555
|
+
*/
|
|
556
|
+
setUpStats?: WebrtcStallSetUpStats;
|
|
557
|
+
/**
|
|
558
|
+
* Current CPU pressure level reported by the Compute Pressure API.
|
|
559
|
+
* Only populated on audio sessions in browsers that support PressureObserver (Chrome, Edge, Opera).
|
|
560
|
+
* Included in every L1 emission even when the value has not changed.
|
|
561
|
+
*/
|
|
562
|
+
cpuPressure?: CpuPressureState;
|
|
563
|
+
/**
|
|
564
|
+
* White call detection (RQRAINB-14350): whether one or both parties heard nothing for the
|
|
565
|
+
* whole connected duration of the call, computed from the cumulative inbound/outbound audio
|
|
566
|
+
* ssrc rules. Only populated on L1 events (populated by {@link WebrtcSessionStatsHandler.getStatsFromData}).
|
|
567
|
+
*/
|
|
568
|
+
whiteCall?: WhiteCallObservation;
|
|
569
|
+
/**
|
|
570
|
+
* Verdict of the stall-detection algorithm for this session at the time of the emission.
|
|
571
|
+
* Written on every L1 emission from `session.webrtcStats.stalled`. Declared here because it was
|
|
572
|
+
* previously assigned through an index signature and therefore invisible to consumers, even
|
|
573
|
+
* though it is one of the most useful fields when diagnosing a session that receives packets
|
|
574
|
+
* but produces no media.
|
|
575
|
+
*/
|
|
576
|
+
stalled?: boolean;
|
|
577
|
+
}
|
|
578
|
+
/**
|
|
579
|
+
* Connection-state snapshot and audio counters captured at the end of each L2 stats tick.
|
|
580
|
+
* All four fields are read directly by the stall-detection algorithm that runs immediately
|
|
581
|
+
* after {@link WebrtcSessionStatsHandler.getStatsFromDataL2} returns.
|
|
582
|
+
*/
|
|
583
|
+
export interface WebrtcStallSetUpStats {
|
|
584
|
+
/** ICE connection state of the peer connection at the time of this L2 tick. */
|
|
585
|
+
iceConnectionState: RTCIceConnectionState;
|
|
586
|
+
/** DTLS/transport connection state of the peer connection at the time of this L2 tick. */
|
|
587
|
+
dtlsConnectionState: RTCPeerConnectionState;
|
|
588
|
+
/**
|
|
589
|
+
* Total ICE ping responses received, accumulated since the start of the L2 session.
|
|
590
|
+
* Corresponds to `session.webrtcStatsL2.audio.lastRoundTripTimeMeasurements` and is the
|
|
591
|
+
* primary stall indicator — if this value does not grow across ticks the session is stalling.
|
|
592
|
+
*/
|
|
593
|
+
lastRoundTripTimeMeasurements: number;
|
|
594
|
+
/**
|
|
595
|
+
* Total audio bytes received, accumulated since the start of the L2 session.
|
|
596
|
+
* Corresponds to `session.webrtcStatsL2.audio.bytesReceived` and is the secondary stall
|
|
597
|
+
* indicator used when DTLS is also connected.
|
|
598
|
+
*/
|
|
599
|
+
bytesReceived: number;
|
|
600
|
+
}
|
|
601
|
+
/**
|
|
602
|
+
* Payload carried by the {@link StropheJingleEvents.ON_SESSION_METRICS} event.
|
|
603
|
+
*
|
|
604
|
+
* Emitted by {@link WebrtcSessionStatsHandler} after each stats collection cycle (both L1 and L2 layers).
|
|
605
|
+
* Consumers (e.g. `WebrtcConfigAndUtils`) listen on `jingle.rxSubject` and use this data to enrich
|
|
606
|
+
* the stats record with `clientVersion` / `desktopVersion` and persist it to `callsStats`.
|
|
607
|
+
*/
|
|
608
|
+
export interface JingleSessionMetricsEventData {
|
|
609
|
+
/** The session ID (`RTCPeerConnection` SID) that produced the stats. */
|
|
610
|
+
readonly sid: string;
|
|
611
|
+
/** The conference ID associated with this session, if any. */
|
|
612
|
+
readonly confId: string;
|
|
613
|
+
/** The fully computed stats record for this cycle. */
|
|
614
|
+
readonly webrtcStatsData: WebrtcStatisticsData;
|
|
615
|
+
/**
|
|
616
|
+
* The raw metric entries to persist server-side.
|
|
617
|
+
* Empty array for L2 cycles (diagnostic only, not sent to server).
|
|
618
|
+
*/
|
|
619
|
+
readonly metricsDataForServer: any[];
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* Payload carried by the {@link StropheJingleEvents.ON_STREAM_UPDATED} event.
|
|
623
|
+
*
|
|
624
|
+
* For **conference/webinar** sessions `medias` and `confId` are populated.
|
|
625
|
+
* For **P2P** sessions both fields are absent — listeners identify the call via `sid`.
|
|
626
|
+
*/
|
|
627
|
+
export interface JingleStreamUpdatedEventData {
|
|
628
|
+
/** Session ID of the peer connection that produced the stream update. */
|
|
629
|
+
readonly sid: string;
|
|
630
|
+
/**
|
|
631
|
+
* Present for conference/webinar sessions — indicates which media tracks are active in the stream.
|
|
632
|
+
* Absent for P2P sessions.
|
|
633
|
+
*/
|
|
634
|
+
readonly medias?: {
|
|
635
|
+
readonly audio: boolean;
|
|
636
|
+
readonly video: boolean;
|
|
637
|
+
};
|
|
638
|
+
/** Conference ID; absent for P2P sessions. */
|
|
639
|
+
readonly confId?: number;
|
|
640
|
+
}
|
|
641
|
+
export declare class WebrtcSessionStatsHandler {
|
|
642
|
+
private contactService;
|
|
643
|
+
private logger;
|
|
644
|
+
private settingsService;
|
|
645
|
+
private xmppService;
|
|
646
|
+
private currentCpuPressure;
|
|
647
|
+
private pressureObserver;
|
|
648
|
+
constructor();
|
|
649
|
+
private metricsValues;
|
|
650
|
+
setWebrtcMetricsValues(metrics: any): void;
|
|
651
|
+
/**
|
|
652
|
+
* Resolves the polling interval (ms) appropriate for this session.
|
|
653
|
+
*
|
|
654
|
+
* Rules (in priority order):
|
|
655
|
+
* 1. Echo-test sessions → 1 000 ms (fast feedback for the audio check screen)
|
|
656
|
+
* 2. P2P sessions → 5 000 ms
|
|
657
|
+
* 3. Conference / Webinar sessions → 5 000 ms for audio or bundle; 8000 for sharing / video
|
|
658
|
+
*
|
|
659
|
+
* The QA override (`localStorage.qaWebrtcStatsInterval`) is applied on top of this in
|
|
660
|
+
* {@link getStatsForSession} and always takes precedence.
|
|
661
|
+
*/
|
|
662
|
+
private resolveIntervalForSession;
|
|
663
|
+
getStatsForSession(session: JingleSession, intervalOverride?: number): any;
|
|
664
|
+
startCpuPressureMonitoring(sessionSid: string, sampleIntervalMs: number): void;
|
|
665
|
+
stopCpuPressureMonitoring(): void;
|
|
666
|
+
private buildWebrtcStatsData;
|
|
667
|
+
private startStatsL2;
|
|
668
|
+
private getStatsFromDataL2;
|
|
669
|
+
private getStatsFromData;
|
|
670
|
+
/**
|
|
671
|
+
* Helper functions to ease the calculation for ranges
|
|
672
|
+
*/
|
|
673
|
+
private prepareRangeForSsrc;
|
|
674
|
+
private calculateRulesForSsrc;
|
|
675
|
+
/**
|
|
676
|
+
* High Jitter (inbound / outbound audio ssrc)
|
|
677
|
+
* Rule Computation
|
|
678
|
+
When the Jitter exceeds this threshold, it often leads to noticeable degraded call quality—resulting in choppy audio or speech that seems to speed up or slow down from the user’s perspective.
|
|
679
|
+
|
|
680
|
+
For every Jitter value, count how many are:
|
|
681
|
+
|
|
682
|
+
Excellent: JITTER < SETTINGS_JITTER_FAIR
|
|
683
|
+
Fair: SETTINGS_JITTER_FAIR < JITTER <= SETTINGS_JITTER_BAD
|
|
684
|
+
Bad: SETTINGS_JITTER_BAD < JITTER <= SETTINGS_JITTER_MEDIOCRE
|
|
685
|
+
Mediocre: JITTER > SETTINGS_JITTER_MEDIOCRE
|
|
686
|
+
*/
|
|
687
|
+
private calculateHighJitterForSsrc;
|
|
688
|
+
/**
|
|
689
|
+
*
|
|
690
|
+
* When the RTT exceeds this threshold, it often leads to noticeable latency and degraded call quality—resulting in choppy audio or speech that seems to speed up or slow down from the user’s perspective.
|
|
691
|
+
|
|
692
|
+
* Ranges details
|
|
693
|
+
The ranges property stores the list of all mediocre periods. A period corresponds to a list of successive values that have incremented the counter.
|
|
694
|
+
|
|
695
|
+
Each period is a JSON structure containing the following properties:
|
|
696
|
+
|
|
697
|
+
start: It corresponds to the timestamp of the first element from a period (timestamp of the report)
|
|
698
|
+
durationPercent: It corresponds to the duration of the successive measures that have increased the counter - In percentage of the call
|
|
699
|
+
durationInSeconds (alternative or additional property): It corresponds to the duration of the successive measures that have increased the counter – In seconds
|
|
700
|
+
If no current period and a new value increments the counter --> create a new period (timestamp of new value, durationInSeconds= interval)
|
|
701
|
+
If there is a current period and a new value increments the counter --> increment the duration (durationInSeconds + interval)
|
|
702
|
+
If there is a current period and a new value doesn't increment the counter --> store the current period and reset it
|
|
703
|
+
if there is no current period and a new value doesn't increment the counter --> do nothing
|
|
704
|
+
*/
|
|
705
|
+
private calculateRangeRttForSsrc;
|
|
706
|
+
/**
|
|
707
|
+
* Rule Computation
|
|
708
|
+
When packet loss surpasses this threshold, it often causes noticeable audio degradation, leading to choppy or distorted sound as missing audio frames are concealed or replaced with synthetic sound.
|
|
709
|
+
|
|
710
|
+
For every packetLoss value (mean during the interval, as computed for the MOS), count how many are:
|
|
711
|
+
Excellent: packetLoss = 0
|
|
712
|
+
Fair: 0 < packetLoss <= SETTINGS_PACKETLOSS_BAD
|
|
713
|
+
Bad: SETTINGS_PACKETLOSS_BAD < packetLoss <= SETTINGS_PACKETLOSS_MEDIOCRE
|
|
714
|
+
Mediocre: RTT > SETTINGS_PACKETLOSS_MEDIOCRE
|
|
715
|
+
|
|
716
|
+
Ranges details
|
|
717
|
+
The ranges property stores the list of all mediocre periods. A period corresponds to a list of successive values that have incremented the counter.
|
|
718
|
+
*/
|
|
719
|
+
private calculateHighPacketLossForSsrc;
|
|
720
|
+
/**
|
|
721
|
+
*
|
|
722
|
+
*
|
|
723
|
+
* Audio packets are temporarily stored in a jitter buffer, where they are collected, reordered, and assembled into continuous audio samples.
|
|
724
|
+
The jitter buffer compensates for variations in network latency—such as delay or packet arrival times—ensuring the audio stream remains smooth and uninterrupted for the listener.
|
|
725
|
+
Sometimes packets seem to stay a long time in the buffer, whereas the network seems stable and without variation. This is called bufferbloat or high dejitter.
|
|
726
|
+
Bufferbloat can explain choppy audio or interrupted audio playback.
|
|
727
|
+
|
|
728
|
+
Ranges details
|
|
729
|
+
The ranges property stores the list of all mediocre periods. A period corresponds to a list of successive values that have incremented the counter.
|
|
730
|
+
Each period is a JSON structure containing the following properties:
|
|
731
|
+
start: It corresponds to the timestamp of the first element from a period (timestamp of the report)
|
|
732
|
+
durationPercent: It corresponds to the duration of the successive measures that have increased the counter - In percentage of the call
|
|
733
|
+
durationInSeconds (alternative or additional property): It corresponds to the duration of the successive measures that have increased the counter – In seconds
|
|
734
|
+
If no current period and a new value increments the counter --> create a new period (timestamp of new value, durationInSeconds= interval)
|
|
735
|
+
If there is a current period and a new value increments the counter --> increment the duration (durationInSeconds + interval)
|
|
736
|
+
If there is a current period and a new value doesn't increment the counter --> store the current period and reset it
|
|
737
|
+
if there is no current period and a new value doesn't increment the counter --> do nothing
|
|
738
|
+
*/
|
|
739
|
+
private calculateRangeHighDejitterForSsrc;
|
|
740
|
+
private calculateMosValuesForSsrc;
|
|
741
|
+
private calculateLateAudioValuesForSSRC;
|
|
742
|
+
private calculateHighSendAudioDelay;
|
|
743
|
+
/**
|
|
744
|
+
* CPU pressure (RQRAINB-14460)
|
|
745
|
+
* Rule Computation
|
|
746
|
+
When the CPU pressure reported is `serious` or `critical` it often causes noticeable audio degradation
|
|
747
|
+
(as well as video degradation), leading to choppy or distorted sound as missing audio frames are
|
|
748
|
+
concealed or replaced with synthetic sound.
|
|
749
|
+
|
|
750
|
+
This requirement is agnostic from the stream: the same session-level {@link currentCpuPressure}
|
|
751
|
+
reading (fed by the Compute Pressure API observer, see {@link startCpuPressureMonitoring}) is
|
|
752
|
+
recorded against every ssrc's own measure count, independently of its kind/direction.
|
|
753
|
+
|
|
754
|
+
Categories: percentUnknown (no reading available yet, or the browser doesn't support the
|
|
755
|
+
Compute Pressure API), percentNominal, percentFair, percentSerious, percentCritical.
|
|
756
|
+
The rule `value` is percentSerious + percentCritical.
|
|
757
|
+
|
|
758
|
+
Ranges details
|
|
759
|
+
The ranges property stores the list of all serious/critical periods combined, using the same
|
|
760
|
+
successive-measure bookkeeping as the other range-based rules (see {@link calculateRulesForSsrc}).
|
|
761
|
+
*/
|
|
762
|
+
private calculateCpuPressureForSsrc;
|
|
763
|
+
private calculateHighConcealmentValuesForSSRC;
|
|
764
|
+
private calculateNoPackets;
|
|
765
|
+
/**
|
|
766
|
+
* No samples (inbound audio ssrc)
|
|
767
|
+
* When there is no sample pulled out of the jitter buffer, the user will hear only silence
|
|
768
|
+
* or synthesized voice (when the gap is short).
|
|
769
|
+
* Also detects connected calls (ICE-wise) but without samples played.
|
|
770
|
+
*/
|
|
771
|
+
private calculateNoSamplesForSsrc;
|
|
772
|
+
/**
|
|
773
|
+
* White call detection (RQRAINB-14350).
|
|
774
|
+
* Computes the reason a given audio direction (inbound or outbound) is silent for the
|
|
775
|
+
* whole connected call, from the cumulative percentages already tracked on the ssrc
|
|
776
|
+
* (percentNoPacket / percentNoSamples / percentNoAudio / audioLevel).
|
|
777
|
+
* Evaluated top to bottom, first match wins -- mirrors the ticket's computation tables.
|
|
778
|
+
*/
|
|
779
|
+
private computeWhiteCallReason;
|
|
780
|
+
/**
|
|
781
|
+
* White call detection (RQRAINB-14350).
|
|
782
|
+
* A white call is a connected call where one or both parties hear nothing for the whole
|
|
783
|
+
* connected duration. Combines the per-direction reasons into the `direction` verdict,
|
|
784
|
+
* following the ticket's direction table (top to bottom, first match wins).
|
|
785
|
+
*/
|
|
786
|
+
private calculateWhiteCall;
|
|
787
|
+
private calculateHighSpeakerDelayForSSRC;
|
|
788
|
+
private calculateNoAudio;
|
|
789
|
+
private calculateAudioLevelValuesForSSRC;
|
|
790
|
+
}
|
|
791
|
+
//# sourceMappingURL=strophe.jingle.session.stats.d.ts.map
|