Class DirectCall

Hierarchy

DirectCall

Implements

Constructors

constructor

new DirectCall(binder: default, props: DirectCallProperties): DirectCall

- Defined in src/libs/DirectCall.ts:32
Parameters
- binder: default
- props: DirectCallProperties
Returns DirectCall

Accessors

android_availableAudioDevices

get android_availableAudioDevices(): AudioDeviceType[]

Implementation of DirectCallProperties.android_availableAudioDevices
- Defined in src/libs/DirectCall.ts:61
Gets available audio devices.

Returns AudioDeviceType[]

android_currentAudioDevice

get android_currentAudioDevice(): null | AudioDeviceType

Implementation of DirectCallProperties.android_currentAudioDevice
- Defined in src/libs/DirectCall.ts:64
Gets current audio device.

Returns null | AudioDeviceType

availableVideoDevices

get availableVideoDevices(): VideoDevice[]

Implementation of DirectCallProperties.availableVideoDevices
- Defined in src/libs/DirectCall.ts:67
Gets available video devices. List of available VideoDevice.

Returns VideoDevice[]

callId

get callId(): string

Implementation of DirectCallProperties.callId
- Defined in src/libs/DirectCall.ts:70
Gets call ID.

Returns string

callLog

get callLog(): null | DirectCallLog

Implementation of DirectCallProperties.callLog
- Defined in src/libs/DirectCall.ts:73
Gets call log.

Returns null | DirectCallLog

callee

get callee(): null | DirectCallUser

Implementation of DirectCallProperties.callee
- Defined in src/libs/DirectCall.ts:76
Gets callee.

Returns null | DirectCallUser

caller

get caller(): null | DirectCallUser

Implementation of DirectCallProperties.caller
- Defined in src/libs/DirectCall.ts:79
Gets caller.

Returns null | DirectCallUser

currentVideoDevice

get currentVideoDevice(): null | VideoDevice

Implementation of DirectCallProperties.currentVideoDevice
- Defined in src/libs/DirectCall.ts:82
Gets current video device.

Returns null | VideoDevice

customItems

get customItems(): Record<string, string>

Implementation of DirectCallProperties.customItems
- Defined in src/libs/DirectCall.ts:85
Gets custom items of this DirectCall instance.

Returns Record<string, string>

duration

get duration(): number

Implementation of DirectCallProperties.duration
- Defined in src/libs/DirectCall.ts:91
Gets call duration(ms).

Returns number

endResult

get endResult(): DirectCallEndResult

Implementation of DirectCallProperties.endResult
- Defined in src/libs/DirectCall.ts:145
Gets end result.

Returns DirectCallEndResult

endedBy

get endedBy(): null | DirectCallUser

Implementation of DirectCallProperties.endedBy
- Defined in src/libs/DirectCall.ts:100
Gets ender.

Returns null | DirectCallUser

ios_callUUID

get ios_callUUID(): null | string

Implementation of DirectCallProperties.ios_callUUID
- Defined in src/libs/DirectCall.ts:58
The UUID form of callId. Useful when dealing with CallKit.

Returns null | string

isEnded

get isEnded(): boolean

Implementation of DirectCallProperties.isEnded
- Defined in src/libs/DirectCall.ts:103
Is ended. True if call is ended. Otherwise, false.

Returns boolean

isLocalAudioEnabled

get isLocalAudioEnabled(): boolean

Implementation of DirectCallProperties.isLocalAudioEnabled
- Defined in src/libs/DirectCall.ts:106
Is local audio enabled. True if local audio is enabled. Otherwise, false.

Returns boolean

isLocalScreenShareEnabled

get isLocalScreenShareEnabled(): boolean

Implementation of DirectCallProperties.isLocalScreenShareEnabled
- Defined in src/libs/DirectCall.ts:109
Indicates whether the local user's screen is being shared. True if the local user's screen is being shared. Otherwise, false.

Returns boolean

isLocalVideoEnabled

get isLocalVideoEnabled(): boolean

Implementation of DirectCallProperties.isLocalVideoEnabled
- Defined in src/libs/DirectCall.ts:112
Is local video enabled. True if local video is enabled. Otherwise, false.

Returns boolean

isOnHold

get isOnHold(): boolean

Implementation of DirectCallProperties.isOnHold
- Defined in src/libs/DirectCall.ts:115
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

isOngoing

get isOngoing(): boolean

Implementation of DirectCallProperties.isOngoing
- Defined in src/libs/DirectCall.ts:118
Is ongoing. True if call is ongoing. Otherwise, false.

Returns boolean

isRemoteAudioEnabled

get isRemoteAudioEnabled(): boolean

Implementation of DirectCallProperties.isRemoteAudioEnabled
- Defined in src/libs/DirectCall.ts:121
Is remote audio enabled. True if remote audio is enabled. Otherwise, false.

Returns boolean

isRemoteVideoEnabled

get isRemoteVideoEnabled(): boolean

