@sendbird/calls-react-native/src/types/Call.ts

Sendbird Calls SDK for React Native: Empower React Native apps with seamless audio, video, and group calling. Build interactive communication easily.

import type { AudioDevice, AudioDeviceChangedInfo, RecordingStatus, VideoDevice } from './Media';
import type { NativeDirectCallModule } from './NativeModule';
import { JSMediaDeviceControl } from './NativeModule';
import type { User } from './User';
import type { AsJSDirectCall, AsJSInterface } from './index';

export interface SendbirdCallListener {
  /**
   * Called when received dialing.
   *
   * @since 1.0.0
   */
  onRinging: (call: DirectCallProperties) => void;
}

export interface DirectCallListener {
  /**
   * Called when the update properties internally on Javascript side
   *
   * @platform Javascript
   * @since 1.0.0
   */
  onPropertyUpdatedManually: (call: DirectCallProperties) => void;

  /**
   * Called when the callee has accepted the call, but not yet connected to media streams.
   *
   * @since 1.0.0
   */
  onEstablished: (call: DirectCallProperties) => void;

  /**
   * Called when media streams between the caller and callee are connected and audio/video is enabled.
   *
   * @since 1.0.0
   */
  onConnected: (call: DirectCallProperties) => void;

  /**
   * Called when DirectCall begins attempting to reconnect to the server after losing connection.
   *
   * @since 1.0.0
   */
  onReconnecting: (call: DirectCallProperties) => void;

  /**
   * Called when DirectCall successfully reconnects to the server.
   *
   * @since 1.0.0
   */
  onReconnected: (call: DirectCallProperties) => void;

  /**
   * Called when the call has ended.
   *
   * @since 1.0.0
   */
  onEnded: (call: DirectCallProperties) => void;

  /**
   * Called when the remote user changes audio settings.
   *
   * @since 1.0.0
   */
  onRemoteAudioSettingsChanged: (call: DirectCallProperties) => void;

  /**
   * Called when the remote user changes video settings.
   *
   * @since 1.0.0
   *  **/
  onRemoteVideoSettingsChanged: (call: DirectCallProperties) => void;

  /**
   * Called when the local user changes audio settings.
   *
   * @platform Android
   * @since 1.0.0
   */
  onLocalVideoSettingsChanged: (call: DirectCallProperties) => void;

  /**
   * Called when the other user’s recording status is changed.
   * You can check the recording status of the other user with {@link DirectCall.remoteRecordingStatus}
   *
   * @since 1.0.0
   */
  onRemoteRecordingStatusChanged: (call: DirectCallProperties) => void;

  /**
   * Called when the audio device has been changed.
   *
   * on iOS, if you want to change the audio device you should handle the native side. (Currently, only port names are supported as strings)
   * See also: AVAudioSession.setPreferredInput {@link https://developer.apple.com/documentation/avfaudio/avaudiosession/1616491-setpreferredinput}
   * See also: AVRoutePickerView {@link https://developer.apple.com/documentation/avkit/avroutepickerview}
   *
   * @since 1.0.0
   */
  onAudioDeviceChanged: (call: DirectCallProperties, info: AudioDeviceChangedInfo) => void;

  /**
   *  Called when the custom items of the call are updated.
   *
   * @since 1.0.0
   */
  onCustomItemsUpdated: (call: DirectCallProperties, updatedKeys: string[]) => void;

  /**
   * Called when the custom items of the call are deleted.
   *
   * @since 1.0.0
   */
  onCustomItemsDeleted: (call: DirectCallProperties, deletedKeys: string[]) => void;

  /**
   * The local or remote user has put a call on hold or removed a hold from a call and their hold status has changed.
   * @param {DirectCall} call DirectCall that has updated user hold status
   * @param {boolean} isLocalUser Returns true if the user whose hold status changed is local user
   * @param {boolean} isUserOnHold Returns true if the user's hold status is changed to on hold
   *
   * @since 1.0.0
   */
  onUserHoldStatusChanged: (call: DirectCallProperties, isLocalUser: boolean, isUserOnHold: boolean) => void;
}

export interface DirectCallProperties {
  /**
   * Gets call ID.
   *
   * @since 1.0.0
   */
  callId: string;

  /**
   * The UUID form of callId. Useful when dealing with CallKit.
   *
   * @platform iOS
   * @since 1.0.0
   */
  ios_callUUID: string | null;

  /**
   * Gets call log.
   *
   * @since 1.0.0
   */
  callLog: DirectCallLog | null;

  /**
   * Gets callee.
   *
   * @since 1.0.0
   */
  callee: DirectCallUser | null;

  /**
   * Gets caller.
   *
   * @since 1.0.0
   */
  caller: DirectCallUser | null;

  /**
   * Gets ender.
   *
   * @since 1.0.0
   */
  endedBy: DirectCallUser | null;

  /**
   * Gets custom items of this {@link DirectCall} instance.
   *
   * @since 1.0.0
   */
  customItems: Record<string, string>;

  /**
   * Gets call startedAt timestamp.
   *
   * @since 1.0.0
   */
  startedAt: number;

  /**
   * Gets call duration(ms).
   *
   * @since 1.0.0
   */
  duration: number;

  /**
   * Gets end result.
   *
   * @since 1.0.0
   */
  endResult: DirectCallEndResult;

  /**
   * Gets local user.
   *
   * @since 1.0.0
   */
  localUser: DirectCallUser | null;

  /**
   * Gets remote user.
   *
   * @since 1.0.0
   */
  remoteUser: DirectCallUser | null;

