1.0.3 • Published 6 months ago

call-services v1.0.3

Weekly downloads
-
License
ISC
Repository
-
Last release
6 months ago

VPBANK Call Services

Mô tả

Call Services là một thư viện javascript cho trình duyệt, có nhiệm vụ thực hiện cuộc gọi video hoặc audio qua mạng ngang hàng p2p. Sử dụng công nghệ WebRTC

Các tính năng chính:

  • Tạo cuộc gọi
  • Lắng nghe cuộc gọi

Cài đặt

// with npm
npm install call-services

Cách sử dụng

1. Người gọi

Khởi tạo người gọi

// token là mã do hệ thống tích hợp trả về. callType bằng "AUDIO" hoặc "VIDEO"
const caller = new Caller(token,callType,options);
  • callType bằng AUDIO hoặc VIDEO, loại cuộc gọi.
  • options {env:staging|product} môi trường staging hoặc product, mặc định bằng staging

Thêm localvideoremoteVideo.

caller.addVideoElement(localVideo, remoteVideo);

localvideo là một HTMLVideoElement của người gọi. remoteVideo là của người nghe

Các chức năng

Tạo cuộc gọi

caller.makeCall();

Hủy cuộc gọi

caller.cancelCall();

Kết thúc cuộc gọi

caller.endCall();

Lắng nghe trạng thái thay đổi

caller.onChangeStatus((status) => {})

Lắng nghe trạng thái kết nối. Sử dụng khi trạng thái là CONNECT

caller.onConnect((connected)=>{})

Đổi camera

caller.turnVideo()

Tắt Mic

caller.mute()

Các giá trị

// Trạng thái kết nối
caller.connected
// Thông tin thiết bị
caller.deviceInfo
//Trạng thái
caller.status

Bảng trạng thái:

trạng tháimô tả
STARTTrạng thái khởi đầu chưa thể tạo cuộc gọi khi ở trạng thái này
READYCó thể thực hiện tạo cuộc gọi
REQUESTMột yêu cầu tạo cuộc gọi mới đươc tạo
BUSYKhông có người nghe sẵn sàng nghe máy
CONNECTKết nối thành công với người nghe
END_CALLNgười nghe kết thúc cuộc gọi. có thể makeCall từ trạng thái này
DISCONNECTMất kết nối tơi người nghe. có thể makeCall từ trạng thái này

Ví dụ:

Xem chi tiết ví dụ tại đây

2. Người lắng nghe

Khởi tạo người nghe

// token là mã do hệ thống tích hợp trả về
const listener = new Listener(token,options);
  • options {env:staging|product, timeout:number} môi trường staging hoặc product, mặc định bằng staging.
  • timeout <đơn vị ms> thời gian người nghe bắt máy, mặc định 30000

Thêm localvideoremoteVideo.

listener.addVideoElement(localVideo, remoteVideo);

localvideo là một HTMLVideoElement của người nghe. remoteVideo là của người gọi

Các chức năng

Chờ cuộc gọi

listener.online();

Hủy chờ cuộc gọi

listener.offline();

Chấp nhận cuộc gọi

listener.acceptCall();

Từ chối cuộc gọi

listener.rejectCall().then();

Kết thúc cuộc gọi

listener.endCall().then();

Lắng nghe trạng thái thay đồi

listener.onChangeStatus((status) => {})

Lắng nghe trạng thái kết nối với socket. Sử dụng khi trạng thái là CONNECT

listener.onConnect((connected)=>{})

Lắng nghe trạng thái kết nối cuộc gọi. Sử dụng khi trạng thái là CONNECT

listener.onStreamConnect((connected)=>{})

Chụp ảnh

const url = listener.getScreenshot(type)

type có 2 giá trị là BOTHCALLER.Với BOTH nếu muốn chụp ảnh cả người nghe và người gọi, CALLER chỉ chụp ảnh người nghe

Ghi video cuộc gọi

listener.startRecording(time,type,(blob)=>{})

Tắt Mic

listener.mute()

Ngắt kết nối

listener.disconnect()

time là thời gian ghi, đơn vị ms. type tương tự với hàm getScreenshot. Hàm callback trả lại một blob chứa dữ liệu bản ghi Các giá trị

// Id của cuộc gọi
listener.callId
// Loại cuộc gọi `AUDIO` hoặc `VIDEO`
listener.callType
// Thông tin thiết bị
listener.deviceInfo
//Trạng thái
listener.status
//Tên sản phẩm
listener.productName
//Mô tả sản phẩm
listener.productDescription
//ID của người gọi
listener.requestId

Bảng trạng thái:

trạng tháiMô tả
ONLINEĐang chờ cuộc gọi
OFFLINEKhông chờ cuộc gọi
RING_CALLCó cuộc gọi tới
CONNECTKết nối thành công với người gọi
END_CALLNgười gọi kết thúc cuộc gọi. Gọi online() để tiếp tục chờ cuộc gọi
CANCEL_CALLNgười gọi hủy cuộc gọi. Gọi online() để tiếp tục chờ cuộc gọi
DISCONNECTMất kết nối đến người gọi. Gọi online() để tiếp tục chờ cuộc gọi
TIMEOUTHết thời gian để nhận cuộc gọi

Ví dụ:

Xem chi tiết ví dụ tại đây;

Truyền thông tin dữ liệu.

Kênh dữ liệu

Sử dụng DataChanel được khởi tạo trong CistenerCaller

const dataChanel = listener.dataChanel;
const dataChanel = caller.dataChanel;

Sự kiện open

Trước khi kênh dữ liệu có thể được sử dụng để gửi dữ liệu, máy khách cần đợi cho đến khi kênh dữ liệu được mở. Điều này được thực hiện bằng cách lắng nghe sự open

dataChanel.onopen = (open) => {
  console.log(open)
};

Nhắn tin

Việc gửi tin nhắn trên a DataChanel được thực hiện bằng cách gọi hàm send() với dữ liệu chúng ta muốn gửi. Tham số data cho hàm này có thể là một string, a Blob, an ArrayBuffer hoặc và ArrayBufferView

dataChanel.send("hello")

Caller và Listener nhận dữ liệu bằng hàm onmessage

dataChanel.onmessage = (event)=>{
  const message = event.data;
}

License

MIT

1.0.3

6 months ago

1.0.2

7 months ago

1.0.1-a

9 months ago

1.0.0

1 year ago

0.0.4-d

1 year ago

0.0.4-c

1 year ago

0.0.4-b

1 year ago

0.0.4-a

1 year ago

1.0.0-e

1 year ago

1.0.0-d

1 year ago

1.0.0-a

1 year ago

1.0.0-c

1 year ago

1.0.0-b

1 year ago

0.0.3-f

1 year ago

0.0.3-e

1 year ago

0.0.3-d

1 year ago

0.0.3-c

1 year ago

0.0.3-b

1 year ago

0.0.3-a

1 year ago

0.0.2-e

1 year ago

0.0.2-d

1 year ago

0.0.2-b

1 year ago

0.0.2-c

1 year ago

0.0.2-a

1 year ago

0.0.1-f

1 year ago

0.0.1-e

1 year ago

0.0.1-d

1 year ago

0.0.1-c

1 year ago

0.0.1-a1

1 year ago

0.0.1-a

1 year ago

0.0.1-b

1 year ago