@vkontakte/calls-sdk 2.6.2-dev.d0c4f88.0 → 2.6.2-dev.e28df14.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/CallsSDK.d.ts CHANGED
@@ -40,14 +40,17 @@ import IceServer from './types/IceServer';
40
40
  import MediaModifiers from './types/MediaModifiers';
41
41
  import { IVideoDimentions, MediaSettings } from './types/MediaSettings';
42
42
  import MuteStates from './types/MuteStates';
43
- import { IGetParticipantsParameters, OkUserId, ParticipantStateMapped } from './types/Participant';
43
+ import { IGetParticipantsParameters, OkUserId, ParticipantId, ParticipantStateMapped } from './types/Participant';
44
44
  import ParticipantLayout, { Layout, StopStream } from './types/ParticipantLayout';
45
45
  import { ParticipantListChunkParameters } from './types/ParticipantListChunk';
46
46
  import ParticipantPriority from './types/ParticipantPriority';
47
47
  import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
48
+ import { Room, RoomsUpdate, RoomParticipantUpdate } from './types/Room';
49
+ import RoomsEventType from './enums/RoomsEventType';
48
50
  import SignalingMessage from './types/SignalingMessage';
49
51
  import { WaitingHallResponse } from './types/WaitingHall';
50
52
  import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview } from './types/MovieShare';
53
+ import ConversationFeature from './enums/ConversationFeature';
51
54
  /**
52
55
  * Информация о текущем браузере
53
56
  */
@@ -186,9 +189,10 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
186
189
  * @param payload Дополнительные данные для передачи на сервер
187
190
  * @param joiningAllowed Создать токен комнаты для подключения по ссылке
188
191
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
192
+ * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
189
193
  */
190
- export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean): Promise<ConversationData>;
191
- export declare function callInternal(ids: OkUserId[], type: CallType, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean): Promise<ConversationData>;
194
+ export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
195
+ export declare function callInternal(ids: OkUserId[], type: CallType, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
192
196
  /**
193
197
  * Обработать пуш о входящем звонке
194
198
  *
@@ -395,9 +399,12 @@ export declare function customDataInternal(data: JSONObject, uid?: OkUserId | nu
395
399
  *
396
400
  * @param payload Дополнительные данные для передачи на сервер
397
401
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
402
+ * @param startConversationParameters Дополнительные параметры для создания звонка (например onlyAdminCanShareMovie)
398
403
  * @returns Токен комнаты
399
404
  */
400
- export declare function startConversation(payload?: string, requireAuthToJoin?: boolean): Promise<string>;
405
+ export declare function startConversation(payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie }?: {
406
+ onlyAdminCanShareMovie?: boolean;
407
+ }): Promise<string>;
401
408
  /**
402
409
  * Создать токен комнаты для подключения по ссылке к существующему звонку
403
410
  *
@@ -468,6 +475,34 @@ export declare function updateMovie(movieId: string, gain?: number, offset?: num
468
475
  * @param movieId
469
476
  */
470
477
  export declare function removeMovie(movieId: string): Promise<void>;
478
+ /**
479
+ * Обновить комнаты
480
+ * @param rooms id в случае обновления комнаты
481
+ * @param assignRandomly рандомно назначить участников комнаты из свободных в соответствии с participantCount
482
+ */
483
+ export declare function updateRooms(rooms: {
484
+ id?: number;
485
+ name?: string;
486
+ participantCount?: number;
487
+ active?: boolean;
488
+ }[], assignRandomly: boolean): Promise<void>;
489
+ /**
490
+ * Активировать комнаты
491
+ * @param roomIds
492
+ * @param deactivate
493
+ */
494
+ export declare function activateRooms(roomIds: number[], deactivate: boolean): Promise<void>;
495
+ /**
496
+ * Cменить комнату
497
+ * @param toRoomId
498
+ * @param participantId
499
+ */
500
+ export declare function switchRoom(toRoomId?: number, participantId?: ParticipantId): Promise<void>;
501
+ /**
502
+ * Удалить комнаты
503
+ * @param roomIds
504
+ */
505
+ export declare function removeRooms(roomIds: number[]): Promise<void>;
471
506
  /**
472
507
  * Устанавливает интервал обновления статистики и вызова `onStatistics`
473
508
  *
@@ -517,6 +552,7 @@ export declare function getWaitingHall(pageMarker?: string | null, count?: numbe
517
552
  export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
518
553
  export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<import("./types/ExternalId").ExternalParticipantListChunk>;
519
554
  export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
555
+ export declare function enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<void>;
520
556
  /**
521
557
  * Удаляет записи истории звонков
522
558
  *
@@ -527,5 +563,5 @@ export declare function removeHistoryRecords(recordIds: number[]): Promise<void>
527
563
  * Версия SDK
528
564
  */
529
565
  export declare function version(): string;
