@vkontakte/calls-sdk 2.6.2-beta.2 → 2.6.2-beta.21

package/static/Params.d.ts

@@ -7,10 +7,13 @@ import ConversationOption from '../enums/ConversationOption';
 import FatalError from '../enums/FatalError';
 import MediaOption from '../enums/MediaOption';
 import UserRole from '../enums/UserRole';
+import { IFeaturesPerRole } from '../types/ConversationFeature';
 import { ExternalId, ExternalParticipant, ExternalParticipantId, ExternalParticipantListChunk, ExternalParticipantListMarkers } from '../types/ExternalId';
+import { IFeedbackExternal } from '../types/Feedback';
 import IceServer from '../types/IceServer';
 import MediaModifiers from '../types/MediaModifiers';
 import MediaSettings from '../types/MediaSettings';
+import { IOnRemoteMovieData, ISharedMovieInfo, ISharedMovieState, ISharedMovieStoppedInfo } from '../types/MovieShare';
 import MuteStates from '../types/MuteStates';
 import { ParticipantStateMapped } from '../types/Participant';
 import AuthData from './AuthData';
@@ -24,6 +27,7 @@ import { FacingMode } from './WebRTCUtils';
 export declare type ParamsObject = {
     platform: string;
     clientType: string;
+    externalUserType: string;
     device: string;
     /**
      * API ключ приложения
@@ -43,6 +47,11 @@ export declare type ParamsObject = {
      * Домен, чтобы попасть в тестовую группу. Для тестирования экспериментальных улучшений существуют отдельные сервера, чтобы собирать фидбек и уже потом раскатывать на всех юзеров. Если передать сюда специальный ключ, то конверсейшн будет обрабатываться на таком сервере.
      */
     domain: string;
+    /**
+     * Домен, куда будет ходить Ok api за данными
+     * @hidden
+     */
+    externalDomain: string;
     iceServers: IceServer[];
     wssBase: string;
     wssToken: string;
@@ -186,6 +195,7 @@ export declare type ParamsObject = {
      * Работает только при приёме экрана через дата-канал.
      *
      * _По умолчанию: `true`_
+     * @deprecated
      */
     producerScreenTrack: boolean;
     /**
@@ -193,12 +203,19 @@ export declare type ParamsObject = {
      * Работает только при отправке экрана через дата-канал.
      *
      * _По умолчанию: `true`_
+     * @deprecated
      */
     consumerScreenTrack: boolean;
     producerNotificationDataChannel: boolean;
     producerCommandDataChannel: boolean;
     consumerScreenDataChannel: boolean;
     producerScreenDataChannel: boolean;
+    /**
+     * Размер пакета для отправки трансляции экрана в датаканал в байтах.
+     * Максимальный размер пакета 65536 bytes в хроме, но по стандарту лучше максимум 16 Кб.
+     * @hidden
+     */
+    consumerScreenDataChannelPacketSize: number;
     screenShareWebmBuilder: boolean;
     noiseSuppression: boolean;
     /**
@@ -239,6 +256,11 @@ export declare type ParamsObject = {
      * Включать RED-extension (redundancy) для p2p звонков
      */
     p2pAudioRed: boolean;
+    /**
+     * Добавлять флаг spsPpsIdrInKeyframe для h264 кодека. В результате ключевые фреймы без sps и pps
+     * не используются как ключевые. Решает проблему с артефактами на видео в случае потерь пакетов.
+     */
+    h264spsPpsIdrInKeyframe: boolean;
     /**
      * Получать список участников звонка третьим аргументом в `onConversation`
      * @hidden
@@ -292,7 +314,20 @@ export declare type ParamsObject = {
      * Получен стрим трансляция или мувик от собеседника.
      * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
      */
-    onRemoteLive?: (userId: ExternalParticipantId, streamId: string, stream: MediaStream | null) => void;
+    onRemoteLive?: (userId: ExternalParticipantId, data: IOnRemoteMovieData) => void;
+    /**
+     * Получен собственный стрим трансляция или мувик.
+     * Если сервер закончил стримить экран собеседника, вместо стрима будет передан null
+     */
+    onLocalLive?: (userId: ExternalParticipantId, data: IOnRemoteMovieData) => void;
+    /**
+     * Получено обновление стрима или лайва от собеседника.
+     */
+    onRemoteLiveUpdate?: (userId: ExternalParticipantId, data: ISharedMovieState) => void;
+    /**
+     * Получено обновление собственного стрима или лайва.
+     */
+    onLocalLiveUpdate?: (userId: ExternalParticipantId, data: ISharedMovieState) => void;
     /**
      * Начат звонок
      */
@@ -305,6 +340,26 @@ export declare type ParamsObject = {
      * Изменились данные стрима собеседника
      */
     onRemoteMediaSettings?: (userId: ExternalParticipantId, mediaSettings: MediaSettings, markers?: ExternalParticipantListMarkers) => void;
+    /**
+     * Изменились данные стрима собеседника
+     */
+    onLocalMediaSettings?: (userId: ExternalParticipantId, mediaSettings: MediaSettings) => void;
+    /**
+     * Полученны данные по стримам (лайв/мувик) от собеседника
+     */
+    onRemoteSharedMovieInfo?: (userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo) => void;
+    /**
+     * Полученны данные по остановленным стримам (лайв/мувик) от собеседника
+     */
+    onRemoteSharedMovieStoppedInfo?: (userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo) => void;
+    /**
+     * Полученны данные по собственным стримам (лайв/мувик)
+     */
+    onLocalSharedMovieInfo?: (userId: ExternalParticipantId, sharedMovieInfo: ISharedMovieInfo) => void;
+    /**
+     * Полученны данные по собственным остановленным стримам (лайв/мувик)
+     */
+    onLocalSharedMovieStoppedInfo?: (userId: ExternalParticipantId, sharedMovieStoppedInfo: ISharedMovieStoppedInfo) => void;
     /**
      * Добавили участника
      */
@@ -349,7 +404,7 @@ export declare type ParamsObject = {
     /**
      * Изменились состояния устройств пользователя или разрешения включать камеру/микрофон
      */
-    onMuteStates?: (muteStates: MuteStates, unmuteOptions: MediaOption[], mediaOptions: MediaOption[], muteAll: boolean, unmute: boolean, userId: ExternalParticipantId | null, adminId: ExternalParticipantId | null) => void;
+    onMuteStates?: (muteStates: MuteStates, unmuteOptions: MediaOption[], mediaOptions: MediaOption[], muteAll: boolean, unmute: boolean, userId: ExternalParticipantId | null, adminId: ExternalParticipantId | null, stateUpdated?: boolean, requestedMedia?: MediaOption[]) => void;
     /**
      * Изменились роли собеседника в звонке
      */
@@ -470,6 +525,22 @@ export declare type ParamsObject = {
      * @param joinLink токен присоединения к звонку
      */
     onJoinLinkChanged?: (joinLink: string) => void;
+    /**
+     * Получены новые реакции в звонке
+     * @param feedback массив с реакциями
+     */
+    onFeedback?: (feedback: IFeedbackExternal[]) => void;
+    /**
+     * Включать capability c аудио шарой
+     */
+    audioShareCapabilityEnabled: boolean;
+    /**
+     * Изменился список ролей, которым доступны ConversationFeatures
+     *
+     * @param featuresPerRole Объект вида ключ: ConversationFeature = значение: UserRole[]
+     * (если ключ фичи отсутствует, или в ролях пустой массив, считаем фичу доступной для всех пользователей)
+     */
+    onFeaturesPerRoleChanged?: (featuresPerRole: IFeaturesPerRole) => void;
 };
 export default abstract class Params {
     private static _params;
@@ -486,6 +557,8 @@ export default abstract class Params {
     static set platform(value: string);
     static get clientType(): string;
     static set clientType(value: string);
+    static get externalUserType(): string;
+    static set externalUserType(value: string);
     static get device(): string;
     static get apiKey(): string;
     static get apiEnv(): string;
@@ -495,6 +568,7 @@ export default abstract class Params {
     static get anonymToken(): string;
     static set anonymToken(value: string);
     static get domain(): string;
+    static get externalDomain(): string;
     static get iceServers(): IceServer[];
     static set iceServers(value: IceServer[]);
     static get wssBase(): string;
@@ -544,6 +618,7 @@ export default abstract class Params {
     static get producerCommandDataChannel(): boolean;
     static get consumerScreenDataChannel(): boolean;
     static get producerScreenDataChannel(): boolean;
+    static get consumerScreenDataChannelPacketSize(): number;
     static get screenShareWebmBuilder(): boolean;
     static get noiseSuppression(): boolean;
     static set noiseSuppression(value: boolean);
@@ -562,8 +637,10 @@ export default abstract class Params {
     static get participantListChunkInitCount(): number;
     static get serverAudioRed(): boolean;
     static get p2pAudioRed(): boolean;
+    static get h264spsPpsIdrInKeyframe(): boolean;
     static get batchParticipantsOnStart(): boolean;
     static get filterObservers(): boolean;
     static get muteMode(): boolean;
     static get preserveAudioTracks(): boolean;
+    static get audioShareCapabilityEnabled(): boolean;
 }

package/static/Utils.d.ts

@@ -6,7 +6,7 @@ import VideoSettings from '../types/VideoSettings';
 export declare const PARAMETERS_SEPARATOR = ":";
 export declare const DEVICE_IDX_PARAMETER = "d";
 declare namespace Utils {
-    function patchSDP(sdp: string, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, isAudioNack?: boolean, preferRed?: boolean): string;
+    function patchSDP(sdp: string, preferH264: boolean, brokenH264: boolean, preferVP9: boolean, h264spsPpsIdrInKeyframe: boolean, isAudioNack?: boolean, preferRed?: boolean): string;
     function getPeerIdString(peerId: SignalingMessage.PeerId): string;
     function comparePeerId(peerId1: SignalingMessage.PeerId, peerId2: SignalingMessage.PeerId): boolean;
     function getPeerConnectionHostInfo(pc: RTCPeerConnection): Promise<any>;
@@ -60,5 +60,9 @@ declare namespace Utils {
      * https://stash.odkl.ru/projects/ODKL/repos/odnoklassniki-webrtc/browse/src/main/java/one/webrtc/domain/conversation/ParticipantIndex.java#67-78
      */
     function participantMarkerCompare(marker1: ExternalParticipantListMarker | undefined, marker2: ExternalParticipantListMarker | undefined): number;
+    /** убирает все ключи со значением `V` на 1 уровне */
+    function objectFilterOutValues<T extends Record<string, V>, V = unknown>(obj: T, value?: V | V[]): Partial<T>;
+    function objectReduce<R, T extends Object>(obj: T, callback: (acc: R, value: T[keyof T], key: keyof T) => R, initialValue: R): R;
+    const setImmediate: (fn: VoidFunction) => VoidFunction;
 }
 export default Utils;

package/static/WebRTCUtils.d.ts

@@ -66,7 +66,7 @@ declare namespace WebRTCUtils {
     /**
      * Запрашивает трансляцию экрана пользователя
      */
-    function getScreenMedia(): Promise<MediaStream>;
+    function getScreenMedia(withAudioShare: boolean): Promise<MediaStream>;
     /**
      * Запрашивает камеру пользователя
      *
@@ -146,5 +146,6 @@ declare namespace WebRTCUtils {
      * Возвращает подверсию браузера (если она есть)
      */
     function browserSubVersion(): string;
+    function isAudioShareSupported(): boolean;
 }
 export default WebRTCUtils;

package/types/Conversation.d.ts

@@ -0,0 +1,12 @@
+import MediaOption from '../enums/MediaOption';
+import MediaSettings from './MediaSettings';
+import { Participant } from './Participant';
+export interface IProcessMuteStateParams {
+    mediaOptions?: MediaOption[];
+    muteAll?: boolean;
+    unmute?: boolean;
+    serverSettings?: MediaSettings | null;
+    admin?: Participant | null;
+    stateUpdated?: boolean;
+    requestedMedia?: MediaOption[];
+}

package/types/ConversationFeature.d.ts

@@ -0,0 +1,3 @@
+import ConversationFeature from '../enums/ConversationFeature';
+import UserRole from '../enums/UserRole';
+export declare type IFeaturesPerRole = Partial<Record<ConversationFeature, UserRole[]>>;

package/types/ConversationParams.d.ts

@@ -10,5 +10,6 @@ declare type ConversationParams = {
     isp_as_org?: string;
     loc_cc?: string;
     loc_reg?: string;
+    external_user_type: string;
 };
 export default ConversationParams;

package/types/ExternalId.d.ts

@@ -1,6 +1,7 @@
 import MediaOption from '../enums/MediaOption';
 import { ParticipantStatus } from '../static/External';
 import MediaSettings from './MediaSettings';
+import { ISharedMovieInfo } from './MovieShare';
 import MuteStates from './MuteStates';
 import { ParticipantListMarker, ParticipantListType, ParticipantStateMapped } from './Participant';
 import SignalingMessage from './SignalingMessage';
@@ -94,6 +95,7 @@ export interface ExternalParticipant {
      */
     unmuteOptions: MediaOption[];
     markers?: ExternalParticipantListMarkers;
+    movieShareInfos?: ISharedMovieInfo[];
 }
 export interface ExternalParticipantListChunk {
     participants: ExternalParticipant[];

package/types/Feedback.d.ts

@@ -0,0 +1,22 @@
+import { CompositeUserId } from './Participant';
+import { ExternalParticipantId } from './ExternalId';
+interface IFeedbackItem {
+    participantId: CompositeUserId;
+    /** event timestamps for this participant, chronologically */
+    times: number[];
+}
+export interface IFeedbackItemExternal extends Omit<IFeedbackItem, 'participantId'> {
+    participantId: ExternalParticipantId;
+}
+export interface IFeedback {
+    /** feedback ID; key values should be negotiated by clients themselves, like in ParticipantState, and have just the same restrictions; on backend the values of these keys are not bound in any way to those in ParticipantState */
+    key: string;
+    /** total amount of reactions of this type from the start of this call */
+    totalCount: number;
+    /** list of items containing initiator & all related data, if any */
+    items: IFeedbackItem[];
+}
+export interface IFeedbackExternal extends Omit<IFeedback, 'items'> {
+    items: IFeedbackItemExternal[];
+}
+export {};

package/types/LayoutUtils.d.ts

@@ -0,0 +1,5 @@
+import { Layout, RequestKeyFrame, StopStream } from './ParticipantLayout';
+export declare const REQUEST_KEY_FRAME_CODE = "kf";
+export declare function isStopStreaming(layout: Layout | StopStream | RequestKeyFrame): layout is StopStream;
+export declare function isRequestKeyFrame(layout: Layout | StopStream | RequestKeyFrame): layout is RequestKeyFrame;
+export declare function layoutToString(layout: Layout | StopStream | RequestKeyFrame): string;

package/types/MediaSettings.d.ts

@@ -14,12 +14,16 @@ export declare type MediaSettings = {
      * Включена ли трансляция экрана
      */
     isScreenSharingEnabled: boolean;
+    /**
+     * Включена ли трансляция звука
+     */
+    isAudioSharingEnabled: boolean;
     videoStreams: VideoStreamInfo[];
 };
 export declare type VideoStreamInfo = {
     id: string;
     source: string;
-    vkMovieId?: string;
+    externalMovieId?: string;
 };
 export default MediaSettings;
 export declare function compareMediaSettings(ms1: MediaSettings, ms2: MediaSettings): boolean;

package/types/MovieShare.d.ts

@@ -0,0 +1,55 @@
+import { OkUserId, CompositeUserId } from './Participant';
+import { MediaType } from './ParticipantStreamDescription';
+export interface IMoviePreview {
+    url: string;
+    width: number;
+    height: number;
+}
+export interface IAddMovieParams {
+    movieId: string;
+    gain?: number;
+    metadata?: {
+        title?: string;
+        thumbnails?: IMoviePreview[];
+    };
+}
+export declare type ISharedMovieStateResponse = [
+    number,
+    number,
+    boolean,
+    number,
+    boolean
+];
+export interface ISharedMovieState {
+    participantId: CompositeUserId;
+    gain?: number;
+    pause?: boolean;
+    offset?: number;
+    mute?: boolean;
+}
+export interface IUpdateMovieData {
+    movieId: string;
+    gain?: number;
+    pause?: boolean;
+    offset?: number;
+    mute?: boolean;
+}
+export interface ISharedMovieInfo {
+    movieId: OkUserId;
+    initiatorId: CompositeUserId;
+    title: string;
+    source: MediaType;
+    externalMovieId: string;
+    duration: number;
+    thumbnails: IMoviePreview[];
+}
+export interface ISharedMovieStoppedInfo {
+    movieId: OkUserId;
+    initiatorId: CompositeUserId;
+    source: MediaType;
+}
+export interface IOnRemoteMovieData {
+    streamName: string;
+    stream: MediaStream | null;
+    mediaType: MediaType;
+}

package/types/Participant.d.ts

@@ -4,6 +4,7 @@ import UserRole from '../enums/UserRole';
 import { ParticipantStatus } from '../static/External';
 import MediaSettings from '../types/MediaSettings';
 import { ExternalId, ExternalParticipantId, ExternalParticipantListMarkers } from './ExternalId';
+import { ISharedMovieInfo } from './MovieShare';
 import MuteStates from './MuteStates';
 import ParticipantLayout from './ParticipantLayout';
 /**
@@ -55,6 +56,7 @@ export interface Participant {
     unmuteOptions: MediaOption[];
     observedIds: CompositeUserId[];
     markers?: ExternalParticipantListMarkers;
+    movieShareInfos?: ISharedMovieInfo[];
 }
 export interface IGetParticipantsParameters {
     externalIds: ExternalId[];

package/types/ParticipantLayout.d.ts

@@ -31,10 +31,16 @@ export declare type StopStream = {
      */
     stopStream: true;
 };
+/**
+ * Request key frame from source. Should not be called often, negatively impacts video quality.
+ */
+export declare type RequestKeyFrame = {
+    keyFrameRequested: true;
+};
 /**
  * Лейаут собеседника в звонке
  */
-export declare type ParticipantLayout = (Layout | StopStream) & {
+export declare type ParticipantLayout = (Layout | StopStream | RequestKeyFrame) & {
     /**
      * Внешний ID пользователя
      */

package/types/ParticipantStreamDescription.d.ts

@@ -6,7 +6,8 @@ export declare enum MediaType {
     CAMERA = "CAMERA",
     SCREEN = "SCREEN",
     STREAM = "STREAM",
-    MOVIE = "MOVIE"
+    MOVIE = "MOVIE",
+    AUDIOSHARE = "AUDIOSHARE"
 }
 export declare function serializeParticipantStreamDescription(description: ParticipantStreamDescription): string;
 export declare function parseParticipantStreamDescription(descriptionString: string): ParticipantStreamDescription;

package/types/SignalingMessage.d.ts

@@ -7,8 +7,11 @@ import MediaOption from '../enums/MediaOption';
 import ParticipantState from '../enums/ParticipantState';
 import UserRole from '../enums/UserRole';
 import UserType from '../enums/UserType';
+import { IFeaturesPerRole } from './ConversationFeature';
+import { IFeedback } from './Feedback';
 import MediaModifiers from './MediaModifiers';
 import MediaSettings from './MediaSettings';
+import { ISharedMovieInfo, ISharedMovieState, ISharedMovieStoppedInfo } from './MovieShare';
 import MuteStates from './MuteStates';
 import { CompositeUserId, OkUserId, ParticipantId, ParticipantListMarker as ParticipantParticipantListMarker, ParticipantListMarkers, ParticipantListType as ParticipantParticipantListType } from './Participant';
 import VideoSettings from './VideoSettings';
@@ -54,6 +57,7 @@ declare namespace SignalingMessage {
         unmuteOptions?: MediaOption[];
         markers?: ParticipantListMarkers;
         observedIds?: CompositeUserId[];
+        movieShareInfos?: ISharedMovieInfo[];
     }
     export interface ParticipantListChunk extends Notification {
         participants: (Participant & Required<Pick<Participant, 'markers'>>)[];
@@ -72,6 +76,7 @@ declare namespace SignalingMessage {
         multichatId: string | null;
         tamtamMultichatId: string | null;
         recordInfo: RecordInfo | null;
+        featuresPerRole?: IFeaturesPerRole | null;
         pinnedParticipantId: ParticipantId | null;
         options: ConversationOption[];
         muteStates?: MuteStates;
@@ -148,6 +153,8 @@ declare namespace SignalingMessage {
         muteStates: MuteStates;
         unmuteOptions?: MediaOption[];
         mediaOptions: MediaOption[];
+        requestedMedia?: MediaOption[];
+        stateUpdated?: boolean;
         unmute?: boolean;
         muteAll?: boolean;
     }
@@ -184,6 +191,7 @@ declare namespace SignalingMessage {
     }
     export interface FeatureSetChanged extends Notification {
         features: ConversationFeature[];
+        featuresPerRole?: IFeaturesPerRole | null;
     }
     export interface MultipartyChatCreated extends Notification {
         chatId: string;
@@ -277,6 +285,20 @@ declare namespace SignalingMessage {
     export interface JoinLinkChanged extends Notification {
         joinLink: string;
     }
+    export interface Feedback extends Notification {
+        feedback: IFeedback[];
+    }
+    export interface SharedMovieState extends Notification {
+        data: ISharedMovieState[];
+    }
+    export interface SharedMovieInfo extends Notification {
+        movieShareInfo: ISharedMovieInfo;
+    }
+    export interface SharedMovieStoppedInfo extends Notification, ISharedMovieStoppedInfo {
+    }
+    export interface FeaturesPerRoleChanged extends Notification {
+        featuresPerRole?: IFeaturesPerRole | null;
+    }
     export {};
 }
 export default SignalingMessage;

package/types/WaitingHall.d.ts

@@ -1,6 +1,7 @@
 import { ExternalId } from './ExternalId';
 import { CompositeUserId } from './Participant';
 import SignalingMessage from './SignalingMessage';
+import { IFeedback } from './Feedback';
 export declare type WaitingParticipantId = {
     addedTs: number;
     id: CompositeUserId;
@@ -9,18 +10,11 @@ export declare type WaitingParticipant = {
     id: WaitingParticipantId;
     externalId?: SignalingMessage.ExternalId;
 };
-export declare type Feedback = {
-    key: string;
-    totalCount: number;
-    currentCount: number;
-    timeout: number;
-    participantIds: CompositeUserId[];
-};
 export declare type ChatRoom = {
     totalCount: number;
     firstParticipants?: WaitingParticipant[];
     handCount?: number;
-    feedback?: Feedback[];
+    feedback?: IFeedback[];
 };
 /**
  * Ответ на запрос `getWaitingHall`

package/utils/Conversation.d.ts

@@ -0,0 +1,2 @@
+import { MuteState, MediaOption, MuteStates } from '../CallsSDK';
+export declare const getMediaOptionsByMuteState: (muteStates: MuteStates, value: MuteState) => MediaOption[];

package/utils/MsgPackerBufferUtils.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Fork from messagepack internals.
+ * Package messagepack doesn't export createWriteBuffer and createReadBuffer methods.
+ */
+export declare function createWriteBuffer(): {
+    put(v: BufferSource): void;
+    putI8(v: number): void;
+    putI16(v: number): void;
+    putI32(v: number): void;
+    putI64(v: number): void;
+    putUi8(v: number): void;
+    putUi16(v: number): void;
+    putUi32(v: number): void;
+    putUi64(v: number): void;
+    putF(v: number): void;
+    ui8array(): Uint8Array;
+};
+export declare function createReadBuffer(buf: BufferSource): {
+    peek(): number;
+    get(len: number): ArrayBuffer;
+    getI8(): number;
+    getI16(): number;
+    getI32(): number;
+    getI64(): number;
+    getUi8(): number;
+    getUi16(): number;
+    getUi32(): number;
+    getUi64(): number;
+    getF32(): number;
+    getF64(): number;
+};