API changelog

This page provides the list of API changes in PlanetKit 7.0 for Windows.

PlanetKit 7.0

Changed

• ConferenceParam class Group call

  Previous	PlanetKit 7.0.0
  AudioDescriptionInfo GetAudioDescriptionInfo()	const AudioDescriptionInfo& GetAudioDescriptionInfo()

• Configuration class 1-to-1 callGroup call

  Previous	PlanetKit 7.0.0
  static ConfigurationPtr Create(const WString &strBasePath, const WString &strDatabasePath)	static ConfigurationPtr Create(const WString &strPlanetKitSystemDirectory)

• IPeerControlEvent class Group call

  Previous	PlanetKit 7.0.0
  void OnScreenShareUpdated(PeerControlPtr pPeerControl, SubgroupPtr pSubgroup, EScreenShareState eState)	void OnScreenShareUpdated(PeerControlPtr pPeerControl, SubgroupPtr pSubgroup, EScreenShareState eState, IntOptional nDisabledReason)

• PeerControl class Group call

  Previous	PlanetKit 7.0.0
  void SetView(WindowHandle hWnd)	VideoRenderPtr SetView(WindowHandle hWnd)
  bool StopVideo(void *pUserData=nullptr, StoptVideoResultCallback pCallback=nullptr)	bool StopVideo(void *pUserData=nullptr, StopVideoResultCallback pCallback=nullptr)

• PlanetKitCall class 1-to-1 call

  Previous	PlanetKit 7.0.0
  bool SendShortData(const WString &strType, void *pData, unsigned int nSize, void *pUserData=nullptr, ResultCallback pCallback=nullptr)	bool SendShortData(const WString &strType, void *pData, unsigned int nSize, void *pUserData=nullptr, SendShortDataResultHandler pHandler=nullptr)

• PlanetKitConference class Group call

  Previous	PlanetKit 7.0.0
  bool SendShortData(const WString &strType, void *pData, unsigned int nSize, UserIdPtr pPeerId, void *pUserData=nullptr, ResultCallback pCallback=nullptr)	bool SendShortData(const WString &strType, void *pData, unsigned int nSize, UserIdPtr pPeerId, void *pUserData=nullptr, SendShortDataResultHandler pHandler=nullptr)
  bool SendShortDataToAllPeers(const WString &strType, void *pData, unsigned int nSize, void *pUserData=nullptr, ResultCallback pCallback=nullptr)	bool SendShortDataToAllPeers(const WString &strType, void *pData, unsigned int nSize, void *pUserData=nullptr, SendShortDataResultHandler pHandler=nullptr)

• SendVoiceProcessor class 1-to-1 callGroup call

  Previous	PlanetKit 7.0.0
  EPlanetkitNoiseSuppressorMode GetNoiseSuppressorMode()	EPlanetKitNoiseSuppressorMode GetNoiseSuppressorMode()
  bool SetNoiseSuppressor(EPlanetkitNoiseSuppressorMode ePlanetkitNoiseSuppressorMode=EPlanetkitNoiseSuppressorMode::PLNK_NOISE_SUPPRESSOR_MODE_ENABLE, void *pUserData=nullptr, ResultCallback pCallback=nullptr)	bool SetNoiseSuppressor(EPlanetKitNoiseSuppressorMode ePlanetKitNoiseSuppressorMode=EPlanetKitNoiseSuppressorMode::PLNK_NOISE_SUPPRESSOR_MODE_ENABLE, void *pUserData=nullptr, ResultCallback pCallback=nullptr)

• CallVerifiedParam class 1-to-1 call

  Previous	PlanetKit 7.0.0
  bool IsPeerUsePreparation()	bool IsPeerUseResponderPreparation()

• ECapturerMediaType enum 1-to-1 callGroup call

  Previous	PlanetKit 7.0.0
  PLNK_CAPTURER_TYPE_Unknown	PLNK_CAPTURER_TYPE_UNKNOWN
  PLNK_CAPTURER_TYPE_v210	PLNK_CAPTURER_TYPE_V210
  PLNK_CAPTURER_TYPE_v216	PLNK_CAPTURER_TYPE_V216
  PLNK_CAPTURER_TYPE_v410	PLNK_CAPTURER_TYPE_V410
  PLNK_CAPTURER_TYPE_Base_HDCP	PLNK_CAPTURER_TYPE_BASE_HDCP

• MakeCallParam class 1-to-1 call

  Previous	PlanetKit 7.0.0
  void SetPreparation(bool bPreparation)	void SetUseResponderPreparation(bool bUseResponderPreparation)
  bool IsPreparation()	bool UseResponderPreparation()

• Enum name changes

  Previous	PlanetKit 7.0.0	Note
  EPlanetkitNoiseSuppressorMode	EPlanetKitNoiseSuppressorMode	1-to-1 call, Group call

Added

• CameraController class 1-to-1 callGroup call

  • bool ChangeCamera(SharedPtr<CustomCamera> pCustomCamera)

• ConferencePeerScreenShareUpdatedParam class Group call

  • IntOptional GetDisabledReason()

• Configuration class 1-to-1 callGroup call

  • void EnableLog(const WString &strLogDirectory, WStringOptional strLogFileName, ELogLevel eLogLevel=ELogLevel::PLNK_LOG_SIMPLE)
  • void EnableLog(const WString &strLogDirectory, ELogLevel eLogLevel=ELogLevel::PLNK_LOG_SIMPLE, ELogSizeLimit eLogSizeLimit=ELogSizeLimit::PLNK_LOG_SIZE_LIMIT_LARGE)
  • const WString& GetPlanetKitSystemDirectory()

