@vkontakte/calls-sdk 2.6.2-dev.aa1b4e2.0 → 2.6.2-dev.aa45c56.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
@@ -9,6 +9,7 @@ import { ConversationData } from './classes/Conversation';
9
9
  import HangupReason, { HangupReasonData } from './classes/HangupReason';
10
10
  import { MediaTrackKind } from './classes/MediaSource';
11
11
  import { StatResult } from './classes/transport/Statistics';
12
+ import { TransportTopology } from './classes/transport/Transport';
12
13
  import Api from './default/Api';
13
14
  import Signaling from './default/Signaling';
14
15
  import CallDirection from './enums/CallDirection';
@@ -46,6 +47,11 @@ import ParticipantPriority from './types/ParticipantPriority';
46
47
  import { MediaType, ParticipantStreamDescription } from './types/ParticipantStreamDescription';
47
48
  import SignalingMessage from './types/SignalingMessage';
48
49
  import { WaitingHallResponse } from './types/WaitingHall';
50
+ import { IFeedbackExternal } from './types/Feedback';
51
+ import { ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData } from './types/MovieShare';
52
+ import ConversationFeature from './enums/ConversationFeature';
53
+ import { IFeaturesPerRole } from './types/ConversationFeature';
54
+ import { ArrayDequeue } from './utils/ArrayDequeue';
49
55
  /**
50
56
  * Информация о текущем браузере
51
57
  */
@@ -184,9 +190,10 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
184
190
  * @param payload Дополнительные данные для передачи на сервер
185
191
  * @param joiningAllowed Создать токен комнаты для подключения по ссылке
186
192
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
193
+ * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
187
194
  */
188
- export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean): Promise<ConversationData>;
189
- export declare function callInternal(ids: OkUserId[], type: CallType, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean): Promise<ConversationData>;
195
+ export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
196
+ export declare function callInternal(ids: OkUserId[], type: CallType, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
190
197
  /**
191
198
  * Обработать пуш о входящем звонке
192
199
  *
@@ -274,6 +281,13 @@ export declare function changeDevice(kind: MediaDeviceKind, deviceId: string): P
274
281
  * @param state Включить или выключить
275
282
  */
276
283
  export declare function captureScreen(state: boolean): Promise<void>;
284
+ /**
285
+ * Включить/выключить захват экрана
286
+ *
287
+ * @param screenState Включить или выключить захват экрана.
288
+ * @param audioShareState Включить или выключить захват звука. Может быть использован только вместе с захватом экрана.
289
+ */
290
+ export declare function captureScreenAndAudio(screenState: boolean, audioShareState: boolean): Promise<void>;
277
291
  /**
278
292
  * Позволяет установить кастомный стрим для видео
279
293
  * например для стрима из canvas, с наложением изображений
@@ -393,9 +407,12 @@ export declare function customDataInternal(data: JSONObject, uid?: OkUserId | nu
393
407
  *
394
408
  * @param payload Дополнительные данные для передачи на сервер
395
409
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
410
+ * @param startConversationParameters Дополнительные параметры для создания звонка (например onlyAdminCanShareMovie)
396
411
  * @returns Токен комнаты
397
412
  */
398
- export declare function startConversation(payload?: string, requireAuthToJoin?: boolean): Promise<string>;
413
+ export declare function startConversation(payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie }?: {
414
+ onlyAdminCanShareMovie?: boolean;
415
+ }): Promise<string>;
399
416
  /**
400
417
  * Создать токен комнаты для подключения по ссылке к существующему звонку
401
418
  *
@@ -447,17 +464,16 @@ export declare function getStreamInfo(): Promise<{
447
464
  *
448
465
  * @param movieId
449
466
  */
