ColdBrew API for TypeScript

ColdBrew API 상세 스펙

ColdBrew NPM

ColdBrew 백엔드 + 시그널링 서버

ColdBrew

ColdBrew 프로젝트는 webRTC를 쉽게 사용하게 만든 API 입니다.

React.js / Vue.js / Svelte 등 import 해서 사용 하면 됩니다.

현재는 최소한의 기능이지만 계속해서 기능 추가/ 업데이트 할 계획 입니다.

(화이트보드기능 추가, UI 애니메이션, nginx추가 등)

Setup

with npm: npm install coldbrew-core

with yarn: yarn add coldbrew-core

실행

1. 같은 네트워크 망 에서 사용 (= 와이파이)

   (chrome) 탭 2개 띄우고 같은 방 이름으로 접속.

2. 다른 네트워크 망에서 사용 (LTE <-> 와이파이) (불가)

   [stun 이슈 링크](https://github.com/ahnytae/ColdBrew-Core/issues /1)

프로젝트 (초기)Prototype 버전

ColdBrew Prototype 버전

사용법 예시

- 방 입장: /join/{roomName}/{nickName} (백엔드 API 이용)
  response: "SUCESS" 일때 방 입장 처리

- 방 진입 후 Video Stream 얻기: GetUserDevices.getDeviceStream()
  response: strteam 객체 반환

- 방 입장: SignalingController.joinRoom()
- 방 정보 조회: SignalingController.getRoomInfo()
- 장치변경: SignalingController.changeCamera("video" or "mic");

- 방 나가기: SignalingController.SignalEvent("leave", () => { /* callback 작성 */ })

사용 기술

DEMO (임시)

ColdBrew Demo (임시 버전이며 새롭게 다시 만들 예정)

1. 방 입장

일반탭, 시크릿탭 2개 띄어놓은 후 동일한 방 제목으로 입장 합니다.

2. 방 입장

본인과 원격 사용자 stream을 얻어 video를 띄웁니다.

3. 장치 on/off (카메라,마이크)

본인과 원격 사용자의 장치 on/off를 제어할 수 있습니다.

4. 장치 변경

본인의 장치를 연결된 다른 장치로 변경 가능 하며 원격 사용자에게 변경된 장치로 동기화 시킵니다.

5. 방 나가기

Socket 연결을 끊고 방을 나갑니다. (+ front에서 별도 종료페이지로 이동 처리)

[video]

기능

• 방입장/나가기
• 장치 변경
• 카메라/마이크 on/off