Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DirectCallProperties

Implemented by

Index

Properties

android_availableAudioDevices: AudioDeviceType[]

Gets available audio devices.

platform

Android

since

1.0.0

android_currentAudioDevice: null | AudioDeviceType

Gets current audio device.

platform

Android

since

1.0.0

availableVideoDevices: VideoDevice[]

Gets available video devices. List of available VideoDevice.

since

1.0.0

callId: string

Gets call ID.

since

1.0.0

callLog: null | DirectCallLog

Gets call log.

since

1.0.0

callee: null | DirectCallUser

Gets callee.

since

1.0.0

caller: null | DirectCallUser

Gets caller.

since

1.0.0

currentVideoDevice: null | VideoDevice

Gets current video device.

since

1.0.0

customItems: Record<string, string>

Gets custom items of this DirectCall instance.

since

1.0.0

duration: number

Gets call duration(ms).

since

1.0.0

Gets end result.

since

1.0.0

endedBy: null | DirectCallUser

Gets ender.

since

1.0.0

ios_callUUID: null | string

The UUID form of callId. Useful when dealing with CallKit.

platform

iOS

since

1.0.0

isEnded: boolean

Is ended. True if call is ended. Otherwise, false.

since

1.0.0

isLocalAudioEnabled: boolean

Is local audio enabled. True if local audio is enabled. Otherwise, false.

since

1.0.0

isLocalScreenShareEnabled: 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

isLocalVideoEnabled: boolean

Is local video enabled. True if local video is enabled. Otherwise, false.

since

1.0.0

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.

since

1.0.0

isOngoing: boolean

Is ongoing. True if call is ongoing. Otherwise, false.

since

1.0.0

isRemoteAudioEnabled: boolean

Is remote audio enabled. True if remote audio is enabled. Otherwise, false.

since

1.0.0

isRemoteVideoEnabled: boolean

Is remote video enabled. True if remote video is enabled. Otherwise, false.

since

1.0.0

isVideoCall: boolean

Is video call.

returns

True if video call. Otherwise, false.

since

1.0.0

localRecordingStatus: RecordingStatus

Gets local recording status.

since

1.0.0

localUser: null | DirectCallUser

Gets local user.

since

1.0.0

myRole: null | DirectCallUserRole

Gets my role.

since

1.0.0

remoteRecordingStatus: RecordingStatus

Gets remote recording status.

since

1.0.0

remoteUser: null | DirectCallUser

Gets remote user.

since

1.0.0

startedAt: number

Gets call startedAt timestamp.

since

1.0.0

Generated using TypeDoc