채팅방 정보

VChatCloud의 RoomInit 라이브러리를 사용하면 CMS에 정의된 채팅방의 설정 정보를 손쉽게 가져와 활용할 수 있습니다. 이 문서는 채팅방 정보를 로드하고 관리하는 방법을 안내합니다.

기능 개요

RoomInit 라이브러리는 다음과 같은 기능을 제공합니다.

• 채팅방의 기본 설정 정보 로드
• 메타버스, RTC, 번역 등의 고급 기능 설정 확인
• 사용자 제한, 해상도 등의 기술적 설정 조회
• 채팅방 타입 및 이름 등의 기본 정보 확인

구현 방법

1. 사전 준비

RoomInit 라이브러리는 별도의 API 키나 CMS 사전 설정 없이 바로 사용할 수 있습니다. 먼저 Overview 페이지의 기본 설정 과정을 완료하세요.

2. 라이브러리 초기화

script.js 파일에서 RoomInit 인스턴스를 생성하고 채팅방 정보를 로드합니다.

// e7lib에서 RoomInit 불러오기
const { RoomInit } = e7lib;

// 채팅방 정보 로드
let roomInfo;
const roomInitInstance = new RoomInit(channelKey, function (res) {
  roomInfo = res; // 채팅방 정보 객체를 변수에 저장

  // 채팅방 정보 로드 완료 후 실행할 코드
  console.log("채팅방 이름:", roomInfo.roomName());
  console.log("최대 사용자 수:", roomInfo.userMax());
});

API 레퍼런스

RoomInit 생성자

new RoomInit(channelKey, callback);

매개변수

매개변수	타입	설명
channelKey	String	채팅방 고유 식별자 (룸 ID)
callback	Function	룸 정보 로드 완료 후 호출될 콜백 함수

콜백 함수 매개변수

매개변수	타입	설명
res	Object	채팅방 정보 객체 (roomInfo와 동일)

채팅방 정보 메소드

RoomInit을 통해 반환된 객체(roomInfo)는 다음과 같은 메소드를 제공합니다.

메소드	반환 타입	설명	예시 값
email()	String	관리자 이메일 주소	"admin@vchatcloud.com"
metaverse()	String	연결된 메타버스 URL	"http://vchatcloud/sample/index.html"
resolution()	String	화면 해상도 설정	"720" (픽셀 단위)
roomName()	String	채팅방 이름	"vchatcloud 공식 채팅방"
roomType()	String	채팅방 타입 코드	"01" (일반), "02" (화상채팅) 등
rtcYn()	String	화상 채팅(RTC) 사용 여부	"Y" (사용) 또는 "N" (미사용)
transYn()	String	번역 기능 사용 여부	"Y" (사용) 또는 "N" (미사용)
userMax()	String	최대 접속 가능 사용자 수	"2000"

주의사항 및 팁

• 채팅방 정보는 최초 로드 시 한 번만 가져오므로, 반환된 roomInfo 객체를 전역 변수나 상태로 저장하여 재사용하는 것이 효율적입니다.
• 채팅방 설정값이 변경되는 경우, 페이지를 새로고침하거나 RoomInit을 다시 호출해야 최신 정보를 반영할 수 있습니다.
• 모든 메소드는 문자열(String) 타입을 반환하므로, 숫자 데이터(예: userMax())를 계산에 사용할 경우 숫자로 변환해야 합니다.

이 문서의 예제를 참고하여 VChatCloud의 RoomInit 라이브러리를 활용해 채팅방 정보를 효과적으로 관리하고 활용할 수 있습니다.