530
- export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, };
531
- export { Api, BaseApi, BaseLogger, BaseSignaling, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, Utils, TransportTopology, };
566
+ export type { AddParticipantParams, ConversationData, ConversationParams, ConversationResponse, ExternalId, ExternalParticipant, ExternalParticipantListMarkers as ExternalParticipantMarkers, ExternalParticipantId, HangupReasonData, IceServer, JSONArray, JSONObject, JSONType, Layout, MediaModifiers, MediaSettings, MuteStates, OkUserId, ParamsObject, ParticipantLayout, ParticipantPriority, ParticipantStateMapped, ParticipantStreamDescription, ParticipantListChunkParameters, IGetParticipantsParameters, SignalingMessage, StatResult, StopStream, WaitingHallResponse, IVideoDimentions, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, Room, RoomsUpdate, RoomParticipantUpdate, };
567
+ export { Api, BaseApi, BaseLogger, BaseSignaling, CallDirection, CallType, ChatRoomEventType, ConversationOption, DebugMessageType, ExternalIdType, FacingMode, FatalError, HangupReason, HangupType, MediaOption, MediaTrackKind, MediaType, MuteState, ParticipantState, ParticipantStatus, RecordRole, Signaling, SignalingCommandType, SignalingConnectionType, SignalingNotification, UserRole, UserType, Utils, TransportTopology, RoomsEventType, };
@@ -19,8 +19,12 @@ export default abstract class BaseApi {
19
19
  abstract init(): void;
20
20
  abstract authorize(): Promise<void>;
21
21
  abstract userId(participantId: CompositeUserId): Promise<ExternalId>;
22
- abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean): Promise<ConversationResponse>;
23
- abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean): Promise<ConversationResponse>;
22
+ abstract createConversation(conversationId: string, payload?: string, requireAuthToJoin?: boolean, createConversationParameters?: {
23
+ onlyAdminCanShareMovie?: boolean;
24
+ }): Promise<ConversationResponse>;
25
+ abstract startConversation(conversationId: string, ids?: OkUserId[], type?: CallType, isVideo?: boolean, payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, createConversationParameters?: {
26
+ onlyAdminCanShareMovie?: boolean;
27
+ }): Promise<ConversationResponse>;
24
28
  abstract joinConversation(conversationId: string, isVideo?: boolean, chatId?: string): Promise<ConversationResponse>;
25
29
  createJoinLink(conversationId: string): Promise<{
26
30
  join_link: string;
@@ -2,6 +2,7 @@ import EventEmitter from '../classes/EventEmitter';
2
2
  import { ParticipantIdRegistry } from '../classes/ParticipantIdRegistry';
3
3
  import { PerfStatReport } from '../classes/transport/PerfStatReporter';
4
4
  import { TransportTopology } from '../classes/transport/Transport';
5
+ import ConversationFeature from '../enums/ConversationFeature';
5
6
  import ConversationOption from '../enums/ConversationOption';
6
7
  import MediaOption from '../enums/MediaOption';
7
8
  import RecordRole from '../enums/RecordRole';
@@ -60,6 +61,10 @@ export default abstract class BaseSignaling extends EventEmitter {
60
61
  abstract addMovie(data: IAddMovieParams): Promise<SignalingMessage>;
61
62
  abstract updateMovie(data: ISharedMovieState): Promise<SignalingMessage>;
62
63
  abstract removeMovie(data: any): Promise<SignalingMessage>;
64
+ abstract updateRooms(rooms: Record<any, any>[], assignRandomly: boolean): Promise<SignalingMessage>;
65
+ abstract activateRooms(roomIds: number[], deactivate: boolean): Promise<SignalingMessage>;
66
+ abstract switchRoom(toRoomId?: number, participantId?: ParticipantId): Promise<SignalingMessage>;
67
+ abstract removeRooms(roomIds: number[]): Promise<SignalingMessage>;
63
68
  abstract startStream(data: any): Promise<SignalingMessage>;
64
69
  abstract stopStream(): Promise<SignalingMessage>;
65
70
  abstract recordSetRole(participantId: ParticipantId, role: RecordRole | null): Promise<SignalingMessage>;
@@ -71,6 +76,7 @@ export default abstract class BaseSignaling extends EventEmitter {
71
76
  abstract customData(data: JSONObject, participantId: ParticipantId | null): Promise<SignalingMessage>;
72
77
  abstract grantRoles(participantId: CompositeUserId, roles: UserRole[], revoke: boolean): Promise<SignalingMessage>;
73
78
  abstract muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[]): Promise<SignalingMessage>;
79
+ abstract enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<SignalingMessage>;
74
80
  abstract pinParticipant(participantId: ParticipantId, unpin: boolean): Promise<SignalingMessage>;
75
81
  abstract updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
76
82
  abstract changeOptions(changes: {