450
- export declare function addMovie(movieId: string): Promise<{
467
+ export declare function addMovie(params: IAddMovieParams): Promise<{
451
468
  movieId: string;
452
469
  streamType: string;
453
470
  }>;
454
471
  /**
455
472
  * Изменить видео/лайв в звонке
456
473
  *
457
- * @param movieId
458
- * @param gain
474
+ * @param params
459
475
  */
460
- export declare function updateMovie(movieId: string, gain?: number, offset?: string, pause?: boolean): Promise<void>;
476
+ export declare function updateMovie(params: IUpdateMovieData): Promise<void>;
461
477
  /**
462
478
  * Удалить видео/лайв из звонка
463
479
  *
@@ -513,6 +529,8 @@ export declare function getWaitingHall(pageMarker?: string | null, count?: numbe
513
529
  export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
514
530
  export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<import("./types/ExternalId").ExternalParticipantListChunk>;
515
531
  export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
532
+ export declare function feedback(key: string): Promise<SignalingMessage>;
533
+ export declare function enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<void>;
516
534
  /**
517
535
  * Удаляет записи истории звонков
518
536
  *
@@ -523,5 +541,5 @@ export declare function removeHistoryRecords(recordIds: number[]): Promise<void>
523
541
  * Версия SDK
524
542
  */
525
543
  export declare function version(): string;
526
- 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, };
527
- 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, };
544
+ 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, IFeedbackExternal, ISharedMovieInfo, ISharedMovieStoppedInfo, ISharedMovieState, ISharedMovieStateResponse, IAddMovieParams, IOnRemoteMovieData, IMoviePreview, IUpdateMovieData, IFeaturesPerRole, };
545
+ 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, ConversationFeature, ArrayDequeue, };
@@ -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';
@@ -11,6 +12,7 @@ import { JSONObject } from '../static/Json';
11
12
  import ConversationResponse from '../types/ConversationResponse';
12
13
  import MediaModifiers from '../types/MediaModifiers';
13
14
  import MediaSettings from '../types/MediaSettings';
15
+ import { IAddMovieParams, IUpdateMovieData } from '../types/MovieShare';
14
16
  import MuteStates from '../types/MuteStates';
15
17
  import { CompositeUserId, ParticipantId } from '../types/Participant';
16
18
  import { ParticipantLayout, RequestKeyFrame, StopStream } from '../types/ParticipantLayout';
@@ -56,8 +58,8 @@ export default abstract class BaseSignaling extends EventEmitter {
56
58
  abstract updateDisplayLayout(layouts: {
57
59
  [streamDesc: string]: ParticipantLayout | StopStream | RequestKeyFrame;
58
60
  }): Promise<SignalingMessage | void>;
59
- abstract addMovie(data: any): Promise<SignalingMessage>;
60
- abstract updateMovie(data: any): Promise<SignalingMessage>;
61
+ abstract addMovie(data: IAddMovieParams): Promise<SignalingMessage>;
62
+ abstract updateMovie(data: IUpdateMovieData): Promise<SignalingMessage>;
61
63
  abstract removeMovie(data: any): Promise<SignalingMessage>;
62
64
  abstract startStream(data: any): Promise<SignalingMessage>;
63
65
  abstract stopStream(): Promise<SignalingMessage>;
@@ -70,6 +72,7 @@ export default abstract class BaseSignaling extends EventEmitter {
70
72
  abstract customData(data: JSONObject, participantId: ParticipantId | null): Promise<SignalingMessage>;
71
73
  abstract grantRoles(participantId: CompositeUserId, roles: UserRole[], revoke: boolean): Promise<SignalingMessage>;
72
74
  abstract muteParticipant(participantId: ParticipantId | null, muteStates: MuteStates, requestedMedia: MediaOption[]): Promise<SignalingMessage>;
75
+ abstract enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<SignalingMessage>;
73
76
  abstract pinParticipant(participantId: ParticipantId, unpin: boolean): Promise<SignalingMessage>;
74
77
  abstract updateMediaModifiers(mediaModifiers: MediaModifiers): Promise<SignalingMessage>;
75
78
  abstract changeOptions(changes: {
@@ -77,6 +80,7 @@ export default abstract class BaseSignaling extends EventEmitter {
77
80
  }): Promise<SignalingMessage>;
78
81
  abstract getWaitingHall(fromId: WaitingParticipantId | null, count?: number, backward?: boolean): Promise<SignalingMessage>;
79
82
  abstract promoteParticipant(participantId: CompositeUserId, demote?: boolean): Promise<SignalingMessage>;
83
+ abstract feedback(key: string): Promise<SignalingMessage>;
80
84
  abstract setProducerNotificationDataChannel(dataChannel: RTCDataChannel): void;
81
85
  abstract setProducerCommandDataChannel(dataChannel: RTCDataChannel): void;
82
86
  abstract useCommandDataChannel(status: boolean): void;