Kakao i Connect Live::Kakao i Connect Live 2.0::API 레퍼런스::iOS::RemoteVideo

페이지 이동경로

RemoteVideo

RemoteVideo 클래스는 Remote Participant(리모트 참여자)가 생성한 리모트 비디오(Remote Video)를 관리합니다.

RemoteVideo 전체 목록
클래스 구분 항목 설명
RemoveVideo Property id 리모트 비디오 ID
owner 리모트 비디오 소유자(참여자) ID
active 리모트 비디오 스트림의 활성화 여부
extraValue 리모트 비디오 스트림 식별을 위한 레이블 문자열
profile 리모트 비디오 스트림의 프로파일 정보
pause 리모트 비디오 스트림 수신을 일시 중지
viewId 리모트 비디오 스트림에 연결된 렌더뷰 ID
isSubscribed 리모트 비디오 스트림의 구독 여부
Method attach() 리모트 비디오 스트림에 렌더뷰 연결
detach() 리모트 비디오 스트림에 연결된 렌더뷰 해제
setProfile() 리모트 비디오 스트림의 프로파일 변경

Property

id

리모트 비디오 ID입니다. 읽기 전용이며 수정은 불가능합니다.

id Property
프로퍼티 타입 설명
id Int 리모트 비디오 ID
- 읽기 전용

owner

리모트 비디오의 소유자(참여자) ID입니다. 읽기 전용이며 수정은 불가능합니다.

owner Property
프로퍼티 타입 설명
owner String 리모트 비디오의 소유자(참여자) ID
- 읽기 전용

active

리모트 비디오 스트림의 활성화 여부를 나타냅니다. 읽기 전용이며 수정은 불가능합니다.

active Property
프로퍼티 타입 설명
active Boolean 리모트 비디오 스트림의 활성화 여부(읽기 전용)
true: 리모트 비디오 스트림을 활성화
false: 리모트 비디오 스트림을 비활성화

extraValue

리모트 비디오 스트림 식별을 위한 레이블 문자열입니다. 읽기 전용이며 수정은 불가능합니다.

extraValue Property
프로퍼티 타입 설명
extraValue String 리모트 비디오 스트림 식별을 위한 레이블 문자열
- 읽기 전용

profile

리모트 비디오 스트림의 프로파일 정보입니다. 읽기 전용이며 수정은 불가능합니다. OS의 경우 비디오 프로파일은 empty로 고정됩니다.

profile Property
프로퍼티 타입 설명
profile VideoProfileType 리모트 비디오 스트림의 프로파일 정보(읽기전용)
empty: 리모트 비디오 스트림을 활성화
low: 낮음
mid: 중간
high: 높음

pause

리모트 비디오 스트림 수신을 일시 중지합니다. 읽기 전용이며 수정은 불가능합니다.

pause Property
프로퍼티 타입 설명
pause Boolean 리모트 비디오 스트림 수신(읽기 전용)
true: 일시 중지
false: 일시 중지 해제

viewId

리모트 비디오 스트림에 연결된 렌더뷰 ID입니다. 읽기 전용이며, attach()로 렌더뷰를 연결하면 설정됩니다.

viewId Property
프로퍼티 타입 설명
viewId String 리모트 비디오 스트림에 연결된 렌더뷰 ID
- 읽기 전용

isSubscribed

리모트 비디오 스트림의 구독 여부를 나타냅니다. 읽기 전용이며 수정은 불가능합니다.

isSubscribed Property
프로퍼티 타입 설명
isSubscribed Boolean 리모트 비디오 스트림의 구독 여부(읽기 전용)
true: 구독 중
false: 구독 중이 아님

Method

attach()

리모트 비디오 스트림에 렌더뷰를 연결합니다. 다른 렌더뷰가 연결되어 있는 경우, 기존 뷰는 해제되고 새로운 뷰를 연결합니다.

코드예제attach() Syntax

guard let room = self.room else { return }
guard let participant = room.remoteParticipants[participantId] else { return }
guard let video = participant.videos[videoId] else { return }
video.attach(uiRenderView)

attach() Parameters
파라미터 타입 필수 여부 설명
view UIRenderView 필수 비디오를 렌더링할 뷰

detach()

리모트 비디오 스트림에 연결된 렌더뷰를 해제합니다.

코드예제detach() Syntax

video.detach()

setProfile()

리모트 비디오 스트림의 프로파일을 변경합니다.

코드예제setProfile() Syntax

video.setProfile(profile: .mid)

setProfile() Parameters
파라미터 타입 필수 여부 설명
profile VideoProfileType 필수 변경할 비디오 스트림 프로파일
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

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