Kakao i Connect Live::Connect Live SDK::iOS SDK::SDK 주요 메서드

페이지 이동경로

SDK 주요 메서드

closeRemon()

방송 또는 통화를 종료합니다. RemonCall 또는 RemonCast를 이용하여 방송 또는 통화를 재개하고 싶다면 새로운 객체를 생성해야 합니다.

코드예제closeRemon() Syntax

@objc public func closeRemon()

connect()

통화를 위해 채널에 연결합니다.

코드예제connect() Syntax

@objc public func connect(_ ch: String, _ config: RemonConfig? = nil)

connect() Elements
파라미터 타입 필수 여부 설명
ch String 필수 채널 ID
config RemonConfig 선택 통화 사용자 설정

create()

create()는 방송 채널을 생성하는 메서드이며, 해당 메서드는 방송 또는 그룹 통화에 주로 사용됩니다.

방송

코드예제방송 create() Syntax

@objc public func create(_ config: RemonConfig? = nil)

방송 Create() Elements
파라미터 타입 필수 여부 설명
config RemonConfig 선택 방송 사용자 설정

그룹 통화

@objc public func create(
									roomName: String, 
									config: RemonConfig,
									callback: OnConferenceEventCallback ) -> RemonConferenceCallbacks
그룹 통화 Create() Elements
파라미터 타입 필수 여부 설명
roomName String 필수 그룹 통화 룸 이름
config RemonConfig 필수 그룹 통화 기본 설정
callback OnConferenceEventCallback 필수 그룹 통화 송출을 위한 RemonParticipant 설정

join()

방송에 참여합니다.

코드예제join() Syntax

@objc public func join(chId: String, _ config: RemonConfig? = nil)

join() Elements
파라미터 타입 필수 여부 설명
chId String 선택 참여할 방송의 Channel ID
config RemonConfig 선택 통화 사용자 설정

fetchCalls()

전체 통화 목록을 조회합니다.

코드예제fetchCalls() Syntax

@objc public func fetchCalls(complete: @escaping (Array<RemonSearchResult>?) -> Void)

fetchCalls() Elements
파라미터 타입 필수 여부 설명
complete Callback 선택 통화 목록 조회 결과를 배열로 표시

fetchCast()

전체 방송 목록을 조회합니다.

코드예제fetchCast() Syntax

@objc public func fetchCast(complete: @escaping (Array<RemonSearchResult>?) -> Void)

fetchCast() Elements
파라미터 타입 필수 여부 설명
complete Callback 선택 방송 목록 조회 결과를 배열로 표시

setLocalVideoEnabled()

송출중인 로컬(자신) 비디오를 켜거나 끕니다.

코드예제setLocalVideoEnabled() Syntax

@objc public func setLocalVideoEnabled(isEnabled: Bool = true)

setLocalVideoEnabled() Elements
파라미터 타입 필수 여부 설명
isEnabled Boolean 필수 로컬(자신) 비디오 활성화 여부 설정
true: 로컬(자신) 비디오 활성화
false: 로컬(자신) 비디오 비활성화

setLocalAudioEnabled()

송출 중인 로컬(자신) 오디오를 켜거나 끕니다.

코드예제setLocalAudioEnabled() Syntax

@objc public func setLocalAudioEnabled(isEnabled: Bool = true)

setLocalAudioEnabled() Elements
파라미터 타입 필수 여부 설명
isEnabled Boolean 필수 로컬(자신) 오디오 활성화 여부 설정
true: 로컬(자신) 오디오 활성화
false: 로컬(자신) 오디오 비활성화

setRemoteVideoEnabled()

수신 중인 리모트(상대방) 비디오를 켜거나 끕니다.

코드예제setRemoteVideoEnabled() Syntax

@objc public func setRemoteVideoEnabled(isEnabled: Bool = true)

setRemoteVideoEnabled() Elements
파라미터 타입 필수 여부 설명
isEnabled Boolean 필수 리모트(상대방) 비디오 활성화 여부 설정
true: 리모트(상대방) 비디오 활성화
false: 리모트(상대방) 비디오 비활성화

setRemoteAudioEnabled()

수신중인 리모트(상대방) 오디오를 켜거나 끕니다.

코드예제setRemoteAudioEnabled() Syntax

@objc public func setRemoteAudioEnabled(isEnabled: Bool = true)

setRemoteAudioEnabled() Elements
파라미터 타입 필수 여부 설명
isEnabled Boolean 필수 리모트(상대방) 오디오 활성화 여부 설정
true: 리모트(상대방) 오디오 활성화
false: 리모트(상대방) 오디오 비활성화

switchCamera()

디바이스의 전면/후면 카메라 또는 미러 모드(좌우 반전)으로 전환합니다.

코드예제switchCamera() Syntax

@objc public func switchCamera(isMirror: Bool = false, isToggle: Bool = true) -> Bool

switchCamera() Elements
파라미터 타입 필수 여부 설명
isMirror Boolean 선택 미러 모드(좌우 반전) 사용 여부
true: 미러 모드 적용
false: 미러 모드 적용하지 않음
isToggle Boolean 선택 통화 사용자 설정
true: 전면 카메라
false: 후면 카메라

setAudioSessionConfiguration()

iOS의 오디오 세션을 설정합니다.

코드예제setAudioSessionConfiguration() Syntax

@objc public static func setAudioSessionConfiguration(
	category: AVAudioSession.Category,
	mode: AVAudioSession.Mode,
	options: AVAudioSession.CategoryOptions)

setAudioSessionConfiguration() Elements
파라미터 타입 필수 여부 설명
category Category 필수 카테고리(애플 iOS 레퍼런스 참조)
mode Mode 필수 모드(애플 iOS 레퍼런스 참조)
options CategoryOptions 필수 옵션(애플 iOS 레퍼런스 참조)

getCurrentRemonState()

현재 SDK의 상태를 정수값으로 얻어옵니다.

SDK 상태
구분 상태 설명
0 READY 초기화 후 준비 상태
1 INIT 객체를 생성하고, 네트워크 연결
2 CREATE 채널 생성 및 접속(통화인 경우 상대방을 기다리는 상태)
3 CONNECT 통화, 방송에서 채널에 접속 중일 때의 상태
4 COMPLETE 방송 생성 완료, 방송 참여 완료, 통화 연결 완료
5 CLOSE 연결이 종료됨

코드예제getCurrentRemonState() Syntax

@objc public func getCurrentRemonState() -> Int

getCurrentRemonState() Elements
파라미터 타입 필수 여부 설명
상태 Integer 필수 상태별 0~5 정수값

leave()

그룹 통화를 종료합니다.

코드예제leave() Syntax

@objc public func leave()

getParticipants()

그룹 통화 참여자의 ID를 키로 하는 전체 참여자 테이블을 가져옵니다.

코드예제getParticipants() Syntax

@objc public func getParticipants() -> [String: RemonParticipant]

안내
자세한 iOS 버전의 SDK 레퍼런스는 iOS SDK Reference 문서를 참고하시기 바랍니다.

관련 문서

Android SDK Reference Kakao i Connect Live iOS SDK Reference Kakao i Connect Live Web SDK Reference Kakao i Connect Live

이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.