Class DirectCall

Implements

Constructors

constructor

new DirectCall(binder: NativeBinder, props: DirectCallProperties): DirectCall
Parameters
- binder: NativeBinder
- props: DirectCallProperties
Returns DirectCall
- Defined in src/libs/DirectCall.ts:40

Accessors

android_availableAudioDevices

get android_availableAudioDevices(): AudioDeviceType[]
Gets available audio devices.

Returns AudioDeviceType[]
Platform
Android

Since
1.0.0
Implementation of DirectCallProperties.android_availableAudioDevices
- Defined in src/libs/DirectCall.ts:71

android_currentAudioDevice

get android_currentAudioDevice(): AudioDeviceType | null
Gets current audio device.

Returns AudioDeviceType | null
Platform
Android

Since
1.0.0
Implementation of DirectCallProperties.android_currentAudioDevice
- Defined in src/libs/DirectCall.ts:74

availableVideoDevices

get availableVideoDevices(): VideoDevice[]
Gets available video devices. List of available VideoDevice.

Returns VideoDevice[]
Since
1.0.0
Implementation of DirectCallProperties.availableVideoDevices
- Defined in src/libs/DirectCall.ts:77

callee

get callee(): DirectCallUser | null
Gets callee.

Returns DirectCallUser | null
Since
1.0.0
Implementation of DirectCallProperties.callee
- Defined in src/libs/DirectCall.ts:86

caller

get caller(): DirectCallUser | null
Gets caller.

Returns DirectCallUser | null
Since
1.0.0
Implementation of DirectCallProperties.caller
- Defined in src/libs/DirectCall.ts:89

callId

get callId(): string
Gets call ID.

Returns string
Since
1.0.0
Implementation of DirectCallProperties.callId
- Defined in src/libs/DirectCall.ts:80

callLog

get callLog(): DirectCallLog | null
Gets call log.

Returns DirectCallLog | null
Since
1.0.0
Implementation of DirectCallProperties.callLog
- Defined in src/libs/DirectCall.ts:83

currentVideoDevice

get currentVideoDevice(): VideoDevice | null
Gets current video device.

Returns VideoDevice | null
Since
1.0.0
Implementation of DirectCallProperties.currentVideoDevice
- Defined in src/libs/DirectCall.ts:92

customItems

get customItems(): Record<string, string>
Gets custom items of this DirectCall instance.

Returns Record<string, string>
Since
1.0.0
Implementation of DirectCallProperties.customItems
- Defined in src/libs/DirectCall.ts:95

duration

get duration(): number
Gets call duration(ms).

Returns number
Since
1.0.0
Implementation of DirectCallProperties.duration
- Defined in src/libs/DirectCall.ts:101

endedBy

get endedBy(): DirectCallUser | null
Gets ender.

Returns DirectCallUser | null
Since
1.0.0
Implementation of DirectCallProperties.endedBy
- Defined in src/libs/DirectCall.ts:110

endResult

get endResult(): DirectCallEndResult
Gets end result.

Returns DirectCallEndResult
Since
1.0.0
Implementation of DirectCallProperties.endResult
- Defined in src/libs/DirectCall.ts:155

ios_callUUID

get ios_callUUID(): string | null
The UUID form of callId. Useful when dealing with CallKit.

Returns string | null
Platform
iOS

Since
1.0.0
Implementation of DirectCallProperties.ios_callUUID
- Defined in src/libs/DirectCall.ts:68

isEnded

get isEnded(): boolean
Is ended. True if call is ended. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isEnded
- Defined in src/libs/DirectCall.ts:113

isLocalAudioEnabled

get isLocalAudioEnabled(): boolean
Is local audio enabled. True if local audio is enabled. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isLocalAudioEnabled
- Defined in src/libs/DirectCall.ts:116

isLocalScreenShareEnabled

get isLocalScreenShareEnabled(): boolean
Indicates whether the local user's screen is being shared. True if the local user's screen is being shared. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isLocalScreenShareEnabled
- Defined in src/libs/DirectCall.ts:119

isLocalVideoEnabled

get isLocalVideoEnabled(): boolean
Is local video enabled. True if local video is enabled. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isLocalVideoEnabled
- Defined in src/libs/DirectCall.ts:122

isOngoing

get isOngoing(): boolean
Is ongoing. True if call is ongoing. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isOngoing
- Defined in src/libs/DirectCall.ts:128

isOnHold