Implementation of DirectCallProperties.isRemoteVideoEnabled
- Defined in src/libs/DirectCall.ts:124
Is remote video enabled. True if remote video is enabled. Otherwise, false.

Returns boolean

isVideoCall

get isVideoCall(): boolean

Implementation of DirectCallProperties.isVideoCall
- Defined in src/libs/DirectCall.ts:127
Is video call.

Returns boolean

localRecordingStatus

get localRecordingStatus(): RecordingStatus

Implementation of DirectCallProperties.localRecordingStatus
- Defined in src/libs/DirectCall.ts:130
Gets local recording status.

Returns RecordingStatus

localUser

get localUser(): null | DirectCallUser

Implementation of DirectCallProperties.localUser
- Defined in src/libs/DirectCall.ts:133
Gets local user.

Returns null | DirectCallUser

myRole

get myRole(): null | DirectCallUserRole

Implementation of DirectCallProperties.myRole
- Defined in src/libs/DirectCall.ts:136
Gets my role.

Returns null | DirectCallUserRole

remoteRecordingStatus

get remoteRecordingStatus(): RecordingStatus

Implementation of DirectCallProperties.remoteRecordingStatus
- Defined in src/libs/DirectCall.ts:139
Gets remote recording status.

Returns RecordingStatus

remoteUser

get remoteUser(): null | DirectCallUser

Implementation of DirectCallProperties.remoteUser
- Defined in src/libs/DirectCall.ts:142
Gets remote user.

Returns null | DirectCallUser

startedAt

get startedAt(): number

Implementation of DirectCallProperties.startedAt
- Defined in src/libs/DirectCall.ts:88
Gets call startedAt timestamp.

Returns number

Methods

accept

accept(options?: CallOptions, holdActiveCall?: boolean): Promise<void>

Implementation of DirectCallMethods.accept
- Defined in src/libs/DirectCall.ts:252
Accepts call.

since
1.0.0

Parameters
- options: CallOptions = ...
- holdActiveCall: boolean = false
Returns Promise<void>

addListener

addListener(listener: Partial<DirectCallListener>): (() => void)

Implementation of DirectCallMethods.addListener
- Defined in src/libs/DirectCall.ts:155
Add DirectCall listener. supports multiple listeners.

since
1.0.0

Parameters
- listener: Partial<DirectCallListener>
Returns (() => void)
- - (): void
  - Returns void

android_selectAudioDevice

android_selectAudioDevice(device: AudioDeviceType): Promise<void>

Implementation of DirectCallMethods.android_selectAudioDevice
- Defined in src/libs/DirectCall.ts:286
Selects audio device.

platform
Android

since
1.0.0

Parameters
- device: AudioDeviceType
Returns Promise<void>

end

end(): Promise<void>

Implementation of DirectCallMethods.end
- Defined in src/libs/DirectCall.ts:266
Ends the call. DirectCallListener.onEnded will be called after successful ending. This listener will also be called when the remote user ends the call.

since
1.0.0

Returns Promise<void>

muteMicrophone

muteMicrophone(): void

Implementation of DirectCallMethods.muteMicrophone
- Defined in src/libs/DirectCall.ts:297
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.

since
1.0.0

Returns void

selectVideoDevice

selectVideoDevice(device: VideoDevice): Promise<void>

Implementation of DirectCallMethods.selectVideoDevice
- Defined in src/libs/DirectCall.ts:276
Selects video device. Changes current video device asynchronously.

since
1.0.0

Parameters
- device: VideoDevice
Returns Promise<void>

startVideo

startVideo(): void

Implementation of DirectCallMethods.startVideo
- Defined in src/libs/DirectCall.ts:327
Starts local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.

since
1.0.0

Returns void

stopVideo

stopVideo(): void

Implementation of DirectCallMethods.stopVideo
- Defined in src/libs/DirectCall.ts:342
Stops local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.

since
1.0.0

Returns void

switchCamera

switchCamera(): Promise<void>

Implementation of DirectCallMethods.switchCamera
- Defined in src/libs/DirectCall.ts:358
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.

since
1.0.0

Returns Promise<void>

unmuteMicrophone

unmuteMicrophone(): void

Implementation of DirectCallMethods.unmuteMicrophone
- Defined in src/libs/DirectCall.ts:312
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.

since
1.0.0

Returns void

updateLocalVideoView

updateLocalVideoView(videoViewId: number): void

Implementation of DirectCallMethods.updateLocalVideoView
- Defined in src/libs/DirectCall.ts:368
Update local video view.

see
DirectCallVideoView.videoViewId

since
1.0.0

Parameters
- videoViewId: number
Returns void

updateRemoteVideoView

updateRemoteVideoView(videoViewId: number): void

Implementation of DirectCallMethods.updateRemoteVideoView
- Defined in src/libs/DirectCall.ts:378
Update remote video view.

see
DirectCallVideoView.videoViewId

since
1.0.0

Parameters
- videoViewId: number
Returns void

Generated using TypeDoc