@azure/communication-calling package

Классы

CallClient	CallClient — это основная точка входа в пакет SDK. CallClient используется для создания CallAgent и получения DeviceManager.
LocalAudioStream	Представляет локальный аудиопоток для локального устройства michrophone
LocalVideoStream	Представляет локальный видеопоток для локального устройства камеры
VideoStreamRenderer	Отрисовщик видеопотока

Интерфейсы

AcceptCallOptions	Параметры приема входящего вызова. Передача видеопотоков, которые будут использоваться для приема входящего вызова. Если videoOptions не определен, входящий вызов будет принят с локальным видео отключенным. Если AudioOptions не определен, входящий вызов будет принят с микрофоном по умолчанию в качестве источника из диспетчера устройств.
ActiveAudioEffects	Представляет текущие активные звуковые эффекты
AddCommunicationUserOptions	Параметры добавления участника AddCommunicationUserOptions в вызов.
AddMicrosoftTeamsUserOptions	Параметры добавления участника MicrosoftTeamsUser в вызов.
AddPhoneNumberOptions	Параметры добавления участника ТСОП в вызов.
AddTeamsParticipantOptions	Параметры добавления участника Teams в вызов Teams.
AdmitAllOperationResult	Результат для допуска всех участников.
AdmitLobbyParticipantOptions	Варианты допуска участника из лобби.
AssignedBreakoutRoomsEvent	Имя интерфейса для события назначенной комнаты останова
AudioDeviceInfo	Сведения о микрофоне или устройстве динамиков.
AudioEffect	Базовый звуковой эффект.
AudioEffectsFeature	Интерфейс API для функции AudioEffects
AudioEffectsStartConfig	Представляет конфигурацию звуковых эффектов при запуске эффектов
AudioEffectsStopConfig	Представляет конфигурацию звуковых эффектов во время остановки эффектов
AudioInCallDiagnostics	Диагностика качества звука
AudioOptions	Параметры звука, предоставляемые при выполнении исходящего звонка или присоединении к групповому вызову.
AudioStreamFeature	Представляет функцию аудиопотока
AudioStreamFeatureContext	Представляет контекст, предоставленный для расширенных функций аудио-и видеопотока в конструкторе.
AudioStreamFeatureFactory	Представляет фабрику функций аудиопотока
BackgroundBlurEffect	Эффект размытия фона.
BackgroundReplacementConfig	Конфигурация фоновой замены.
BackgroundReplacementEffect	Эффект замены фона.
BaseFeature	Представляет базовый интерфейс для любой функции
BaseInCallDiagnostics	В собранной диагностике звонков
BreakoutRoom	Сведения о помещении для разбиения
BreakoutRoomsCallFeature	Функция вызова номеров для разбиения.
BreakoutRoomsEvent	Имя интерфейса для всех доступных событий breakoutRooms
BreakoutRoomsSettings	Параметры комнаты останова, доступные после присоединения пользователя к комнате прорыва
BreakoutRoomsSettingsEvent	Имя интерфейса для параметров останова доступных событий
Call	Представляет вызов.
CallAgent	CallAgent используется для обработки вызовов.
CallAgentCommon	Общий интерфейс CallAgent.
CallAgentFeature	Представляет функцию CallAgent.
CallAgentFeatureContext	Представляет контекст, предоставленный для расширенных функций агента вызова в конструкторе.
CallAgentFeatureFactory	Представляет фабрику функций агента вызова
CallAgentOptions	Параметры создания CallAgent.
CallClientFeature	Представляет функцию CallClient.
CallClientFeatureContext	Представляет контекст, предоставленный для расширенных функций клиента вызова в конструкторе.
CallClientFeatureFactory	Представляет фабрику функций агента клиента вызова
CallClientOptions	Параметры вызова клиента
CallCommon	Общий интерфейс вызова.
CallConstraints	Представляет ограничения для вызова
CallDiagnostics	Диагностика вызовов
CallEndReason	Описывает причину завершения вызова.
CallFeature	Представляет функцию вызова.
CallFeatureContext	Представляет контекст, предоставленный для расширенных функций вызова в конструкторе.
CallFeatureFactory	Представляет фабрику функций вызова
CallInfo	Сведения о вызове.
CallInfoCommon	Общий интерфейс CallInfo.
CallRating	Представляет рейтинг опроса вызовов.
CallSurvey	Представляет конец опроса звонков.
CallSurveyFeature	Функция динамической потоковой передачи ACS
CallSurveyResponse	Представляет конец ответа на опрос вызовов.
CallerInfo	Сведения о вызывающем объекте.
CapabilitiesChangeInfo	Структура данных, полученная для каждого события CapabilitiesChangedEventType.
CapabilitiesFeature	Функция возможностей.
Captions	Структура данных для объекта Captions
CaptionsCallFeature	Функция подписей
CaptionsCommon	Структура данных для объекта CaptionsCommon
CaptionsInfo	Структура данных, полученная для каждого события CaptionsReceivedEventType
CommunicationServicesError	Ошибка, которая вызывается при сбое вызова API.
CompositeAudioDeviceInfo	Сведения о составном звуковом устройстве.
CreateViewOptions	Параметры отрисовщика видеопотока.
CustomContext	Полученные параметры для пользовательского контекста вызова.
CustomContextOptions	Параметры для вызова настраиваемого контекста.
DataChannelCallFeature	Функция вызова DataChannel
DataChannelMessage	Сообщение DataChannel
DataChannelReceiver	Приемник DataChannel
DataChannelSender	Отправитель DataChannel
DebugInfoCallClientFeature	Функция для сведений об отладке вызова.
DebugInfoDump	Идентификатор дампа является уникальным идентификаторомIdentifier для каждого дампа сведений отладки
DeepNoiseSuppressionEffect	Эффект глубокого подавления шума
DeviceAccess	Разрешения, предоставленные пользователем.
DeviceCompatibility	Сведения о совместимости устройств
DeviceEnumeration	Сведения о перечислении устройств
DeviceManager	Диспетчер устройств используется для обработки системных устройств мультимедиа, таких как камеры, микрофоны и динамики.
DiagnosticOptions	Параметры диагностики
Disposable	Удаление объекта.
DominantSpeakersCallFeature	Функция для вызова доминирующего говорящего.
DominantSpeakersInfo	Сведения о доминирующих динамиках звонка
EmergencyCallOptions
EndpointDetails	Сведения о конечной точке удаленного участника
FeatureFactory	Представляет интерфейс для факторинга функции
GroupCallLocator	Указатель, используемый для присоединения к групповому вызову.
GroupChatCallLocator	Указатель, используемый для присоединения к групповому чату.
HangUpOptions	Параметры зависания звонка.
IceServer	Представляет ледяной сервер (ошеломляющий или поворот)
InCallDiagnostics	Сведения о диагностике вызова
IncomingAudioMediaStats	Универсальный тип статистики приема звука
IncomingCall	Представляет входящий вызов.
IncomingCallCommon	Общий интерфейс для входящих вызовов.
IncomingCallPushNotificationData	Данные push-уведомлений для входящих вызовов
IncomingVideoMediaStats	Универсальный тип статистики видео получения мультимедиа
Invitee	Сведения о приглашении
JoinBreakoutRoomsEvent	Имя типа события для присоединенного к разбиения
JoinCallOptions	Параметры присоединения к групповому вызову. Передача видеопотока, который будет использоваться для запуска вызова. Удаленные участники звонка получат видеопоток, чтобы он смог отобразить его в своих UIs. Передайте погоду звуковых параметров, чтобы присоединиться к вызову с отключенным или незамеченным. Если videoOptions не определен, вызов будет запущен с локальным видео отключенным.
LatestMediaDiagnostics	Последняя диагностика мультимедиа, которая была вызвана.
LatestNetworkDiagnostics	Последняя диагностика сети, которая была вызвана.
Lobby	Лобби собраний Teams
LocalRecordingCallFeature	Функция записи звонков.
LocalRecordingInfo	Сведения о локальной записи.
MediaConstraintRange	Диапазон ограничений
MediaDiagnostics	Диагностика мультимедиа
MediaStatsCallFeature	Функция получения статистики мультимедиа во время вызова.
MediaStatsCollector	Сборщик статистики мультимедиа.
MediaStatsReportSample	статистика мультимедиа из события sampleReported
MediaStatsReportSummary	Статистические статистические данные мультимедиа из события summaryReported
NetworkConfiguration	Представляет конфигурацию сети, которую необходимо задать при создании клиента вызова.
NetworkDiagnostics	Диагностика сети
OptimalVideoCountCallFeature	Функция для оптимального количества видео
OutgoingAudioMediaStats	Универсальный тип статистики отправки мультимедиа
OutgoingVideoMediaStats	Универсальный тип статистики отправки видео
PPTLiveCallFeature	Функция PPTLive.
ParticipantInfo	Представляет участника в вызове.
PermissionConstraints	Определите ограничения для доступа к локальным устройствам.
PreCallDiagnosticsFeature	Функция PreCallDiagnostics
ProxyConfiguration	Представляет конфигурацию прокси-сервера для отправки трафика через этот прокси-сервер.
RaiseHandCallFeature	Поднимите функцию реакции на вызов руки.
RaisedHand	Вызов объекта состояния руки
RaisedHandChangedEvent	Сведения о событии нижней руки
RatingScale	Масштабирование оценки для переопределения шкалы по умолчанию
ReactionCallFeature	Функция реакции на собрание.
ReactionEventPayload	Модель данных сообщения реакции
ReactionMessage	Тип сообщения реакции
RecordingCallFeature	Функция записи звонков.
RecordingInfo	Сведения о записи звонка.
RejectLobbyParticipantOptions	Варианты отклонения участника из лобби.
RejoinMainMeetingEvent	Имя типа события для основного присоединенного к собранию события
RemoteAudioStream	Удаленный аудиопоток вызова.
RemoteDiagnostics	Удаленная диагностика
RemoteParticipant	Представляет удаленного участника в вызове.
RemoteParticipantDiagnosticsData	Удаленная диагностика, которая была вызвана.
RemoteVideoStream	Представляет видео или общий доступ к экрану удаленного участника.
RemoteVideoStreamCommon	Представляет видео или общий доступ к экранам удаленного участника или потоковую трансляцию.
RoomCallLocator	Указатель, используемый для присоединения к вызову комнаты.
SpotlightCallFeature	Функция вызова в центре внимания.
SpotlightedParticipant	Измененный объект события в центре внимания
StartCallOptions	Параметры запуска исходящего вызова.
StartCaptionsOptions	Параметры, переданные в StartCaptions
StartTeamsCallOptions	Параметры запуска исходящего вызова Teams.
StartTeamsGroupCallOptions	Параметры запуска исходящего вызова группы Teams.
StreamSize	Размер потока.
SubmitSurveyOptions	Параметры отправки опроса звонков.
TeamsCall	Представляет вызов Teams.
TeamsCallAgent	TeamsCallAgent используется для обработки вызовов Teams.
TeamsCallAgentOptions	Параметры создания TeamsCallAgent.
TeamsCallInfo	Сведения о вызове Teams.
TeamsCaptions	Структура данных для объекта TeamsCaptions
TeamsCaptionsInfo	Структура данных, полученная для каждого события CaptionsReceivedEventType
TeamsIncomingCall	Повторно выполняет входящий вызов Teams.
TeamsMeetingAudioConferencingCallFeature	Функция вызова TeamsMeetingAudioConferencing.
TeamsMeetingAudioConferencingDetails	Представляет сведения о аудиоконференции собраний Teams
TeamsMeetingAudioConferencingPhoneNumber	Представляет номер телефона, назначенный мосту аудиоконференции
TeamsMeetingCoordinatesLocator	Указатель, используемый для присоединения к собранию с координатами собрания.
TeamsMeetingIdLocator	Указатель, используемый для присоединения к собранию с идентификатором собрания и кодом.
TeamsMeetingLinkLocator	Указатель, используемый для присоединения к собранию со ссылкой на собрание.
TogetherModeCallFeature	Функция вызова в режиме объединения.
TogetherModeSceneSize	Размер сцены в режиме объединения
TogetherModeSeatingPosition	Координаты CSS в режиме совместного размещения
TogetherModeVideoStream	Представляет видеопоток бота в режиме объединения.
TranscriptionCallFeature	Функция транскрибирования вызовов.
Transfer	Представляет объект передачи
TransferCallFeature	Функция для передачи звонков.
TransferErrorCode	Код ошибки передачи
TransferEventArgs	База событий передачи
TransferToCallLocator	Перенос вызова в другой вызов
TransferToCallOptions	Параметры передачи звонка на звонок
TransferToParticipantLocator	Передача звонка участнику
TransferToParticipantOptions	Параметры передачи вызова участнику
TransferToVoicemailLocator	Передача звонка в голосовую почту
TransferToVoicemailOptions	Параметры передачи звонка в голосовую почту
TransportMediaStats	Универсальный тип статистики транспорта мультимедиа
TurnConfiguration	Представляет конфигурацию сервера поворота для отправки всего трафика мультимедиа через него.
UserFacingDiagnosticsFeature	Функция диагностики вызовов.
VideoConstraints	Ограничение видеопотока
VideoDeviceInfo	Сведения об устройстве камеры.
VideoEffect	Базовый эффект видео.
VideoEffectConfig	Конфигурация базового видеоэффекта.
VideoEffectsFeature	Интерфейс API для функции VideoEffects
VideoInCallDiagnostics	Диагностика качества видео
VideoOptions	Представляет параметр видео в CallOption
VideoStreamFeature	Представляет функцию видеопотока
VideoStreamFeatureContext	Представляет контекст, предоставляемый для расширенных функций аудио-и видеопотока в конструкторе.
VideoStreamFeatureFactory	Представляет фабрику функций видеопотока
VideoStreamRendererView	Представление для видеопотока.
Volume