get isOnHold(): boolean
Indicates whether the call is on hold by either a callee or a caller, or by both. True if the DirectCall is on hold. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isOnHold
- Defined in src/libs/DirectCall.ts:125

isRemoteAudioEnabled

get isRemoteAudioEnabled(): boolean
Is remote audio enabled. True if remote audio is enabled. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isRemoteAudioEnabled
- Defined in src/libs/DirectCall.ts:131

isRemoteVideoEnabled

get isRemoteVideoEnabled(): boolean
Is remote video enabled. True if remote video is enabled. Otherwise, false.

Returns boolean
Since
1.0.0
Implementation of DirectCallProperties.isRemoteVideoEnabled
- Defined in src/libs/DirectCall.ts:134

isVideoCall

get isVideoCall(): boolean
Is video call.

Returns boolean
True if video call. Otherwise, false.

Since
1.0.0
Implementation of DirectCallProperties.isVideoCall
- Defined in src/libs/DirectCall.ts:137

localRecordingStatus

get localRecordingStatus(): RecordingStatus
Gets local recording status.

Returns RecordingStatus
Since
1.0.0
Implementation of DirectCallProperties.localRecordingStatus
- Defined in src/libs/DirectCall.ts:140

localUser

get localUser(): DirectCallUser | null
Gets local user.

Returns DirectCallUser | null
Since
1.0.0
Implementation of DirectCallProperties.localUser
- Defined in src/libs/DirectCall.ts:143

myRole

get myRole(): DirectCallUserRole | null
Gets my role.

Returns DirectCallUserRole | null
Since
1.0.0
Implementation of DirectCallProperties.myRole
- Defined in src/libs/DirectCall.ts:146

remoteRecordingStatus

get remoteRecordingStatus(): RecordingStatus
Gets remote recording status.

Returns RecordingStatus
Since
1.0.0
Implementation of DirectCallProperties.remoteRecordingStatus
- Defined in src/libs/DirectCall.ts:149

remoteUser

get remoteUser(): DirectCallUser | null
Gets remote user.

Returns DirectCallUser | null
Since
1.0.0
Implementation of DirectCallProperties.remoteUser
- Defined in src/libs/DirectCall.ts:152

startedAt

get startedAt(): number
Gets call startedAt timestamp.

Returns number
Since
1.0.0
Implementation of DirectCallProperties.startedAt
- Defined in src/libs/DirectCall.ts:98

Methods

accept

accept(options?: CallOptions, holdActiveCall?: boolean): Promise<void>
Accepts call.
Parameters
- options: CallOptions = ...
- holdActiveCall: boolean = false
Returns Promise<void>
Since
1.0.0
Implementation of DirectCallMethods.accept
- Defined in src/libs/DirectCall.ts:262

addListener

addListener(listener: Partial<DirectCallListener>): () => void
Add DirectCall listener. supports multiple listeners.
Parameters
- listener: Partial<DirectCallListener>
Returns () => void
Since
1.0.0
Implementation of DirectCallMethods.addListener
- Defined in src/libs/DirectCall.ts:165

android_resumeAudioTrack

android_resumeAudioTrack(): void
Connects the device audio and Sendbird Calls SDK to stream audio.

Returns void
Platform
Android

Since
1.1.5
Implementation of DirectCallMethods.android_resumeAudioTrack
- Defined in src/libs/DirectCall.ts:318

android_resumeVideoCapturer

android_resumeVideoCapturer(): void
Connects the device camera and Sendbird Calls SDK to stream video.

Returns void
Platform
Android

Since
1.1.3
Implementation of DirectCallMethods.android_resumeVideoCapturer
- Defined in src/libs/DirectCall.ts:307

android_selectAudioDevice

android_selectAudioDevice(device: AudioDeviceType): Promise<void>
Selects audio device.
Parameters
- device: AudioDeviceType
Returns Promise<void>
Platform
Android

Since
1.0.0
Implementation of DirectCallMethods.android_selectAudioDevice
- Defined in src/libs/DirectCall.ts:296

deleteAllCustomItems

deleteAllCustomItems(): Promise<CustomItemUpdateResult>
Deletes all custom items for this call.

Returns Promise<CustomItemUpdateResult>
Promise that resolves with CustomItemUpdateResult containing updated items and affected keys.

Since
1.1.9
Implementation of DirectCallMethods.deleteAllCustomItems
- Defined in src/libs/DirectCall.ts:451

deleteCustomItems

