Socket
Book a DemoInstallSign in
Socket

@ark-org/simple-peer-connector

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ark-org/simple-peer-connector

# API

0.0.7
latest
npmnpm
Version published
Weekly downloads
0
-100%
Maintainers
1
Weekly downloads
 
Created
Source

@ark-org/simple-peer-connector

API

SendPeer 单人发送RTC对象

构造参数 config

  • iceServers turn或stun服务器配置项

  • server websocket服务器地址

  • onConnected: (remoteStream, localStream) : void => {} 连接成功后的回调函数

  • onHangup: () : void => {} 产生挂机行为后的回调函数

.connect(localStream): void

发起连接行为

.hangup(): void

发起挂机行为,并断开连接

ReceivePeer 单人接收RTC对象

构造参数 config

  • iceServers turn或stun服务器配置项

  • server websocket服务器地址

  • onConnected: (remoteStream, localStream) : void => {} 连接成功后的回调函数

  • onHangup: () : void => {} 产生挂机行为后的回调函数

.connect(localStream): void

发起连接行为

.hangup(): void

发起挂机行为,并断开连接

MultiplePeer 多人RTC对象

构造参数 config

  • iceServers turn或stun服务器配置项

  • server websocket服务器地址

  • onStream: (member: Member, remoteStream: MediaStream), localStream: MediaStream), allMembers: Member[]) : void => {} 当有视频流、音频流加入/变化时的回调函数,参数分别为:本地用户对象、远程流媒体对象

  • onRemove: (member: Member, allMembers: Member[]) : void => {} 有其他用户离开房间时的回调函数,参数分别为:断开的用户对象,当前房间的所有用户对象

  • onDisconnected: (allMembers: Member[]) : void => {} 当前房间有用户断开后的回调函数,参数分别为:当前房间的所有用户对象

.connect(roomId: string, hasCameraStream: boolean, hasAudioStream: boolean, localStream: MediaStream): void

发起连接行为,参数分别为:房间Id、是否开启摄像头流、是否开启麦克风流、本地流媒体对象

.disconnect(): void

发起挂机行为,并断开连接

.switchStream(hasCameraStream: boolean, hasAudioStream: boolean): void => {}

切换视频流行为,参数分别为:是否开启摄像头流、是否开启麦克风流,发起该行为后,该房间内的所有用户都会收到onStream事件

hangup(): void => {}

发起挂断行为,发起该行为后,该房间内的所有用户都会收到onRemove事件

FAQs

Package last updated on 29 Mar 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.