Class NCCallEngine

constructor

• new NCCallEngine(runtime: IRuntime, options: INCCallInitOptions): NCCallEngine

  Construct engine instance (prefer NCCallEngine.init).

  Parameters

  • runtime: IRuntime

    Runtime context

  • options: INCCallInitOptions

    Call initialization options

  Returns NCCallEngine

Static_instance

Staticinit

• init(options: INCCallInitOptions): NCCallEngine

  Singleton initialization

  Parameters

  • options: INCCallInitOptions

    logOutputLevel: console log level, default EnableLogL.WARN; logs at or below this level are printed

    • isPubLowResolutionStream: whether to publish low-resolution stream, default false; when true, remote can subscribe to low-res to save bandwidth

  Returns NCCallEngine

  Existing or newly created NCCallEngine instance

  Description

  Repeated calls return the same instance if one already exists

setCallEventsListener

• setCallEventsListener(listener: INCCallEventsListener): void

  Set application call event listener (incoming call, call end, participant state, media type changes, etc.).

  Parameters

  • listener: INCCallEventsListener

    INCCallEventsListener; see apiDoc for fields

  Returns void

  Description

  Replaces any previously set listener

setConnectionQualityListener

• setConnectionQualityListener(listener: IConnectionQualityListener): void

  Set call quality listener; send/receive quality callbacks are driven by underlying status reports, about once per second.

  Parameters

  • listener: IConnectionQualityListener

    IConnectionQualityListener; all methods optional

    Call connection quality listener

    • onAudioVolumeChanged?: function

      • onAudioVolumeChanged?(volumes: { [userId: string]: number }): void

        Per-user volume: userId → level (0–100), about once per second.

        Parameters

        • volumes: { [userId: string]: number }

          User ID to volume map

        Returns void

    • onSendQualityChanged?: function

      • onSendQualityChanged?(stats: { [userId: string]: IRCCallQualityStats }): void

        Local uplink quality; userId is the logged-in user. About once per second.

        Parameters

        • stats: { [userId: string]: IRCCallQualityStats }

          User ID → INCCallQualityStats

        Returns void

    • onReceiveQualityChanged?: function

      • onReceiveQualityChanged?(stats: { [userId: string]: IRCCallQualityStats }): void

        Per-remote downlink quality. About once per second.

        Parameters

        • stats: { [userId: string]: IRCCallQualityStats }

          Remote user ID → INCCallQualityStats

        Returns void

  Returns void

setVideoView

• setVideoView(
      list: {
          userId: string;
          videoElement: HTMLVideoElement;
          useTinyStream?: boolean;
      }[],
  ): { code: number }

  Bind video views (local and remote).

  Parameters

  • list: { userId: string; videoElement: HTMLVideoElement; useTinyStream?: boolean }[]

    Entries for multiple users

  Returns { code: number }

  code Whether binding succeeded

  Description

  Dynamic tiny/main stream switching is not supported

removeVideoView

• removeVideoView(userIds: string[]): { code: number }

  Remove bound video views. You may remove the DOM nodes; calling this stops receiving that user's video from the SDK.

  Parameters

  • userIds: string[]

    User IDs

  Returns { code: number }

  code Whether removal succeeded

playMedia

• playMedia(userId: string, mediaType: NCCallMediaType): Promise<{ code: number }>

  Play a user's audio/video. For video, call setVideoView for that user first.

  Parameters

  • userId: string

    User whose media to play

  • mediaType: NCCallMediaType

    See NCCallMediaType

  Returns Promise<{ code: number }>

  Whether playback started successfully

createVideoConfigBuilder

• createVideoConfigBuilder(): NCVideoConfigBuilder

  Create video config builder

  Returns NCVideoConfigBuilder

  NCVideoConfigBuilder for capture settings (camera id, frame rate, resolution, etc.); call build() then setVideoConfig

setVideoConfig

• setVideoConfig(cfg: INCCallVideoConfig): { code: number }

  Set video config (resolution, min/max bitrate, frame rate, camera ID, etc.). Apply before the call connects.

  Parameters

  • cfg: INCCallVideoConfig

    Video configuration

  Returns { code: number }

createAudioConfigBuilder

• createAudioConfigBuilder(): NCAudioConfigBuilder

  Create audio config builder

  Returns NCAudioConfigBuilder

  NCAudioConfigBuilder for capture settings (e.g. microphone id); call build() then setAudioConfig