deleteCustomItems(customItemKeys: string[]): Promise<CustomItemUpdateResult>
Deletes custom items for this call.
Parameters
- customItemKeys: string[]
  Custom item keys which you want to delete.
Returns Promise<CustomItemUpdateResult>
Promise that resolves with CustomItemUpdateResult containing updated items and affected keys.

Since
1.1.9
Implementation of DirectCallMethods.deleteCustomItems
- Defined in src/libs/DirectCall.ts:437

end

end(): Promise<void>
Ends the call. DirectCallListener.onEnded will be called after successful ending. This listener will also be called when the remote user ends the call.

Returns Promise<void>
Since
1.0.0
Implementation of DirectCallMethods.end
- Defined in src/libs/DirectCall.ts:276

muteMicrophone

muteMicrophone(): void
Mutes the audio of local user. Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.

Returns void
Since
1.0.0
Implementation of DirectCallMethods.muteMicrophone
- Defined in src/libs/DirectCall.ts:330

selectVideoDevice

selectVideoDevice(device: VideoDevice): Promise<void>
Selects video device. Changes current video device asynchronously.
Parameters
- device: VideoDevice
Returns Promise<void>
Since
1.0.0
Implementation of DirectCallMethods.selectVideoDevice
- Defined in src/libs/DirectCall.ts:286

startVideo

startVideo(): void
Starts local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.

Returns void
Since
1.0.0
Implementation of DirectCallMethods.startVideo
- Defined in src/libs/DirectCall.ts:360

stopVideo

stopVideo(): void
Stops local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.

Returns void
Since
1.0.0
Implementation of DirectCallMethods.stopVideo
- Defined in src/libs/DirectCall.ts:375

switchCamera

switchCamera(): Promise<void>
Toggles the selection between the front and the back camera.

on Android, In case of more than two cameras, the next camera will be selected. If the last camera is already selected, the first one will be selected again.

Returns Promise<void>
Since
1.0.0
Implementation of DirectCallMethods.switchCamera
- Defined in src/libs/DirectCall.ts:391

unmuteMicrophone

unmuteMicrophone(): void
Unmutes the audio of local user. Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.

Returns void
Since
1.0.0
Implementation of DirectCallMethods.unmuteMicrophone
- Defined in src/libs/DirectCall.ts:345

updateCustomItems

updateCustomItems(
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>
Updates custom items for this call.
Parameters
- customItems: Record<string, string>
  Custom items of [String: String] to be updated or inserted.
Returns Promise<CustomItemUpdateResult>
Promise that resolves with CustomItemUpdateResult containing updated items and affected keys.

Since
1.1.9
Implementation of DirectCallMethods.updateCustomItems
- Defined in src/libs/DirectCall.ts:422

updateLocalVideoView

updateLocalVideoView(videoViewId: number): void
Update local video view.
Parameters
- videoViewId: number
Returns void
See
DirectCallVideoView.videoViewId

Since
1.0.0
Implementation of DirectCallMethods.updateLocalVideoView
- Defined in src/libs/DirectCall.ts:401

updateRemoteVideoView

updateRemoteVideoView(videoViewId: number): void
Update remote video view.
Parameters
- videoViewId: number
Returns void
See
DirectCallVideoView.videoViewId

Since
1.0.0
Implementation of DirectCallMethods.updateRemoteVideoView
- Defined in src/libs/DirectCall.ts:411

Class DirectCall

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns DirectCall

Accessors

android_availableAudioDevices

Returns AudioDeviceType[]

Platform

Since

android_currentAudioDevice

Returns AudioDeviceType | null

Platform

Since

availableVideoDevices

Returns VideoDevice[]

Since

callee

Returns DirectCallUser | null

Since

caller

Returns DirectCallUser | null

Since

callId

Returns string

Since

callLog

Returns DirectCallLog | null

Since

currentVideoDevice

Returns VideoDevice | null

Since

customItems

Returns Record<string, string>

Since

duration

Returns number

Since

endedBy

Returns DirectCallUser | null

Since

endResult

Returns DirectCallEndResult

Since

ios_callUUID

Returns string | null

Platform

Since

isEnded

Returns boolean

Since

isLocalAudioEnabled

Returns boolean

Since

isLocalScreenShareEnabled

Returns boolean

Since

isLocalVideoEnabled

Returns boolean

Since

isOngoing

Returns boolean

Since

isOnHold

Returns boolean

Since

isRemoteAudioEnabled

Returns boolean

Since

isRemoteVideoEnabled

Returns boolean

Since

isVideoCall

Returns boolean

Since