@czhy/sip-sdk
v1.0.6
Published
Universal SIP video-call SDK (Vue2/Vue3 single bundle)
Maintainers
wangli5401Readme
@czhy/sip-sdk
基于 WebRTC 网关的 SIP 视频通话 SDK —— 编译后单产物，运行时自动兼容 Vue2 / Vue3，CSS 自动注入，开箱即用。
在消费端怎么用
Vue3 项目
npm install @czhy/sip-sdk// main.js
import { createApp } from 'vue'
import CzhySipSDK from '@czhy/sip-sdk'
import App from './App.vue'
createApp(App)
.use(CzhySipSDK, {
sipServer: '192.168.1.10:5060',
auth: { username: '6601', password: '123456', tokenSN: 'XXX' }
})
.mount('#app')Vue2 项目
npm install @czhy/sip-sdk// main.js
import Vue from 'vue'
import CzhySipSDK from '@czhy/sip-sdk'
import App from './App.vue'
Vue.use(CzhySipSDK, {
sipServer: '192.168.1.10:5060',
auth: { username: '6601', password: '123456', tokenSN: 'XXX' }
})
new Vue({ render: h => h(App) }).$mount('#app')两种用法都不需要 import CSS —— SDK 模块加载时自动注入到 <head>。
局部组件按需引入
// Vue3
import { SipCall, FunctionKeys, Keyboard } from '@czhy/sip-sdk'
// Vue2 同样Headless（无 UI 通话状态层）
Vue3 <script setup>：
import { useSipCall } from '@czhy/sip-sdk'
const {
isReady, isCalling, isInCall, incoming, callTime,
attachLocal, attachRemote,
dial, hangup, mute
} = useSipCall()Vue2 Options API：
import { sipCallMixin } from '@czhy/sip-sdk'
export default {
mixins: [sipCallMixin]
// this.sipState / this.dial / this.hangup ... 直接可用
}Peer dependencies
| 包 | 谁装 | 说明 |
|----|------|------|
| vue | 消费端 | Vue2 (^2.6.0) 或 Vue3 (^3.0.0) 都行 |
运行时三方依赖（axios / sortablejs / webrtc-adapter / fabric-with-erasing）作为 sip-sdk 的 dependencies，npm install 时自动装入。
License
MIT