video-call-js-sdk
v2.0.36
Published
Video Call JS SDK - Prod
Downloads
1
Readme
Hướng dẫn sử dụng Video Call JS SDK
Để có được thông tin cấu hình chi tiết cũng như hướng dẫn sử dụng và code sample, vui lòng truy cập vào địa chỉ https://ucc.vnpt.vn/
Cài đặt
Chạy lệnh dưới đây tại project đang sử dụng
npm i video-call-js-sdk
Cấu hình
Để sử dụng được SDK chúng ta cần một bộ config cho từng khách hàng (sau khi đã đăng ký tài khoản) với các tham số sau:
token_id
token_key
client_id
client_secret
API
1. createUUID()
2. initConfig(url, config)
- `url` - Đường dẫn đến component dùng để thực hiện màn hình gọi video
- `config` - Một object gồm 4 thuộc tính : { token_id, token_key, client_id, client_secret}. Lưu ý, đây là bộ key được dùng riêng cho từng khách hàng
3. registerDevice(deviceToken, uuidCustomer, personName)
- `deviceToken` - chuỗi định dạng bất kỳ, có thể dùng uuidCusomer cho tham số này
- `uuidCustomer` - chuỗi định danh với từng người dùng
- `personName` - tên của người đăng ký thiết bị
4. initSocket(Stomp, uuidCustomer)
- `Stomp` - Một instance của thư viện StompJS sau khi đã cài đặt
- `uuidCustomer` - Chuỗi định danh với từng người dùng
5. disconnectSocket()
6. initVideoCall(JitsiMeetExternalAPI, uuidCustomer, width, height)
- `JitsiMeetExternalAPI` - Instance của JitsiMeetExternalAPI sau khi cài đặt thư viện
- `uuidCustomer` - Chuỗi định danh với từng người dùng
- `width` - Chiều rộng của màn hình gọi
- `height` - Chiều dài của màn hình gọi
7. initVideoCall(JitsiMeetExternalAPI, uuidCustomer, width, height)
- `JitsiMeetExternalAPI` - Instance của JitsiMeetExternalAPI sau khi cài đặt thư viện
- `uuidCustomer` - Chuỗi định danh với từng người dùng
- `width` - Chiều rộng của màn hình gọi
- `height` - Chiều dài của màn hình gọi
8. createCall(callerId, callerName, receiverCallers)
- `callerId` - Id của người dùng khi đăng ký thiết bị
- `callerName` - Tên người gọi
- `receiverCallers` - Một mảng UUID người nhận cuộc gọi , trong trường hợp này chỉ truyền duy nhất 1 UUID đối với v2
9. endCall(callerId)
- `callerId` - Id của người dùng khi đăng ký thiết bị
10. removeDevice(personIdApp)
- `personIdApp` - Id của người dùng khi đăng ký thiết bị
11. getFile(id)
- `id` - Room Id của phòng muốn lấy file ghi âm