capacitor-callkit-webrtc-plugin

Callkit webrtc capacitor plugin

Install

npm install capacitor-callkit-webrtc-plugin
npx cap sync

API

• isGranted()
• openSettings()
• unregisterProximityListener()
• toggleSpeaker(...)
• isSpeakerOn()
• toggleMicrophone(...)
• isMicrophoneMuted()
• createAnswer()
• createPeer(...)
• createOffer(...)
• setRemoteSdp(...)
• setRemoteIceCandidate(...)
• closePeerConnection()
• getPeerConnectionStatus()
• getRemoteDescriptionStatus()
• doMethod(...)
• Interfaces
• Type Aliases
• Enums

isGranted()

isGranted() => Promise<{ granted: boolean; }>

Returns: Promise<{ granted: boolean; }>

---

openSettings()

openSettings() => Promise<void>

---

unregisterProximityListener()

unregisterProximityListener() => Promise<{ status: string; }>

Returns: Promise<{ status: string; }>

---

toggleSpeaker(...)

toggleSpeaker({ useSpeaker, }: { useSpeaker: boolean; }) => Promise<{ isSpeakerOn: boolean; }>

Param	Type
__0	{ useSpeaker: boolean; }

Returns: Promise<{ isSpeakerOn: boolean; }>

---

isSpeakerOn()

isSpeakerOn() => Promise<{ isSpeakerOn: boolean; }>

Returns: Promise<{ isSpeakerOn: boolean; }>

---

toggleMicrophone(...)

toggleMicrophone({ mute, }: { mute: boolean; }) => Promise<{ isMicrophoneMuted: boolean; }>

Param	Type
__0	{ mute: boolean; }

Returns: Promise<{ isMicrophoneMuted: boolean; }>

---

isMicrophoneMuted()

isMicrophoneMuted() => Promise<{ isMicrophoneMuted: boolean; }>

Returns: Promise<{ isMicrophoneMuted: boolean; }>

---

createAnswer()

createAnswer() => Promise<SessionDescription>

Returns: Promise<SessionDescription>

---

createPeer(...)

createPeer({ iceServers, }: { iceServers: [ { urls: string[]; username: string; credential: string; } ]; }) => Promise<{ status: string; }>

Param	Type
__0	{ iceServers: [{ urls: string[]; username: string; credential: string; }]; }

Returns: Promise<{ status: string; }>

---

createOffer(...)

createOffer({ iceServers, }: { iceServers: [ { urls: string[]; username: string; credential: string; } ]; }) => Promise<SessionDescription>

Param	Type
__0	{ iceServers: [{ urls: string[]; username: string; credential: string; }]; }

Returns: Promise<SessionDescription>

---

setRemoteSdp(...)

setRemoteSdp({ sdp, type, iceServers, }: { sdp: string; type: string; iceServers?: [ { urls: string[]; username: string; credential: string; } ]; }) => Promise<{ status: string; }>

Param	Type
__0	{ sdp: string; type: string; iceServers?: [{ urls: string[]; username: string; credential: string; }]; }

Returns: Promise<{ status: string; }>

---

setRemoteIceCandidate(...)

setRemoteIceCandidate({ sdpMLineIndex, sdpMid, candidate, }: any) => Promise<{ status: string; }>

Param	Type
__0	any

Returns: Promise<{ status: string; }>

---

closePeerConnection()

closePeerConnection() => Promise<{ status: string; }>

Returns: Promise<{ status: string; }>

---

getPeerConnectionStatus()

getPeerConnectionStatus() => Promise<{ status: string; }>

Returns: Promise<{ status: string; }>

---

getRemoteDescriptionStatus()

getRemoteDescriptionStatus() => Promise<{ status: string; }>

Returns: Promise<{ status: string; }>

---

doMethod(...)

doMethod(options: { options: string; methodName: MethodNames; parsedOptions: CallKitParams; }) => Promise<Responses>

Param	Type
options	{ options: string; methodName: MethodNames; parsedOptions: CallKitParams; }

Returns: Promise<Responses>

---

Interfaces

SessionDescription

Prop	Type
type	SdpType
sdp	string

CallKitParams

Prop	Type
id	string
nameCaller	string
appName	string
avatar	string
handle	string
type	number
isOnHold	boolean
isMuted	boolean
normalHandle	number
duration	number
textAccept	string
textDecline	string
textMissedCall	string
textCallback	string
rationaleMessagePermission	string
postNotificationMessageRequired	string
missedCallNotification	NotificationParams
extra	{ [key: string]: any; }
headers	{ [key: string]: any; }
android	AndroidParams
ios	IOSParams

NotificationParams

Prop	Type
id	number
showNotification	boolean
subtitle	string
callbackText	string
isShowCallback	boolean
int	number

AndroidParams

Prop	Type
isCustomNotification	boolean
isCustomSmallExNotification	boolean
isShowLogo	boolean
isShowCallID	boolean
ringtonePath	string
backgroundColor	string
backgroundUrl	string
actionColor	string
textColor	string
incomingCallNotificationChannelName	string
missedCallNotificationChannelName	string
isShowFullLockedScreen	boolean
isImportant	boolean
isBot	boolean

IOSParams

Prop	Type
iconName	string
handleType	string
supportsVideo	boolean
maximumCallGroups	number
maximumCallsPerCallGroup	number
audioSessionMode	string
audioSessionActive	boolean
audioSessionPreferredSampleRate	number
audioSessionPreferredIOBufferDuration	number
configureAudioSession	boolean
supportsDTMF	boolean
supportsHolding	boolean
supportsGrouping	boolean
supportsUngrouping	boolean
ringtonePath	string

Type Aliases

Responses

void | { isMuted: boolean } | { calls: CallKitParams[] } | { isVersionOk: boolean } | { devicePushTokenVoIP: string }

MethodNames

'showCallkitIncoming' | 'checkIsVersionOk' | 'sendPendingAcceptEvent' | 'showCallkitIncomingSilently' | 'showMissCallNotification' | 'startCall' | 'muteCall' | 'holdCall' | 'isMuted' | 'endCall' | 'callConnected' | 'endAllCalls' | 'activeCalls' | 'getDevicePushTokenVoIP' | 'silenceEvents' | 'requestNotificationPermission' | 'requestFullIntentPermission' | 'hideCallkitIncoming' | 'endNativeSubsystemOnly' | 'setAudioRoute'

Enums

SdpType

Members	Value
offer	'offer'
prAnswer	'prAnswer'
answer	'answer'
rollback	'rollback'