npm 包 circuit-call-button 使用教程

阅读时长 4 分钟读完

介绍

circuit-call-button 是一个基于 React 的 npm 包,可以用来快速集成 Circuit 拨号功能到你的前端应用程序中。使用该 npm 包,你可以通过一个按钮来呼叫其他的 Circuit 用户,或群组,或电话号码等。

安装

可以通过 npm 命令来安装 circuit-call-button 包:

如何使用

引入

使用 import 语句引入 circuit-call-button

用法

下面是一个最基本的用法示例,该示例中你需要传入两个必要的 props 值 clientto

其中 circuitClient 是一个必须的参数,通过它你可以与 Circuit 云端建立连接,可以用下面的代码示例来创建它:

-- -------------------- ---- -------
------ ------- ---- --------------

----- ------------- - ----------------
  ---------- -----------------
  ------- --------------
  ------ ------
  ------------- --------------------------------
---

----------------------

其中 to 是一个必须的参数,用于指定你要拨打的地址,可以是用户 id,群组 id,电话号码等。

除了这两个必要的参数外,circuit-call-button 还支持一些可选的属性,下面是它们的列表:

  • type: 指定拨号类型,取值可以是 audio, video, screen, group, pstn 等,默认为 audio
  • disabled: 是否禁用按钮,取值可以是 true, false,默认为 false
  • iconColor: 指定按钮的颜色,取值可以是 default, primary, secondary, success, warning, danger 等,默认为 default
  • label: 指定按钮的文本,可以是任意字符串,默认为 Call.

下面是一个完整的用法示例,该示例可以用于拨打一个群组:

-- -------------------- ---- -------
------ ------- ---- --------------
------ ----------------- ---- ----------------------

----- ------------- - ----------------
  ---------- -----------------
  ------- --------------
  ------ ------
  ------------- --------------------------------
---

----------------------

----- -- - -
  ----- --------
  --- ---------------
--

------------------
  ----------------------
  -------
  ------------
  -------------------
  ----------- ----- ----- -----
--

深入学习

circuit-call-button 的实现依赖于 circuit-sdkcircuit-sdk 是一个用来构建 Circuit 应用程序的库,它提供了丰富的接口和方法,可以帮助你与 Circuit 云端建立连接,管理用户身份认证,处理实时聊天和通话等。

如果你想深入学习 circuit-sdk,建议你访问官方文档:https://circuitsandbox.net/sdk/classes/Client.html

总结

circuit-call-button 提供了一个非常方便的方式来将 Circuit 拨号功能集成到你的前端应用程序中,可以帮助你快速地为你的用户提供语音和视频通话的功能。同时,你也可以借此机会深入了解 circuit-sdk,它是一个非常实用的库,可以帮助你构建出功能强大的 Circuit 应用程序。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066bcf967216659e244e19

纠错
反馈