  /**
   * Gets my role.
   *
   * @since 1.0.0
   */
  myRole: DirectCallUserRole | null;

  /**
   * Gets available video devices.
   * List of available {@link VideoDevice}.
   *
   * @since 1.0.0
   */
  availableVideoDevices: VideoDevice[];

  /**
   * Gets current video device.
   *
   * @since 1.0.0
   */
  currentVideoDevice: VideoDevice | null;

  /**
   * Gets available audio devices.
   *
   * @platform Android
   * @since 1.0.0
   */
  android_availableAudioDevices: AudioDevice[];

  /**
   * Gets current audio device.
   *
   * @platform Android
   * @since 1.0.0
   */
  android_currentAudioDevice: AudioDevice | null;

  /**
   * Is ended.
   * True if call is ended. Otherwise, false.
   *
   * @since 1.0.0
   */
  isEnded: boolean;

  /**
   * Indicates whether the call is on hold by either a callee or a caller, or by both.
   * True if the {@link DirectCall} is on hold. Otherwise, false.
   *
   * @since 1.0.0
   */
  isOnHold: boolean;

  /**
   * Is ongoing.
   * True if call is ongoing. Otherwise, false.
   *
   * @since 1.0.0
   */
  isOngoing: boolean;
  /**
   * Is video call.
   *
   * @return True if video call. Otherwise, false.
   * @since 1.0.0
   */
  isVideoCall: boolean;

  /**
   * Indicates whether the local user's screen is being shared.
   * True if the local user's screen is being shared. Otherwise, false.
   *
   * @since 1.0.0
   */
  isLocalScreenShareEnabled: boolean;

  /**
   * Is local audio enabled.
   * True if local audio is enabled. Otherwise, false.
   *
   * @since 1.0.0
   */
  isLocalAudioEnabled: boolean;

  /**
   * Is local video enabled.
   * True if local video is enabled. Otherwise, false.
   *
   * @since 1.0.0
   */
  isLocalVideoEnabled: boolean;

  /**
   * Is remote audio enabled.
   * True if remote audio is enabled. Otherwise, false.
   *
   * @since 1.0.0
   */
  isRemoteAudioEnabled: boolean;

  /**
   * Is remote video enabled.
   * True if remote video is enabled. Otherwise, false.
   *
   * @since 1.0.0
   */
  isRemoteVideoEnabled: boolean;

  /**
   * Gets local recording status.
   *
   * @since 1.0.0
   */
  localRecordingStatus: RecordingStatus;

  /**
   * Gets remote recording status.
   *
   * @since 1.0.0
   */
  remoteRecordingStatus: RecordingStatus;
}

/** DirectCall */
type JSDirectCallModule = AsJSDirectCall<NativeDirectCallModule>;
type JSDirectCallMediaDeviceControl = AsJSInterface<
  JSMediaDeviceControl,
  'android',
  'selectAudioDevice' | 'resumeVideoCapturer' | 'resumeAudioTrack'
>;

export interface DirectCallMethods extends JSDirectCallModule, JSDirectCallMediaDeviceControl {
  addListener(listener: Partial<DirectCallListener>): () => void;
}

export interface DirectCallLog {
  startedAt: number;
  endedAt: number;
  duration: number;

  callId: string;
  isFromServer: boolean;
  isVideoCall: boolean;
  customItems: Record<string, string>;
  endResult: DirectCallEndResult;

  myRole: DirectCallUserRole;
  callee: DirectCallUser | null;
  caller: DirectCallUser | null;
  endedBy: DirectCallUser | null;
}

export interface DirectCallUser extends User {
  role: DirectCallUserRole;
}

export type CustomItemUpdateResult = {
  updatedItems: Record<string, string>;
  affectedKeys: string[];
};

export type CallOptions = {
  localVideoViewId?: number;
  remoteVideoViewId?: number;

  /** For SendbirdChat integration **/
  channelUrl?: string;

  /** @default true */
  audioEnabled?: boolean;
  /** @default true */
  videoEnabled?: boolean;
  /** @default true */
  frontCamera?: boolean;
};

export enum DirectCallEndResult {
  /** Default value of the EndResult. **/
  NONE = 'NONE',

  /** The call has ended by either the caller or callee after successful connection. **/
  COMPLETED = 'COMPLETED',

  /** The caller has canceled the call before the callee accepts or declines. **/
  CANCELED = 'CANCELED',

  /** The callee has declined the call. **/
  DECLINED = 'DECLINED',

  /** The call is accepted on one of the callee’s other devices. All the other devices will receive this call result. **/
  OTHER_DEVICE_ACCEPTED = 'OTHER_DEVICE_ACCEPTED',

  /** Sendbird server failed to establish a media session between the caller and callee within a specific period of time. **/
  TIMED_OUT = 'TIMED_OUT',

  /** Data streaming from either the caller or the callee has stopped due to a WebRTC connection issue while calling. **/
  CONNECTION_LOST = 'CONNECTION_LOST',

  /** The callee has not either accepted or declined the call for a specific period of time. **/
  NO_ANSWER = 'NO_ANSWER',

  /** The 'dial()' method of the call has failed. **/
  DIAL_FAILED = 'DIAL_FAILED',

  /** The 'accept()' method of the call has failed. **/
  ACCEPT_FAILED = 'ACCEPT_FAILED',

  /** Unknown **/
  UNKNOWN = 'UNKNOWN',

  NOT_CONNECTED = 'NOT_CONNECTED',
}

export enum DirectCallUserRole {
  CALLER = 'CALLER',
  CALLEE = 'CALLEE',
}