@livedigital/client 3.56.1 → 3.57.0-lk-5354-api-reference.1

package/dist/qoe/ScoresCalculator.d.ts

@@ -1,9 +1,34 @@
 import type { AudioStreamStats, VideoStreamStats, ScoresCalculatorConfig, DeviceType } from './types';
+/**
+ * Утилита для расчёта MOS-оценок на основе WebRTC-статистики.
+ *
+ * Подходит, если приложению нужно самостоятельно интерпретировать качество
+ * аудио и видео, строить индикаторы сети или принимать решения о деградации UI.
+ */
 export declare class ScoresCalculator {
     private readonly config;
     constructor(config?: ScoresCalculatorConfig);
+    /**
+     * Рассчитывает MOS-оценку качества аудиопотока.
+     *
+     * @param stats Частичный набор аудиометрик. Отсутствующие поля будут заполнены значениями по умолчанию.
+     * @returns Итоговая оценка качества аудио по шкале MOS.
+     */
     calculateAudioMOS(stats: Partial<AudioStreamStats>): number;
+    /**
+     * Рассчитывает MOS-оценку качества видеопотока.
+     *
+     * @param stats Частичный набор видеометрик. Отсутствующие поля будут заполнены значениями по умолчанию.
+     * @returns Итоговая оценка качества видео по шкале MOS.
+     */
     calculateVideoMOS(stats: Partial<VideoStreamStats>): number;
+    /**
+     * Объединяет аудио- и видеооценки в одну интегральную MOS-метрику.
+     *
+     * @param Qa MOS-оценка аудио.
+     * @param Qv MOS-оценка видео.
+     * @param deviceType Тип устройства, для которого нужно скорректировать итоговую модель восприятия.
+     */
     calculateAVCompositeMOS(Qa: number, Qv: number, deviceType?: DeviceType): number;
     private mergeConfig;
     private normalizeAudioStats;

package/dist/qoe/types.d.ts

@@ -1,29 +1,58 @@
 import type { ParsedConnectionStats, ParsedInboundAudioStreamStats, ParsedInboundVideoStreamStats, ParsedOutboundAudioStreamStats, ParsedOutboundVideoStreamStats, ParsedRemoteInboundStreamStats } from 'webrtc-issue-detector';
+/**
+ * Нормализованные метрики аудиопотока, которые используются при расчёте качества.
+ */
 export interface AudioStreamStats {
+    /** SSRC потока, к которому относятся расчётные метрики. */
     ssrc: number;
+    /** Доля потерянных аудиопакетов в процентах. */
     packetLoss: number;
+    /** Текущий bitrate потока. */
     bitrate: number;
+    /** Оценка RTT до удалённой стороны в миллисекундах. */
     roundTripTime: number;
+    /** Задержка буфера воспроизведения или кодирования в миллисекундах. */
     bufferDelay: number;
+    /** Показывает, включена ли FEC-защита для компенсации потерь пакетов. */
     fec: boolean;
+    /** Показывает, используется ли режим DTX для экономии полосы в тишине. */
     dtx: boolean;
 }
+/**
+ * Нормализованные метрики видеопотока, которые используются при расчёте качества.
+ */
 export interface VideoStreamStats {
+    /** SSRC потока, к которому относятся расчётные метрики. */
     ssrc: number;
+    /** Доля потерянных видеопакетов в процентах. */
     packetLoss: number;
+    /** Текущий bitrate потока. */
     bitrate: number;
+    /** Оценка RTT до удалённой стороны в миллисекундах. */
     roundTripTime: number;
+    /** Задержка буфера воспроизведения или кодирования в миллисекундах. */
     bufferDelay: number;
+    /** Кодек, которым сейчас кодируется или декодируется видео. */
     codec?: string;
+    /** Фактическая ширина потока. */
     width: number;
+    /** Фактическая высота потока. */
     height: number;
+    /** Ожидаемая ширина, с которой поток сравнивается при оценке качества. */
     expectedWidth: number;
+    /** Ожидаемая высота, с которой поток сравнивается при оценке качества. */
     expectedHeight: number;
+    /** Фактический frame rate потока. */
     frameRate: number;
+    /** Ожидаемый frame rate, на который ориентируется расчёт качества. */
     expectedFrameRate: number;
+    /** Подсказывает, нужно ли снижать штраф за низкий bitrate на исходящем видео. */
     decreaseOutboundPenalty?: boolean;
+    /** Отмечает статичный контент, например демонстрацию слайдов или документов. */
     isStaticContent?: boolean;
+    /** Среднее значение QP, полезное для интерпретации визуального качества кодирования. */
     averageQP?: number;
+    /** Причина ограничения качества, если браузер или encoder её сообщил. */
     qualityLimitationReason?: 'none' | 'bandwidth' | 'cpu' | 'other';
 }
 export interface AdaptedWIDStats {
@@ -56,8 +85,16 @@ export interface BaseCalculatorConfig {
     }>;
 }
 export type DeviceType = 'mobile' | 'pc' | 'tv';
+/**
+ * MOS-оценки качества аудио и видео в понятной для UI форме.
+ *
+ * Эти значения удобно использовать в индикаторах качества связи, диагностике
+ * и собственных правилах деградации интерфейса.
+ */
 export interface MOSScores {
+    /** Оценка качества аудио по шкале MOS. */
     Qa?: number;
+    /** Оценка качества видео по шкале MOS. */
     Qv?: number;
 }
 export interface ExpectedVideoParams {

package/dist/types/client.d.ts

@@ -2,26 +2,59 @@ import type EnhancedEventEmitter from '../EnhancedEventEmitter';
 import type { LogLevel, LogMessageHandler } from './common';
 import type { IssuesHandler, NetworkScoresUpdatedHandler } from './engine';
 import type { InitEffectsSDKParams } from './media';
+/**
+ * Параметры инициализации основного клиента SDK.
+ *
+ * Через этот объект приложение настраивает подключение к сигналингу, сбор
+ * диагностических данных, обработчики качества связи и интеграцию с эффектами.
+ */
 export interface ClientParams {
+    /**
+     * Выбирает движок шумоподавления для микрофонных треков.
+     *
+     * Используйте `asdk`, если хотите подключить внешний AI-движок, или `rnnoise`
+     * для встроенного варианта без дополнительной интеграции.
+     */
     denoiser?: 'rnnoise' | 'asdk';
+    /**
+     * Настройки интеграции с Audio Effects SDK для продвинутого шумоподавления.
+     */
     asdk?: {
+        /** Идентификатор клиента, выданный поставщиком Audio Effects SDK. */
         customerId?: string;
+        /** Версия ASDK-ресурсов, которые должно использовать приложение. */
         version?: '2.3.5';
+        /** Локальный каталог, из которого приложение раздаёт ASDK-ресурсы. */
         localDir?: string;
+        /** Явный URL SDK-ресурсов ASDK, если используется кастомная схема доставки. */
         sdk_url?: string;
+        /** URL API ASDK, если интеграция должна работать через отдельный endpoint. */
         api_url?: string;
     };
+    /** Позволяет передать собственный emitter, если приложение централизует обработку клиентских событий. */
     clientEventEmitter?: EnhancedEventEmitter;
+    /** Внутренний emitter SDK для продвинутых интеграций и отладки. Обычно передавать не требуется. */
     internalEventEmitter?: EnhancedEventEmitter;
+    /** Переопределяет адрес signaling-сервера, к которому будет подключаться клиент. */
     signalingServerUrl?: string;
+    /** Задаёт минимальный уровень подробности внутренних логов SDK. */
     logLevel?: LogLevel;
+    /** Позволяет перехватить внутренние сообщения SDK и встроить их в ваш логгер. */
     onLogMessage?: LogMessageHandler;
+    /** Вызывается, когда SDK обнаруживает сетевые или медийные проблемы качества. */
     onIssues?: IssuesHandler;
+    /** Вызывается при обновлении агрегированных сетевых оценок качества. */
     onNetworkScoresUpdated?: NetworkScoresUpdatedHandler;
+    /** Интервал опроса статистики WebRTC в миллисекундах. По умолчанию: 1000 мс. */
     getStatsInterval?: number;
+    /** Отключает детектор проблем WID, если приложение хочет обрабатывать это самостоятельно. */
     disableWid?: boolean;
+    /** Общие параметры инициализации движка видеоэффектов. */
     effectsSDKParams?: InitEffectsSDKParams;
+    /** Включает отправку аналитических данных SDK на серверные endpoint'ы. */
     sendAnalytics?: boolean;
+    /** Базовый путь к локально раздаваемым статическим ресурсам эффектов и WASM. */
     staticFilesPath?: string;
+    /** Переопределяет адрес API аналитики, если используется отдельная инфраструктура. */
     analyticsApiUrl?: string;
 }

package/dist/types/common.d.ts

@@ -39,6 +39,13 @@ export interface ConsumerData {
     appId: string;
     channelId: string;
 }
+/**
+ * Роль участника в канале.
+ *
+ * `host` — может публиковать медиатреки (камера, микрофон, экран).
+ * `audience` — только потребляет медиа, публикация недоступна по умолчанию.
+ * Роль определяется сервером на основе переданного signaling-токена.
+ */
 export type Role = 'audience' | 'host';
 export interface PeerResponse {
     id: string;
@@ -52,19 +59,46 @@ export interface PeerResponse {
     role: Role;
     loginDate: Date;
 }
+/**
+ * Список доступных на устройстве камер и микрофонов.
+ *
+ * Обычно возвращается после `client.detectDevices()` и используется для построения UI выбора устройств.
+ */
 export interface AvailableMediaDevices {
+    /** Найденные видеоустройства, доступные браузеру или приложению. */
     video: MediaDeviceInfo[];
+    /** Найденные аудиоустройства, доступные браузеру или приложению. */
     audio: MediaDeviceInfo[];
 }
+/**
+ * Параметры подключения к каналу.
+ *
+ * Это основной payload для входа в звонок: он связывает канал, токен доступа,
+ * роль участника и пользовательские метаданные сессии.
+ */
 export interface JoinChannelParams {
-    channelId: string;
+    /**
+     * Signaling-токен участника, выпущенный Moodhood API.
+     * Кодирует идентификатор канала, роль и срок действия сессии.
+     * Срок действия токена — 24 часа.
+     */
     token: string;
-    role: Role;
+    /** Пользовательские данные участника, которые будут доступны другим клиентам канала. Максимум 1 КБ. */
     appData?: Record<string, unknown>;
+    /**
+     * Включает P2P-режим для звонков один-на-один.
+     * Используйте, если в канале заведомо будет не более двух участников —
+     * это позволяет серверу оптимально распределить ресурсы.
+     */
     isP2pCall?: boolean;
 }
+/**
+ * Произвольное серверное событие канала, которое приложение может обработать в своей бизнес-логике.
+ */
 export interface ChannelEvent {
+    /** Имя события, отправленное серверной стороной. */
     eventName: string;
+    /** Payload события в свободной JSON-подобной форме. */
     data: Record<string, unknown>;
 }
 export interface PreferredLayersParams {
@@ -77,21 +111,38 @@ export interface ChangePreferredLayersParams {
     spatialLayer: number;
     temporalLayer: number;
 }
+/**
+ * Базовый набор настроек энкодера для локального трека.
+ */
 export type EncoderConfig = object;
 export type VideoCodec = 'h264' | 'vp8' | 'vp9';
 export type AudioCodec = 'opus';
+/**
+ * Настройки кодирования для локального видеотрека.
+ */
 export type VideoEncoderConfig = EncoderConfig & {
+    /** Предпочтительный видеокодек, если приложение хочет сузить выбор браузера. */
     preferredCodec?: VideoCodec;
+    /** Явная конфигурация simulcast/SVC-слоёв и bitrate-параметров. */
     encodings?: RtpEncodingParameters[];
+    /** Стартовый bitrate для Google-энкодеров, если нужно ускорить выход на целевое качество. */
     videoGoogleStartBitrate?: number;
 };
+/**
+ * Настройки кодирования для локального аудиотрека.
+ */
 export type AudioEncoderConfig = EncoderConfig & {
+    /** Предпочтительный аудиокодек. */
     preferredCodec?: AudioCodec;
+    /** Явная конфигурация encodings, если приложение хочет управлять параметрами транспорта. */
     encodings?: RtpEncodingParameters[];
+    /** Включает FEC для лучшей устойчивости аудио к потерям пакетов. */
     enableFec?: boolean;
+    /** Включает DTX, чтобы экономить полосу в моменты тишины. */
     enableDtx?: boolean;
 };
 export interface CreateTrackOptions {
+    /** Если `true`, исходный `MediaStreamTrack` будет остановлен при паузе или закрытии публикации. */
     stopTrackOnPause?: boolean;
 }
 export type BaseVideoTrackOptions = CreateTrackOptions & {
@@ -100,52 +151,103 @@ export type BaseVideoTrackOptions = CreateTrackOptions & {
 export type BaseAudioTrackOptions = CreateTrackOptions & {
     audio?: boolean | MediaTrackConstraints;
 };
+/**
+ * Параметры создания локального видеотрека с камеры.
+ */
 export type CreateCameraVideoTrackOptions = BaseVideoTrackOptions & {
     encoderConfig?: VideoEncoderConfig;
+    /** Включает поддержку видеоэффектов для создаваемого трека. */
     effects?: boolean;
+    /** Создаёт preview-вариант трека, если приложению нужно локальное превью без основной публикации. */
     isPreview?: boolean;
 };
+/**
+ * Параметры создания локального аудиотрека с микрофона.
+ */
 export type CreateMicrophoneAudioTrackOptions = BaseAudioTrackOptions & {
     encoderConfig?: AudioEncoderConfig;
+    /** Включает шумоподавление для создаваемого микрофонного трека. */
     noiseSuppression?: boolean;
+    /** Создаёт preview-вариант трека для локального мониторинга. */
     isPreview?: boolean;
 };
+/**
+ * Параметры создания треков для демонстрации экрана.
+ */
 export type CreateScreenMediaOptions = BaseVideoTrackOptions & BaseAudioTrackOptions & {
+    /** Настройки кодирования видеопотока экрана. */
     videoEncoderConfig?: VideoEncoderConfig;
+    /** Настройки кодирования системного или захваченного аудио. */
     audioEncoderConfig?: AudioEncoderConfig;
 };
+/**
+ * Параметры регистрации уже существующего видеотрека в SDK.
+ */
 export type CreateCustomVideoOptions = BaseVideoTrackOptions & {
     videoEncoderConfig?: VideoEncoderConfig;
+    /** Видеотрек, созданный приложением вне SDK. */
     videoTrack: MediaStreamTrack;
 };
+/**
+ * Параметры регистрации уже существующего аудиотрека в SDK.
+ */
 export type CreateCustomAudioOptions = BaseAudioTrackOptions & {
     audioEncoderConfig?: AudioEncoderConfig;
+    /** Аудиотрек, созданный приложением вне SDK. */
     audioTrack: MediaStreamTrack;
 };
+/**
+ * Логические метки треков, которыми SDK помечает разные источники медиа.
+ */
 export declare enum TrackLabel {
+    /** Основной видеотрек с камеры. */
     Camera = "camera",
+    /** Локальный preview-трек камеры. */
     CameraPreview = "camera-preview",
+    /** Основной аудиотрек с микрофона. */
     Microphone = "microphone",
+    /** Локальный preview-трек микрофона. */
     MicrophonePreview = "microphone-preview",
+    /** Видеотрек демонстрации экрана. */
     ScreenVideo = "screen-video",
+    /** Аудиотрек демонстрации экрана или системного звука. */
     ScreenAudio = "screen-audio",
+    /** Пользовательский видеотрек, переданный в SDK приложением. */
     CustomVideo = "custom-video",
+    /** Пользовательский аудиотрек, переданный в SDK приложением. */
     CustomAudio = "custom-audio",
+    /** Резервная метка для нераспознанного типа трека. */
     Unknown = "unknown"
 }
+/**
+ * Событие о публикации медиа участником.
+ */
 export interface PayloadOfPublishedMedia {
     producerId: string;
     kind: MediaKind;
+    /** Логическая метка трека, по которой удобно различать камеру, микрофон или screen share. */
     label: TrackLabel;
+    /** Показывает, опубликован ли трек в paused-состоянии. */
     paused: boolean;
 }
+/**
+ * Payload события о принудительном закрытии локального трека.
+ */
 export interface TrackForceClosedPayload {
+    /** Метка трека, который сервер или SDK принудительно остановил. */
     label: TrackLabel;
 }
+/**
+ * Параметры подписки на удалённый producer участника.
+ */
 export interface SubscribeOptions {
     producerId: string;
+    /** Если `true`, трек будет создан в muted-состоянии и его можно будет размьютить позже. */
     muted?: boolean;
 }
+/**
+ * Событие о прекращении публикации ранее опубликованного медиа.
+ */
 export type PayloadOfUnpublishedMedia = PayloadOfPublishedMedia;
 export type ChangePreferredLayersPayload = PreferredLayersParams & {
     consumerId: string;
@@ -189,8 +291,13 @@ export interface TransportConnectionTimeoutPayload {
 export type ExtendedRTCInboundRtpStreamStats = RTCInboundRtpStreamStats & {
     decoderImplementation?: string;
 };
+/**
+ * Состояние send и receive transport'ов клиента в удобной для диагностики форме.
+ */
 export interface TransportsStateInfo {
+    /** Состояние входящего transport'а, через который клиент получает медиа. */
     receive?: TransportStateInfo;
+    /** Состояние исходящего transport'а, через который клиент публикует медиа. */
     send?: TransportStateInfo;
 }
 export interface TransportStateInfo {
@@ -226,26 +333,45 @@ export interface CreateConsumerResponse {
     consumer: Consumer;
     isProducerPaused: boolean;
 }
+/**
+ * Типовые ошибки доступа к медиаустройствам.
+ */
 export declare enum DeviceErrors {
+    /** Браузер не нашёл запрошенное устройство. */
     NotFoundError = "NotFoundError",
+    /** На устройстве не найдено ни одной подходящей камеры или микрофона. */
     NoDevices = "NoDevices",
+    /** Устройство занято другим приложением или вкладкой. */
     DeviceIsBusy = "DeviceIsBusy",
+    /** Пользователь или браузер запретил доступ к устройству. */
     NotAllowedError = "NotAllowedError",
+    /** Неизвестная ошибка при запросе списка устройств. */
     RequestDevicesUnknownError = "RequestDevicesUnknownError"
 }
+/**
+ * Статистика входящего удалённого трека, полезная для диагностики подписки и качества приёма.
+ */
 export interface TrackInboundStats {
     consumerId: string;
     codec?: RTCRtpCodecParameters;
+    /** Текущий spatial layer, который реально получает клиент. */
     currentSpatialLayerParams?: SpatialLayerParams;
+    /** Слои, которые доступны для данного видеотрека на стороне отправителя. */
     availableSpatialLayers?: SpatialLayerParams[];
+    /** Слой, который приложение или SDK запрашивает у сервера в данный момент. */
     requestedSpatialLayer?: number;
     dtlsState?: RTCDtlsTransportState;
+    /** Нативная WebRTC-статистика входящего RTP-потока. */
     rtcStats?: ExtendedRTCInboundRtpStreamStats;
 }
+/**
+ * Статистика исходящего локального трека, полезная для диагностики публикации.
+ */
 export interface TrackOutboundStats {
     producerId?: string;
     codec?: RTCRtpCodecParameters;
     dtlsState?: RTCDtlsTransportState;
+    /** Нативная WebRTC-статистика исходящего RTP-потока. */
     rtcStats?: RTCOutboundRtpStreamStats;
 }
 export interface PeerTrackInfo {
@@ -262,6 +388,9 @@ export interface PeerTrackInfo {
     trackInboundStats?: TrackInboundStats;
     trackOutboundStats?: TrackOutboundStats;
 }
+/**
+ * Краткая информация о локальном треке в удобном для UI и диагностики виде.
+ */
 export interface BaseTrackInfo {
     trackId: string;
     readyState: MediaStreamTrackState;
@@ -272,16 +401,22 @@ export interface BaseTrackInfo {
     height?: number;
     frameRate?: number;
     aspectRatio?: number;
+    /** При наличии содержит техническую статистику опубликованного трека. */
     trackOutboundStats?: TrackOutboundStats;
 }
+/**
+ * Сводная информация об участнике канала и его активных треках.
+ */
 export interface PeerInfo {
     id: string;
+    /** Пользовательские данные участника, которые приложение сохранило в `appData`. */
     appData: Record<string, unknown>;
     role: Role;
     channelIds: string[];
     appId: string;
     uid?: string;
     loginDate: Date;
+    /** Текущие удалённые треки участника со статикой по каждому из них. */
     tracks: PeerTrackInfo[];
 }
 export interface UpdatePeerAppDataPayload {
@@ -300,8 +435,12 @@ export interface ForceCloseProducerPayload {
     peerId: string;
     label: TrackLabel;
 }
+/**
+ * Payload события, которым сервер просит подтвердить активность участника в канале.
+ */
 export interface ActivityConfirmationRequiredPayload {
     channelId: string;
+    /** Временное значение из серверного события, которое можно использовать для UI таймера или дедлайна подтверждения. */
     time: number;
 }
 export interface PeerShortData {
@@ -316,5 +455,11 @@ export type PeerSyncData = Omit<PeerShortData, 'appData'> & {
     appData?: string;
 };
 export type TransportAppData = AppData;
+/**
+ * Группа участника, которую приложение может использовать для прав и UI-ролей.
+ */
 export type PeerGroup = 'moderator' | 'user';
+/**
+ * Строковое представление пользовательских меток треков, применяемое в правах и сетевых payload'ах.
+ */
 export type TrackLabelString = 'camera' | 'microphone' | 'screen-video' | 'screen-audio' | 'custom-video' | 'custom-audio';

package/dist/types/engine.d.ts

@@ -4,8 +4,16 @@ import type { InconsistencyType } from '../engine/handlers/ChannelStateSyncEvent
 import type Peer from '../engine/Peer';
 import type { ActivityConfirmationRequiredPayload, AvailableMediaDevices, ChannelEvent, LogLevel, LogMessageHandler, PeerGroup, Role, TrackLabel } from './common';
 import type { BaseTrack, InitEffectsSDKParams, Track } from './media';
+/**
+ * Обработчик диагностических проблем, найденных в WebRTC-статистике.
+ *
+ * Подходит для логирования и собственной аналитики качества звонка.
+ */
 export type IssuesHandler = (issues: IssueDetectorResult) => void;
 export type StatsHandler = (stats: StatsReportItem[]) => void;
+/**
+ * Обработчик обновления агрегированных сетевых оценок качества.
+ */
 export type NetworkScoresUpdatedHandler = (networkScores: NetworkScores) => void;
 export interface CreateIssueDetectorParams {
     disableWid: boolean;
@@ -27,59 +35,93 @@ export interface ConnectParams {
     token: string;
     isP2pCall?: boolean;
 }
+/**
+ * Payload события о рассинхронизации локального состояния клиента с состоянием канала.
+ */
 export interface ChannelStateInconsistentPayload {
+    /** Категория найденной рассинхронизации. */
     type: InconsistencyType;
+    /** Идентификатор участника, если проблема относится к конкретному peer. */
     peerId?: string;
+    /** Идентификатор producer'а, если проблема связана с опубликованным медиа. */
     producerId?: string;
+    /** Идентификатор consumer'а, если проблема относится к подписке на удалённый трек. */
     consumerId?: string;
 }
+/**
+ * Payload события об изменении набора треков, которые участнику разрешено публиковать.
+ */
 export interface ProducePermissionsChangedPayload {
+    /** Обновлённый список разрешённых меток треков. */
     labels: TrackLabel[];
 }
 export interface GroupsChangedPayload {
     groups: PeerGroup[];
 }
+/**
+ * Event map emitted by `client.observer`.
+ */
 export interface ClientObserverEvents {
+    /** Пользовательское событие канала, пришедшее с серверной стороны. */
     [CLIENT_EVENTS.channelEvent]: [ChannelEvent];
+    /** Новый участник появился в канале и доступен в списке `client.peers`. */
     [CLIENT_EVENTS.peerJoined]: [Peer];
+    /** Участник покинул канал. */
     [CLIENT_EVENTS.peerLeft]: [peerId: string];
+    /** Сервер просит подтвердить, что участник всё ещё активен в звонке. */
     [CLIENT_EVENTS.activityConfirmationRequired]: [ActivityConfirmationRequiredPayload];
     [CLIENT_EVENTS.activityConfirmationAcquired]: [ChannelEvent];
     [CLIENT_EVENTS.activityConfirmationExpired]: [ChannelEvent];
+    /** Клиенту требуется переподключиться к каналу, чтобы восстановить рабочее состояние. */
     [CLIENT_EVENTS.channelRejoinRequired]: [];
     [CLIENT_EVENTS.devicesListUpdated]: [AvailableMediaDevices];
+    /** Один из transport'ов не смог установить соединение в ожидаемое время. */
     [CLIENT_EVENTS.transportConnectionTimeout]: [{
         reason: 'ice' | 'dtls';
         direction: 'receive' | 'send';
     }];
+    /** Локальный трек был принудительно остановлен и больше недоступен для публикации. */
     [CLIENT_EVENTS.trackForceClosed]: [{
         label: TrackLabel;
     }];
+    /** Операция с локальным треком завершилась ошибкой. */
     [CLIENT_EVENTS.trackFailed]: [{
         label: TrackLabel;
     }];
     [CLIENT_EVENTS.activeSpeakerChanged]: [{
         peer?: Peer;
     }];
+    /** Клиент временно потерял соединение с инфраструктурой звонка. */
     [CLIENT_EVENTS.connectionLost]: [];
+    /** Соединение с инфраструктурой звонка было восстановлено. */
     [CLIENT_EVENTS.connectionRestored]: [];
     [CLIENT_EVENTS.forcedDisconnect]: [];
+    /** Сервер отклонил подключение из-за невалидной или неподходящей авторизации. */
     [CLIENT_EVENTS.rejectUnauthorized]: [];
+    /** SDK обнаружил несогласованность состояния канала и локального клиента. */
     [CLIENT_EVENTS.channelStateInconsistent]: [ChannelStateInconsistentPayload];
+    /** Встроенное шумоподавление начало инициализацию. */
     [CLIENT_EVENTS.denoiserInitializing]: [boolean];
+    /** Шумоподавление успешно включено. */
     [CLIENT_EVENTS.denoiserEnabled]: [{
         type: string;
     }];
+    /** Шумоподавление отключено. */
     [CLIENT_EVENTS.denoiserDisabled]: [{
         type: string;
     }];
+    /** SDK переключился на резервный сценарий шумоподавления. */
     [CLIENT_EVENTS.denoiserFallback]: [];
+    /** Шумоподавление не удалось включить или поддерживать в рабочем состоянии. */
     [CLIENT_EVENTS.denoiserFailed]: [{
         cause: string;
         error?: unknown;
     }];
+    /** Видеоэффекты успешно включены для активного видеотрека. */
     [CLIENT_EVENTS.effectsEnabled]: [];
+    /** Видеоэффекты отключены. */
     [CLIENT_EVENTS.effectsDisabled]: [];
+    /** Операция с видеоэффектами завершилась ошибкой. */
     [CLIENT_EVENTS.effectsFailed]: [
         {
             cause: string;