Room

Room 클래스는 카카오 i 커넥트 라이브 SDK의 주요 클래스 중 하나입니다. 카카오 커넥트 라이브에서 Room은 서비스에 따라 회의실, 채팅방 등 스트리밍 서비스를 사용하는 공간을 의미합니다.
Room 클래스는 Provisionsing Scope의 Child Scope로 운영되므로, 메서드 호출 전 인증을 수행하는 signIn() 메서드를 먼저 호출해야 합니다. Room 클래스는 Property와 Method로 구성됩니다.

Property

Throws

인증을 수행하는 signIn() 메서드를 호출하지 않고, Room에 비정상적으로 접근했을 때 다음의 예외가 발생할 수 있습니다.

Method

Room 클래스의 메서드는 다음과 같습니다.

connect()

roomId로 식별되는 특정 Room에 접속하고 스트림의 송신 및 수신을 위한 절차를 시작합니다.

코드예제connect() Syntax

room.connect(roomId = "{roomId}")

disconnect()

현재 접속 중인 Room과 연결을 끊습니다.

코드예제disconnect() Syntax

room.disconnect()

subscribe()

Room의 Remote Participant(리모트 참여자)가 공유한 비디오를 수신(구독)합니다. 시청하지 않고 데이터만 사용, 또는 별도의 Renderer를 사용할 목적을 제외하고, subscribe() 메서드를 직접 호출하는 것은 권장하지 않습니다.

주의
카카오 i 커넥트 라이브 SDK에서는 RemoteVideo 클래스의 attach()와 detach() 메서드를 통해 리모트 참여자의 비디오를 자동으로 구독 및 해지합니다. VideoRenderer에서 가시성 변화에 따라 RemoteVideo의 attach() 또는 detach() 메서드가 자동으로 호출됩니다. 따라서 subscribe() 메서드를 직접 호출하는 것은 권장하지 않습니다.

코드예제subscribe() Syntax

room.subscribe(videoIds = [1,2,3....])

Returns

unsubscribe()

내가 수신하고 있는 리모트 참여자의 비디오 아이디(videoIds)를 인자로 사용하여 해당 리모트 비디오의 수신(구독)을 중단합니다.

코드예제unsubscribe() Syntax

room.unsubscribe(videoIds = [1,2,3....])

Returns

publish()

Local Participant(로컬 참여자)가 생성한 로컬 미디어(비디오/오디오)를 다른 리모트 참여자들과 공유합니다.

코드예제publish() Syntax

val contents: LocalContents =
                    ConnectLive.createLocalMedia(preferFrontCamera, true).apply {
                        video?.isEnabled = true
                        audio?.isEnabled = true
                    }

room.publish(contents)

unpublish()

Local Participant(로컬 참여자)가 Room에 송출 중인 로컬 미디어(비디오/오디오)의 공유를 취소합니다.

코드예제unpublish() Syntax

room.unpublish(contents)

getVideo()

특정 리모트 비디오 ID(videoId)를 인자로 사용하여, 해당 비디오가 속하는 리모트 비디오 객체를 반환합니다.

코드예제getVideo() Syntax

room.getVideo(videoId = 1)

Returns

getStats()

PeerConnection을 대상으로 전송 중 또는 수신 중인 미디어에 대한 품질 지표를 확인할 수 있는 RTCStats을 가져옵니다. PeerConnection은 로컬 컴퓨터와 리모트 피어 간의 WebRTC 연결을 의미합니다.

코드예제getStats() Syntax

room.getStats(up = true, down = true).thenApply { stats: Map<String,RTCStats> ->
	...
}

Returns

subscribeStats()

PeerConnection을 대상으로 전송 중 또는 수신 중인 미디어에 대한 품질 지표를 확인할 수 있는 RTCStats을 특정 간격으로 전달받습니다.

코드예제subscribeStats() Syntax

val stats = room.subscribeStats(intervalInMillis = 5000L)

Returns

getAudioLevels()

특정 간격으로 현재 참여자들의 오디오 볼륨 레벨을 반환합니다. 고객 서비스에서는 주기적으로 이 값을 획득하여, 오디오 레벨을 표시하는 데 사용할 수 있습니다.

코드예제getAudioLevels() Syntax

room.getAudioLevels(intervalInMillis = 200L).observe(this) { audioLevels ->
	updateAudioLevels(audioLevels)
}

Returns

sendUserMessage()

Room에 있는 특정 리모트 참여자 또는 전체 리모트 참여자에게 메시지를 전송합니다.

코드예제sendUserMessage() Syntax

// 전체에게 보내기
room.sendUserMessage(message = message)

// 특정 참여자에게 보내기
room.sendUserMessage(message = message, targets = targets)

Room.Config()

ConnectLive.createRoom으로 Room을 생성할 때, 수신을 위한 운용 설정을 수행합니다. 기본 Config 값을 사용할 것을 권장하며, 기본값 사용 시 이 메서드를 호출하지 않아도 됩니다.

코드예제Room.Config() Syntax

config = Room.Config(
                videoReceiverGrowthRate = 10,
                videoReceiverInitialCount = 10,
                videoReceiverMaximumCount = 50
            )