createAndroidPushConfigBuilder

• createAndroidPushConfigBuilder(): NCAndroidPushConfigBuilder

  Create Android push config builder

  Returns NCAndroidPushConfigBuilder

  NCAndroidPushConfigBuilder; call build() for androidPushConfig, then pass it in pushConfig.androidConfig of startCall / inviteToCall / endCall

setAudioConfig

• setAudioConfig(cfg: INCCallAudioConfig): { code: number }

  Set audio config (bitrate, sample rate, capture device ID). Apply before the call connects.

  Parameters

  • cfg: INCCallAudioConfig

    Audio configuration

  Returns { code: number }

startCall

• startCall(
      calleeIds: string | string[],
      callType?: NCCallType,
      mediaType?: NCCallMediaType,
      pushConfig?: INCCallPushConfig,
      extra?: string,
      targetId?: string,
  ): Promise<{ code: number; callId?: string }>

  Start an outgoing call

  Parameters

  • calleeIds: string | string[]

    Callee user id(s); single string or string[] (one entry for 1:1)

  • callType: NCCallType = NCCallType.SINGLE

    NCCallType

  • mediaType: NCCallMediaType = NCCallMediaType.VIDEO

    NCCallMediaType

  • OptionalpushConfig: INCCallPushConfig

    Mobile push payload

  • Optionalextra: string

    Opaque string forwarded to callee(s)

  • OptionaltargetId: string

    Group id for multi-party calls

  Returns Promise<{ code: number; callId?: string }>

  callId Session id on success

  Description

  On signaling send failure, SDK retries every 2s until success or ~1 minute timeout

joinCall

• joinCall(callId: string): Promise<{ code: number }>

  Join an ongoing group call by ID (invitation not required if you know callId).

  Parameters

  • callId: string

    Call ID

  Returns Promise<{ code: number }>

  Description

  On signaling send failure, SDK retries every 2s until success or ~1 minute timeout

inviteToCall

• inviteToCall(
      calleeIds: string[],
      pushConfig?: INCCallPushConfig,
      extra?: string,
  ): Promise<
      {
          code: number;
          busyUsers?: { userId: string; userState: NCCallUserState }[];
      },
  >

  Invite users during a 1:1 or group call

  Parameters

  • calleeIds: string[]

    Invitee user IDs

  • OptionalpushConfig: INCCallPushConfig

    Mobile push payload

  • Optionalextra: string

    Opaque string forwarded to invitees

  Returns Promise<
      {
          code: number;
          busyUsers?: { userId: string; userState: NCCallUserState }[];
      },
  >

  busyUsers Users busy; userState is NCCallUserState

  Description

  Inviting from a 1:1 call may change call type

  Description

  On signaling send failure, SDK retries every 2s until success or ~1 minute timeout

acceptCall

• acceptCall(
      callId: string,
      pushConfig?: INCCallPushConfig,
  ): Promise<{ code: number }>

  Accept a call

  Parameters

  • callId: string

    Call ID

  • OptionalpushConfig: INCCallPushConfig

    Mobile push payload

  Returns Promise<{ code: number }>

  Description

  On signaling send failure, SDK retries every 2s until success or ~1 minute timeout

endCall

• endCall(
      callId?: string,
      pushConfig?: INCCallPushConfig,
  ): Promise<{ code: number }>

  Hang up

  Parameters

  • OptionalcallId: string

    Optional. Omit to hang up the active main session; pass id to hang up that call or a pending incoming call (ringing, not answered) without affecting other calls

  • OptionalpushConfig: INCCallPushConfig

    Mobile push payload

  Returns Promise<{ code: number }>

requestChangeMediaType

• requestChangeMediaType(
      mediaType: NCCallMediaType,
  ): Promise<{ code: number; transactionId?: string }>

  Request media type change during a call (1:1 only; no manual camera toggle required)

  Parameters

  • mediaType: NCCallMediaType

    Target type: only NCCallMediaType audio or video (toggle between audio-only and A/V)

  Returns Promise<{ code: number; transactionId?: string }>

  transactionId Use when cancelling or responding to the change request

cancelChangeMediaType

