API changelog

This page provides the list of API changes in WebPlanetKit 5.3.

WebPlanetKit 5.3

Changed

Previous	WebPlanetKit 5.3	Note
function makeCall(params)	function makeCall(params): Promise throws {MakeCallError}	1-to-1 call
function verifyCall(params)	function verifyCall(params): Promise throws {VerifyCallError}	1-to-1 call
function joinConference(params)	function joinConference(params): Promise throws {JoinConferenceError}	Group call

Added

• MediaStreamManager class 1-to-1 callGroup call
• Call class 1-to-1 call
  • function registerVirtualBackground(virtualBackground: VirtualBackground)
  • function startVirtualBackgroundBlur(canvasElement?: HTMLCanvasElement, blurRadius?: number)
  • function startVirtualBackgroundImage(canvasElement: HTMLCanvasElement, image: HTMLImageElement|ImageBitmap)
  • function stopVirtualBackground()
  • function getVirtualBackgroundVideoStream(frameRate?: number)
  • function changeVirtualBackgroundVideoElement(videoElement: HTMLVideoElement)
  • function changeVirtualBackgroundCanvasElement(canvasElement: HTMLCanvasElement)
  • function isVirtualBackgroundActive()
  • function setCustomMediaStream(mediaStream: MediaStream)
  • function unsetCustomMediaStream()
  • function hasSetCustomMediaStreamWithAudio()
  • function hasSetCustomMediaStreamWithVideo()
  • function getMyMediaStream()
  • function changeMyView(videoElement: HTMLVideoElement, cleanOldElement?: boolean)
  • function changePeerView(videoElement: HTMLVideoElement, cleanOldElement?: boolean)
• Conference class Group call
  • function registerVirtualBackground(virtualBackground: VirtualBackground)
  • function startVirtualBackgroundBlur(canvasElement?: HTMLCanvasElement, blurRadius?: number)
  • function startVirtualBackgroundImage(canvasElement: HTMLCanvasElement, image: HTMLImageElement|ImageBitmap)
  • function stopVirtualBackground()
  • function getVirtualBackgroundVideoStream(frameRate?: number)
  • function changeVirtualBackgroundVideoElement(videoElement: HTMLVideoElement)
  • function changeVirtualBackgroundCanvasElement(canvasElement: HTMLCanvasElement)
  • function isVirtualBackgroundActive()
  • function setCustomMediaStream(mediaStream: MediaStream)
  • function unsetCustomMediaStream()
  • function hasSetCustomMediaStreamWithAudio()
  • function hasSetCustomMediaStreamWithVideo()
  • function getMyMediaStream()
• MakeCallParams data class 1-to-1 call
  • var ringbackToneUrl?: string
  • var endToneUrl?: string
  • var playEndToneRegardlessOfCallState?: boolean
  • var mediaStreamManager?: MediaStreamManager
  • var customMediaStream?: MediaStream
• VerifyCallParams data class 1-to-1 call
  • var ringToneUrl?: string
  • var endToneUrl?: string
  • var playEndToneRegardlessOfCallState?: boolean
  • var mediaStreamManager?: MediaStreamManager
  • var customMediaStream?: MediaStream
• ConferenceParams data class Group call
  • var endToneUrl?: string
  • var playEndToneRegardlessOfCallState?: boolean
  • var mediaStreamManager?: MediaStreamManager
  • var customMediaStream?: MediaStream
• EnableVideoOptions data class 1-to-1 callGroup call
  • var mediaStreamManager?: MediaStreamManager
  • var customMediaStream?: MediaStream
• START_FAIL_REASON enum 1-to-1 callGroup call
• MakeCallError data class 1-to-1 call
• VerifyCallError data class 1-to-1 call
• JoinConferenceError data class Group call
• DEBUG_NOTICE enum 1-to-1 callGroup call
• KitDelegate protocol 1-to-1 callGroup call
• InitConfig data class 1-to-1 callGroup call
  • var delegate?: KitDelegate

Removed

• Call class 1-to-1 call
  • function setVideoModifier(canvasElement: HTMLCanvasElement)
  • function resetVideoModifier()
• Conference class Group call
  • function setVideoModifier(canvasElement: HTMLCanvasElement)
  • function resetVideoModifier()
• MakeCallParams data class 1-to-1 call
  • var initMedia?: InitMedia
• VerifyCallParams data class 1-to-1 call
  • var initMedia?: InitMedia
• ConferenceParams data class Group call
  • var initMedia?: InitMedia
• EnableVideoOptions data class 1-to-1 callGroup call
  • var initMedia?: InitMedia
• MakeCallDelegate protocol 1-to-1 call
  • evtInnerLog(innerLogObject: InnerLogObject)
• VerifyCallDelegate protocol 1-to-1 call
  • evtInnerLog(innerLogObject: InnerLogObject)
• ConferenceDelegate protocol Group call
  • evtInnerLog(innerLogObject: InnerLogObject)
• InnerLogObject data class 1-to-1 callGroup call
• INNER_LOG_NAME enum 1-to-1 callGroup call
• KIT_DISCONNECT_REASON enum 1-to-1 callGroup call
  • PLANETKIT_DISCONNECT_REASON_WEB_BROWSER_NOT_SUPPORTED: 1612