1.6.0-beta

Author: git-babel

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+### 1.6.0-beta (Feb 17, 2021 UTC)
+Sendbird Calls SDK version 1.6.0 supports the early access program for group calling. New concepts introduced in this version center around *rooms* and *participants*.
+* Added group call feature.
+    * Below methods are added in `SendBirdCall`
+        * `createRoom(): Promise<Room>`
+        * `getCachedRoomById(roomId: string): Room`
+        * `fetchRoomById(roomId: string): Promise<Room>`
+    * Below class is added in `SendBirdCall`
+        * `Room`
+    * Below interfaces are added in `SendBirdCall`
+        * `EnterParams`
+        * `Participant`
+        * `LocalParticipant`
+        * `RemoteParticipant`
+    * Below enum is added in `SendBirdCall`
+        * `ParticipantState`
+
 ### 1.5.3 (Jan 26, 2021 UTC)
 * Bug fix
     * Fixed doubling bug in recording.

SendBirdCall.min.d.ts

@@ -1,6 +1,5 @@
-/** 1.5.3 */
-
-// eslint-disable-next-line no-undef
+/** 1.6.0-beta */
+// eslint-disable-next-line no-undef,max-classes-per-file
 export as namespace SendBirdCall;
 
 export function init(appId: string): void;
@@ -37,6 +36,9 @@ export function handleWebhookData(data: WebhookData): void;
 export function addDirectCallSound(type: SoundType, url: string): Promise<boolean>;
 export function removeDirectCallSound(type: SoundType): boolean;
 export function getCall(callId: string): DirectCall;
+export function createRoom(): Promise<Room>;
+export function getCachedRoomById(roomId: string): Room;
+export function fetchRoomById(roomId: string): Promise<Room>;
 export const sdkVersion: string;
 export const appId: string;
 export const currentUser: User;
@@ -146,6 +148,64 @@ export interface SendBirdCallRecordingListener {
   onRecordingFailed: ((callId: string, recordingId: string, error) => void) | null;
 }
 
