@vkontakte/calls-sdk 2.6.2-dev.3549b06.0 → 2.6.2-dev.3e4fbdf.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,9 @@ 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';
49
53
  /**
50
54
  * Информация о текущем браузере
51
55
  */
@@ -184,9 +188,10 @@ export declare function init(params: Partial<ParamsObject>): Promise<void>;
184
188
  * @param payload Дополнительные данные для передачи на сервер
185
189
  * @param joiningAllowed Создать токен комнаты для подключения по ссылке
186
190
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
191
+ * @param onlyAdminCanShareMovie Только администратор может включать совметсный просмотр
187
192
  */
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>;
193
+ export declare function callTo(externalId?: string | ExternalId | string[] | ExternalId[], mediaOptions?: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
194
+ export declare function callInternal(ids: OkUserId[], type: CallType, mediaOptions: MediaOption[], payload?: string, joiningAllowed?: boolean, requireAuthToJoin?: boolean, onlyAdminCanShareMovie?: boolean): Promise<ConversationData>;
190
195
  /**
191
196
  * Обработать пуш о входящем звонке
192
197
  *
@@ -393,9 +398,12 @@ export declare function customDataInternal(data: JSONObject, uid?: OkUserId | nu
393
398
  *
394
399
  * @param payload Дополнительные данные для передачи на сервер
395
400
  * @param requireAuthToJoin Запретить анонимам подключаться по ссылке (если поддерживается сервером)
401
+ * @param startConversationParameters Дополнительные параметры для создания звонка (например onlyAdminCanShareMovie)
396
402
  * @returns Токен комнаты
397
403
  */
398
- export declare function startConversation(payload?: string, requireAuthToJoin?: boolean): Promise<string>;
404
+ export declare function startConversation(payload?: string, requireAuthToJoin?: boolean, { onlyAdminCanShareMovie }?: {
405
+ onlyAdminCanShareMovie?: boolean;
406
+ }): Promise<string>;
399
407
  /**
400
408
  * Создать токен комнаты для подключения по ссылке к существующему звонку
401
409
  *
@@ -447,17 +455,16 @@ export declare function getStreamInfo(): Promise<{
447
455
  *
448
456
  * @param movieId
449
457
  */
450
- export declare function addMovie(movieId: string): Promise<{
458
+ export declare function addMovie(params: IAddMovieParams): Promise<{
451
459
  movieId: string;
452
460
  streamType: string;
453
461
  }>;
454
462
  /**
455
463
  * Изменить видео/лайв в звонке
456
464
  *
457
- * @param movieId
458
- * @param gain
465
+ * @param params
459
466
  */
460
- export declare function updateMovie(movieId: string, gain?: number, offset?: string, pause?: boolean): Promise<void>;
467
+ export declare function updateMovie(params: IUpdateMovieData): Promise<void>;
461
468
  /**
462
469
  * Удалить видео/лайв из звонка
463
470
  *
@@ -513,6 +520,8 @@ export declare function getWaitingHall(pageMarker?: string | null, count?: numbe
513
520
  export declare function promoteParticipant(externalId: ExternalId, demote?: boolean): Promise<void>;
514
521
  export declare function getParticipantListChunk(participantListChunkParameters: ParticipantListChunkParameters): Promise<import("./types/ExternalId").ExternalParticipantListChunk>;
515
522
  export declare function getParticipants(parameters: IGetParticipantsParameters): Promise<ExternalParticipant[]>;
523
+ export declare function feedback(key: string): Promise<SignalingMessage>;
524
+ export declare function enableFeatureForRoles(feature: ConversationFeature, roles: UserRole[]): Promise<void>;
516
525
  /**
517
526
  * Удаляет записи истории звонков
518
527
  *
@@ -523,5 +532,5 @@ export declare function removeHistoryRecords(recordIds: number[]): Promise<void>
523
532
  * Версия SDK
524
533
  */
525
534
  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, };
535
+ 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, };
536
+ 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, };
@@ -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;