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

페이지 이동경로

LocalVideo

Local Participant(로컬 참여자)가 생성한 비디오를 Room에 송출하기 위한 로컬 비디오 스트림 클래스입니다.

LocalVideo 전체 목록
클래스 구분 항목 설명
LocalVideo Property id 로컬 비디오 ID
owner 로컬 비디오의 소유자(참여자) ID
active 비디오 스트림의 활성화 여부를 변경하거나 현재 활성화 여부를 가져옴
extraValue 비디오 스트림 식별을 위해 임의 설정 가능한 레이블 정보
viewId 비디오 스트림에 연결된 렌더뷰 ID
Method attach() 비디오 스트림에 렌더뷰(Render View) 연결
detach() 비디오 스트림에 연결된 렌더뷰 해제

Property

id

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

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

owner

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

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

active

비디오 스트림의 활성화 여부을 변경하거나 현재 활성화 여부를 가져옵니다.

active Property
프로퍼티 타입 설명
active Boolean 비디오 스트림의 활성화 여부
true: 활성화
false: 비활성화

extraValue

비디오 스트림 식별을 위해 임의 설정 가능한 레이블 정보입니다. 이 값은 미디어 생성 시 Config.mediaOptions.videoExtraValue 값으로 설정되며, 생성된 이후에는 변경 사항은 반영되지 않습니다.

extraValue Property
프로퍼티 타입 설명
extraValue String 비디오 스트림 식별을 위해 임의 설정 가능한 레이블 정보
- 미디어 생성 시 Config.mediaOptions.extraValue 값으로 설정되며, 생성된 이후에는 변경 사항은 반영되지 않음

viewId

비디오 스트림에 연결된 렌더뷰 ID입니다.

viewId Property
프로퍼티 타입 설명
viewId String 비디오 스트림에 연결된 렌더뷰 ID

Method

attach()

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

코드예제attach() Syntax

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

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

detach()

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

코드예제detach() Syntax

video.detach()

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

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