+/**
+ * Event Target
+ */
+
+interface Event {
+  readonly args?: any[];
+}
+
+declare type nullish = null | undefined;
+
+declare type ArgsType<T extends Event> = T['args'] extends nullish ? [] : T['args'];
+
+interface EventListener<T extends Event> {
+  (...args: ArgsType<T>): void;
+}
+
+declare type EventMap = Record<string, Event>;
+
+declare type EventKey<T extends EventMap> = keyof T;
+
+declare class EventTarget<T extends EventMap> {
+
+  /**
+   * Adds a listener to receive events.
+   */
+  addEventListener<K extends EventKey<T>>(type: K, callback: EventListener<T[K]>): void;
+
+  /**
+   * Alias for addEventListener
+   */
+  on: <K extends keyof T>(type: K, callback: EventListener<T[K]>) => void;
+
+  /**
+   * Adds listener to receive events once.
+   */
+  once<K extends EventKey<T>>(type: K, givenCb: EventListener<T[K]>): void;
+
+  /**
+   * Removes an added listener.
+   */
+  removeEventListener<K extends EventKey<T>>(type: K, callback: EventListener<T[K]>): void;
+
+  /**
+   * Alias for removeEventListener
+   */
+  off: <K extends keyof T>(type: K, callback: EventListener<T[K]>) => void;
+
+  /**
+   * Removes all added listeners.
+   */
+  removeAllEventListeners(): void;
+
+}
+
+/**
+ * DirectCall
+ */
+
 export interface DirectCall {
   onEstablished: ((call: DirectCall) => void) | null;
   onConnected: ((call: DirectCall) => void) | null;
@@ -338,3 +398,150 @@ export interface WebhookData {
   [key: string]: any;
 }
 /* eslint-enable babel/camelcase */
+
+
+/**
+ * Room
+ */
+
+declare type RoomEventMap = {
+  remoteParticipantEntered: { args: [RemoteParticipant]; };
+  remoteParticipantExited: { args: [RemoteParticipant]; };
+  remoteParticipantStreamStarted: { args: [RemoteParticipant]; };
+  remoteAudioSettingsChanged: { args: [RemoteParticipant]; };
+  remoteVideoSettingsChanged: { args: [RemoteParticipant]; };
+  error: { args: [Error, Particpant?] };
+};
+
+/**
+ * Called when remote participant has been entered
+ */
+export type RemoteParticipantEnteredEventListener = (participant: RemoteParticipant) => void;
+/**
+ * Called when remote participant has been exited
+ */
+export type RemoteParticipantExitedEventListener = (participant: RemoteParticipant) => void;
+/**
+ * Called when it's able to receive media stream from remote participant.
+ */
+export type RemoteParticipantStreamStartedEventListener = (participant: RemoteParticipant) => void;
+/**
+ * Called when audio settings of remote participant has been changed
+ */
+export type RemoteAudioSettingsChangedEventListener = (participant: RemoteParticipant) => void;
+/**
+ * Called when video settings of remote participant has been changed.
+ */
+export type RemoteVideoSettingsChangedEventListener = (participant: RemoteParticipant) => void;
+
+export declare class Room extends EventTarget<RoomEventMap> {
+
+  /**
+   * The ID of room
+   */
+  readonly roomId: string;
+
+  /**
+   * Long value of the date when the room created at.
+   */
+  readonly createdAt: number;
+
+  /**
+   * The ID of user who created the room
+   */
+  readonly createdBy: string;
+
+  /**
+   * The list of all participants including local participant.
+   */
+  readonly participants: Participant[];
+
+  /**
+   * The local participant.
+   */
+  readonly localParticipant: LocalParticipant;
+
+  /**
+   * The list of remote participants.
+   */
+  readonly remoteParticipants: RemoteParticipant[];
+
+  /**
+   * Enters a room
+   */
+  enter(params: EnterParams): Promise<void>;
+
+  /**
+   * Exits a room
+   */
+  exit(): Promise<void>;
+
+}
+
+export interface EnterParams {
+  audioEnabled: boolean;
+  videoEnabled: boolean;
+}
+
+export enum ParticipantState {
+  /**
+   * The state when the participant has entered room
+   */
+  ENTERED = 'entered',
+  /**
+   * The state when the participant has been connected.
+   */
+  CONNECTED = 'connected',
+  /**
+   * The state when the participant has exit room
+   */
+  EXITED = 'exited',
+}
+
+export interface Participant {
+  participantId: string;
+  enteredAt: number;
+  updatedAt: number;
+  exitedAt?: number;
+  duration?: number;
+  isLocalParticipant: boolean;
+  state: ParticipantState;
+  user: User;
+  isAudioEnabled: boolean;
+  isVideoEnabled: boolean;
+
+  setMediaView(mediaView: HTMLMediaElement): Promise<void>;
+}
+
+export interface LocalParticipant extends Participant {
+  isLocalParticipant: true;
+
+  /**
+   * Alias for setMediaView
+   */
+  setLocalMediaView(mediaView: HTMLMediaElement): Promise<void>;
+
+  /**
+   * Stop the local audio.
+   */
+  muteMicrophone(): void;
+  /**
+   * Start the local audio.
+   */
+  unmuteMicrophone(): void;
+
+  /**
+   * Start the local video.
+   */
+  stopVideo(): void;
+
+  /**
+   * Stop the local video.
+   */
+  startVideo(): void;
+
+}
+
+export interface RemoteParticipant extends Participant {
+  isLocalParticipant: false;
+}

SendBirdCall.min.js

@@ -1,6 +1,6 @@
 {
   "name": "sendbird-calls",
-  "version": "1.5.3",
+  "version": "1.6.0-beta",
   "authors": [
     "SendBird <[email protected]>"
   ],

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "sendbird-calls",
-  "version": "1.5.3",
+  "version": "1.6.0-beta",
   "description": "SendBird Calls JavaScript SDK",
   "main": "SendBirdCall.min.js",
   "types": "SendBirdCall.min.d.ts",