• CustomCamera class 1-to-1 callGroup call

  • inline bool IsPostingFrameAvailable()
  • inline bool IsRunning()
  • void OnStart()
  • void OnStop()
  • inline Start()
  • inline Stop()
  • inline WriteFrameData(SVideoFrame &sVideoFrame)

• EPlanetKitAutoGainControl enum 1-to-1 callGroup call

  • PLNK_AUTO_GAIN_CONTROL_TYPE_HARDWARE_ECHO_TOLERANCE = 3

• ESendShortDataFailReason enum 1-to-1 callGroup call

  • PLNK_SEND_SHORT_DATA_FAIL_REASON_NONE = 0
  • PLNK_SEND_SHORT_DATA_FAIL_REASON_INVALID_PARAMETER
  • PLNK_SEND_SHORT_DATA_FAIL_REASON_TOO_LONG_DATA_TYPE
  • PLNK_SEND_SHORT_DATA_FAIL_REASON_TOO_LONG_DATA
  • PLNK_SEND_SHORT_DATA_FAIL_REASON_TOO_FREQUENT
  • PLNK_SEND_SHORT_DATA_FAIL_REASON_TIMEOUT

• PeerControl class Group call

  • VideoRenderPtr GetVideoRender()

Removed

• CameraController class 1-to-1 callGroup call

  • bool IsPostingFrameAvailable(UINT64 ull64tick)
  • bool WriteFrameData(SVideoFrame &sVideoFrame)

• CommonVideoStatus class 1-to-1 callGroup call

  • const char * PeerId()
  • const char * ServiceId()
  • EVideoPauseReason VideoPauseReason()

• CommonVideoStatuses class 1-to-1 callGroup call

  • CommonVideoStatus* At(size_t nIdx)
  • size_t GetCount()

• ConferenceParam class Group call

  • EConnectToken ConnectToken()
  • static ConferenceParamPtr CreateWithAPIKey(UserIdPtr pMyID, const WString &strRoomID, const WString &strRoomServiceID, const WString &strAPIKey)
  • const WString& GetAPIKey()
  • int GetAudioInputNoSrcTimeOutSec()
  • int GetVideoInputNoSrcTimeOutSec()
  • void SetAudioInputNoSrcTimeOutSec(unsigned int nAudioInputNoSrcTimeOutSec)
  • void SetVideoInputNoSrcTimeOutSec(unsigned int nVideoInputNoSrcTimeOutSec)

• Configuration class 1-to-1 callGroup call

  • void EnableLogOutput(bool bEnable)
  • const WString& GetBasePath()
  • const WString& GetDatabasePath()
  • ELogLevel GetLogLevel()
  • ELogSizeLimit GetLogSizeLimit()
  • bool IsLogOutputEnabled()
  • void SetLogLevel(ELogLevel eLogLevel)
  • void SetLogSizeLimit(ELogSizeLimit eLogSizeLimit)

• EConnectToken enum 1-to-1 callGroup call

  • API_KEY
  • ACCESS_TOKEN

• ELogLevel enum 1-to-1 callGroup call

  • PLNK_LOG_SILENT

• ELogSizeLimit enum 1-to-1 callGroup call

  • PLNK_LOG_SIZE_LIMIT_UNLIMITED

• EStartFailReason enum 1-to-1 callGroup call

  • PLNK_START_FAIL_REASON_INVALID_API_KEY = 9

• MakeCallParam class 1-to-1 call

  • const WString& APIKey()
  • EConnectToken ConnectToken()
  • static MakeCallParamPtr CreateWithAPIKey(UserIdPtr pMyID, UserIdPtr pPeerID, const WString &strKey)
  • int GetAudioInputNoSrcTimeOutSec()
  • int GetVideoInputNoSrcTimeOutSec()
  • void SetAudioInputNoSrcTimeOutSec(unsigned int nAudioInputNoSrcTimeOutSec)
  • void SetVideoInputNoSrcTimeOutSec(unsigned int nVideoInputNoSrcTimeOutSec)

• PlanetKitConference class Group call

  • bool RequestPeerScreenShare(UserIdPtr pPeerId, const WStringOptional &strSubgroupName, void *pUserData, RequestPeerVideoResultCallback pCallback)
  • bool RequestPeerVideo(UserIdPtr pPeerId, const WStringOptional &strSubgroupName, EVideoResolution eVideoResolution)
  • bool RequestPeerVideo(UserIdPtr pPeerId, const WStringOptional &strSubgroupName, EVideoResolution eVideoResolution, void *pUserData, RequestPeerVideoResolutionCallback pCallback)
  • bool RequestPeerVideo(UserIdPtr pPeerId, const WStringOptional &strSubgroupName, EVideoResolution eVideoResolution, void *pUserData, RequestPeerVideoResultCallback pCallback)
  • bool StopPeerScreenShare(UserIdPtr pPeerId, const WStringOptional &strSubgroupName, void *pUserData, RequestPeerVideoResultCallback pCallback)
  • bool StopPeerVideo(UserIdPtr pPeerId, const WStringOptional &strSubgroupName, void *pUserData=nullptr, RequestPeerVideoResultCallback pCallback=nullptr)

• VerifyCallParam class 1-to-1 call

  • int GetAudioInputNoSrcTimeOutSec()
  • int GetVideoInputNoSrcTimeOutSec()
  • void SetAudioInputNoSrcTimeOutSec(unsigned int nAudioInputNoSrcTimeOutSec)
  • void SetVideoInputNoSrcTimeOutSec(unsigned int nVideoInputNoSrcTimeOutSec)

• VideoSource class 1-to-1 callGroup call

  • inline EVideoCapturerType GetType()
  • inline bool IsPostingFrameAvailable(UINT64 ullTick64)
  • inline bool OnFrame(SVideoFrame &sPlanetKitVideoFrame)