Псевдонимы типа

AudioDeviceType	Тип звукового устройства.
AudioEffectsFeatureErrorListener	Тип обратного вызова прослушивателя звуковых эффектов
AudioEffectsFeatureEvent	События функций звуковых эффектов
AudioEffectsFeatureListener	Тип обратного вызова прослушивателя звуковых эффектов
AudioIssue	Представляет конец проблем со звуком опроса звонков. Пример: NoLocalAudio - other participants unable to hear me. NoRemoteAudio - participant unable to hear another participant's audio. Echo - heard echo. AudioNoise - heard audio noise. LowVolume - call audio volume was low. AudioStoppedUnexpectedly - call audio stopped unexpectedly. DistortedSpeech - audio was distorted. AudioInterruption - audio was interrupted. OtherIssues - any other audio issue not listed here.
AudioSourceChangedEvent	Полезные данные для события изменения источника звука.
AudioStreamFeatureCtor	Представляет конструктор объекта AudioStreamFeature вместе с аргументом контекста.
BackgroundBlurConfig	Конфигурация размытия фона.
BreakoutRoomState	Состояние комнаты прорыва
BreakoutRoomsEventData	Имя типа события для всех обновленных событий BreakoutRooms
BreakoutRoomsUpdated	Имя типа события для всех обновленных номеров BreakoutRooms
BreakoutRoomsUpdatedListener	Определение обратного вызова для обработки событий комнат разбиения.
CallAgentFeatureCtor	Представляет конструктор для объектов CallAgentFeature, а также аргумент контекста.
CallClientFeatureCtor	Представляет конструктор для объектов CallClientFeature, а также аргумент контекста.
CallDirection	Направление вызова: "Входящий" "Исходящий"
CallEndedEvent	Полезные данные для события завершения вызова.
CallFeatureCtor	Представляет конструктор для объектов CallFeature, а также аргумент контекста.
CallInformationContext
CallInformationIdentifierKind
CallInformationScenario
CallInitializationResult	Состояния инициализации стека вызовов
CallState	Состояния вызова.
CapabilitiesChangeHandler	Определение обратного вызова для обработки события CaptionsReceivedEventType.
CapabilitiesChangedEventType	Тип события для измененных возможностей
CapabilitiesChangedReason	Измененная причина возможностей
CapabilityResolutionReason	Причина разрешения возможностей
CaptionLanguageChangedEventType	Тип события для измененного языка субтитров
CaptionsHandler	Определение обратного вызова для обработки события CaptionsReceivedEventType
CaptionsKind	Тип заголовков для классификации типа объекта Captions
CaptionsKindChangedEventType	Тип события для измененного типа субтитров
CaptionsPropertyChangedEventType	Тип события для свойства заголовков изменено событие
CaptionsReceivedEventType	Тип события для полученных подписей
CaptionsResultType	Тип для классификации окончательности транскрибирования текущей фразы CaptionInfo будет иметь ResultType of Partial, если текст содержит частично произнесенное предложение. CaptionInfo будет иметь resultType of Final, если после того, как предложение было полностью транскрибировано.
ChangedParticipantCapabilities	Измененные возможности участников
CollectionUpdatedEvent	Полезные данные для обновленного события коллекции.
CompositeAudioDeviceType	Тип составного звукового устройства.
ConnectionState	ConnectionState используется для указания состояния подключения CallAgent. "Подключено" — CallAgent подключен и готов к приему входящих вызовов. "Отключено" — CallAgent отключен и может не принимать входящие вызовы.
ConnectionStateChangedEvent	Полезные данные для события изменения состояния.
ConnectionStateChangedReason	Причина изменения состояния подключения.
DataChannelPriority	параметр приоритета в DataChannelSenderOpenOptions
DataChannelReceiverCloseEvent	Прослушиватель событий закрытия DataChannel
DataChannelReceiverCreatedEvent	Прослушиватель событий DataChannelReceiverCreated
DataChannelReceiverMessageReadyEvent	Прослушиватель событий DataChannel messageReady
DataChannelReliability	Параметр надежности в DataChannelSenderOpenOptions
DataChannelSenderOpenOptions	Параметры отправителя для создания объекта отправителя DataChannel
DeviceAvailabilityGrade	Оценка доступности устройств
DeviceSupportGrade	Оценка поддержки браузеров и ОС
DeviceType	Тип устройства.
DiagnosticChangedEventArgs	Аргументы прослушивателя для события "diagnosticChanged" значением является DiagnosticQuality или DiagnosticFlag: DiagnosticQuality = перечисление { Good = 1, Poor = 2, Bad = 3 }. DiagnosticFlag = true | ложный. valueType = 'DiagnosticQuality' | "DiagnosticFlag"
DiagnosticFlag	Логическое значение флага для логического диагностики, например DeviceSpeakTimeMuted, NoNetwork и т. д.
DiagnosticValueType	Тип диагностического значения. DiagnosticQuality или DiagnosticFlag
DtmfTone	Тон DTMF для вызовов ТСОП.
Environment	Сведения о браузере
EnvironmentInfo	Сведения о среде
GroupLocator	Указатель группы.
IncomingCallEvent	Полезные данные для входящего события вызова.
IncomingScreenShareMediaStats	Универсальный тип экранной общей папки получает статистику мультимедиа
LatestDiagnosticValue	Последнее значение для диагностики вызовов
LoweredHandEventType	Имя типа события для функции нижней руки
LoweredHandListener	Определение обратного вызова для обработки события LowerHandEventType.
MediaDiagnosticChangedEventArgs	диагностика — это тип диагностики мультимедиа, например говорящийTimeMicrophoneIsMuted, cameraStartFailed и т. д.
MediaDiagnosticType	Типы диагностики мультимедиа
MediaStatValue	Свойства статистики в событии summaryReported
MediaStatsAggregation	Свойства агрегирования для каждого поля статистики.
MediaStatsCollectorOptions	Параметры сборщика статистики мультимедиа
MediaStatsReportSampleEvent	Полезные данные для статистики мультимедиа, выдаваемой примером событияReported.
MediaStatsReportSummaryEvent	Полезные данные для статистики мультимедиа, выдаваемой событием summaryReported.
MediaStreamType	Тип потока мультимедиа. Видео — поток мультимедиа с устройства камеры ScreenSharing — поток мультимедиа с экрана, приложения или вкладки браузера RawMedia — поток мультимедиа необработанных видео или необработанный поток общего доступа к экранам LiveStream — поток мультимедиа из динамического потока Аудио — поток мультимедиа с аудиоустройства
MeetingLocator	Указатель на собрание.
NetworkDiagnosticChangedEventArgs	диагностика — это тип диагностики сети, например networkRcvQuality, noNetwrok и т. д. DeviceSpeakTimeMuted и т. д.
NetworkDiagnosticType	Тип сетевой диагностики
NoiseSuppressionEffectName	Представляет имена эффектов подавления шума
OutgoingScreenShareMediaStats	Универсальный тип общей папки отправки статистики мультимедиа
OverallIssue	Представляет конец вызовов опроса. Пример: CallCannotJoin - participant is unable to join the call. CallCannotInvite - participant is unable to add another participant in the call. HadToRejoin - participant rejoined the call due the call quality issue. CallEndedUnexpectedly - when the call ended unexpectedly. OtherIssues - any other overall call issue not listed here.
ParticipantCapabilities	Возможности участников
ParticipantCapabilityName	Причина разрешения возможностей
ParticipantRole	Роль участника.
PreCallDiagnosticsResult	Результаты диагностики
PropertyChangedEvent	Полезные данные для события изменения свойства.
PushNotificationData	Данные push-уведомлений
QualityGrade	Оценка качества звонка
RaisedHandEventType	Имя типа события для функции поднятия рук
RaisedHandListener	Определение обратного вызова для обработки события RaisedHandEventType.
Reaction	Типы реакций, определенные для всех
ReactionListener	Определение обратного вызова для обработки события ReactionEventType.
RemoteDiagnostic	Полезные данные диагностики для удаленных пользователей.
RemoteParticipantState	Состояние удаленного участника.
ResultCategories	Категории результатов ошибок
RoomLocator	Указатель комнаты.
RunOptions	Параметры PreCallDiagnostics
ScalingMode	Режим масштабирования для представления видеопотока.
ScreenshareIssue	Представляет конец проблем с общим доступом к опросу звонков. Пример: NoContentLocal - other participants unable to see my screen. NoContentRemote - participant unable to saw another participant's screen share. CannotPresent - participant was unable to share the screen. LowQuality - screen share video quality was low. Freezes - screen share freezes. StoppedUnexpectedly - screen share stopped unexpectedly. LargeDelay - watch screen share having large delay. OtherIssues - any other screen share issue not listed here.
ServerDiagnosticType	Диагностика сервера
SpokenLanguageChangedEventType	Тип события для подписей изменено событие
SpotlightChangedEventType	Имя типа события для функции "В центре внимания"
TeamsCaptionsHandler	Определение обратного вызова для обработки события CaptionsReceivedEventType
TeamsIncomingCallEvent	Полезные данные для события входящего вызова Teams.
TogetherModeSceneUpdatedListener	Определение обратного вызова для обработки события обновления сцены togetherMode.
TogetherModeSeatingMap	Сопоставление МРТ участника с местом сидения
TogetherModeSeatingUpdatedListener	Определение обратного вызова для обработки события обновления мест в вместемMode.
TranscriptionPropertyChangedEventType	Событие изменения свойства транскрибирования.
TransferAcceptedEvent	Событие принятия передачи
TransferAcceptedEventType	Имя типа события для передачи принято
TransferState	Состояние передачи
VideoDeviceType	Тип видеоустройства.
VideoEffectError	Тип ошибки эффекта видео.
VideoEffectErrorPayload	Полезные данные ошибки видеоэффекта.
VideoEffectName	Представляет имя эффекта видео.
VideoEffectProcessor	Тип объединения для всех эффектов
VideoEffectsFeatureErrorListener	Тип прослушивателя для функции подписки effectsError
VideoEffectsFeatureEvent	Типы событий подписки
VideoEffectsFeatureListener	Тип прослушивателя для функций подписки на функции подписок функций функций эффектов
VideoIssue	Представляет конец видеообращения. Пример: NoVideoReceived - participant unable to saw another participant's video. NoVideoSent - other participants unable to see me. LowQuality - video quality was low. Freezes - video freezes. StoppedUnexpectedly - video stopped unexpectedly. DarkVideoReceived - participant receives dark video. AudioVideoOutOfSync - participant watch video and audio out of sync. OtherIssues - any other video issue not listed here.
VideoSendConstraints	Представляет ограничения видеопотока
VideoSourceChangedEvent	Полезные данные для измененного события источника видео.
VideoStreamFeatureCtor	Представляет конструктор объекта VideoStreamFeature вместе с аргументом контекста.
xHeader	X-заголовок.

Перечисления

CallAgentKind	Тип объекта агента вызова.
CallKind	Тип объекта вызова.
DiagnosticQuality	Значение качества для диагностики, связанной с качеством, например NetworkSendQuality, NetworkRevQuality и т. д. Хорошо = 1, нет проблем. Бедная = 2, мягкая проблема. Bad = 3, серьезная проблема.
IncomingCallKind	Тип входящего объекта вызова.
LocalRecordingState	Локальное состояние перезаписи
RecordingState	Состояние записи.