• cancelChangeMediaType(transactionId: string): Promise<{ code: number }>

  Cancel a pending media type change (1:1 only)

  Parameters

  • transactionId: string

    Same as returned from requestChangeMediaType

  Returns Promise<{ code: number }>

replyChangeMediaType

• replyChangeMediaType(
      transactionId: string,
      isAgree: boolean,
  ): Promise<{ code: number }>

  Respond to a media type change request (1:1 only)

  Parameters

  • transactionId: string

    From onMediaTypeChangeRequestReceived

  • isAgree: boolean

    Whether to accept the change

  Returns Promise<{ code: number }>

getCurrentCallSession

• getCurrentCallSession(): NCCallSession | null

  Get the active main call session

  Returns NCCallSession | null

  Current NCCallSession or null

getOngoingCallLogs

• getOngoingCallLogs(): Promise<{ code: number; records?: INCCallLog[] }>

  Fetch ongoing (not ended) call logs for the current user from server

  Returns Promise<{ code: number; records?: INCCallLog[] }>

  records List of INCCallLog

getHistoryCallLogs

• getHistoryCallLogs(
      startTime: number,
      count: number,
      order?: 0 | 1,
  ): Promise<{ code: number; result?: INCCallLogInfo }>

  Paginated call history for the current user

  Parameters

  • startTime: number

    Anchor timestamp; use -1 for first page (newest when order is reverse, oldest when forward). Forward: records after this time; reverse: records before this time

  • count: number

    Page size

  • Optionalorder: 0 | 1

    0 ascending (after startTime), 1 descending (before startTime); default forward

  Returns Promise<{ code: number; result?: INCCallLogInfo }>

  result.hasMore More pages available

deleteCallLogsForMe

• deleteCallLogsForMe(callIds: string[]): Promise<{ code: number }>

  Delete call logs by id for the current user

  Parameters

  • callIds: string[]

    Call IDs to delete

  Returns Promise<{ code: number }>

deleteAllCallLogsForMe

• deleteAllCallLogsForMe(): Promise<{ code: number }>

  Delete all call logs for the current user

  Returns Promise<{ code: number }>

enableCamera

• enableCamera(enable: boolean): Promise<{ code: number }>

  Turn camera on (true) or off (false).

  Parameters

  • enable: boolean

    Enable camera

  Returns Promise<{ code: number }>

  Description

  Default is on after video call connects

  Description

  If publish fails so remote never sees camera on, this action fails

switchCamera

• switchCamera(cameraId: string): Promise<{ code: number }>

  Switch camera device (before or during call)

  Parameters

  • cameraId: string

    From getVideoInputDevices

  Returns Promise<{ code: number }>

  Description

  On success, onUserMediaAvailable fires; call playMedia for the new track

enableMicrophone

• enableMicrophone(enable: boolean): Promise<{ code: number }>

  Turn microphone on (true, unmute) or off (false, local mute).

  Parameters

  • enable: boolean

    Enable microphone

  Returns Promise<{ code: number }>

  Description

  Default is on after call connects

  Description

  If publish fails so remote never sees mic on, this action fails

getAudioInputDevices

• getAudioInputDevices(): Promise<MediaDeviceInfo[]>

  List audio input (microphone) devices

  Returns Promise<MediaDeviceInfo[]>

selectAudioInputDevice

• selectAudioInputDevice(microphoneId: string): Promise<{ code: number }>

  Switch microphone (before or during call)

  Parameters

  • microphoneId: string

    From getAudioInputDevices

  Returns Promise<{ code: number }>

  Description

  On success, onUserMediaAvailable fires; call playMedia for the new track

getAudioOutputDevices

• getAudioOutputDevices(): Promise<MediaDeviceInfo[]>

  List audio output (speaker) devices

  Returns Promise<MediaDeviceInfo[]>

selectAudioOutputDevice

• selectAudioOutputDevice(deviceId: string): Promise<{ code: number }>

  Set audio output (playback) device

  Parameters

  • deviceId: string

    Device id

  Returns Promise<{ code: number }>

getVersion

• getVersion(): string

  SDK version string

  Returns string

getVideoInputDevices

• getVideoInputDevices(): Promise<MediaDeviceInfo[]>

  List video input (camera) devices

  Returns Promise<MediaDeviceInfo[]>

isMicrophoneEnabled

• isMicrophoneEnabled(): boolean

  Whether the microphone is currently enabled

  Returns boolean