Kakao i Connect Live::Kakao i Connect Live 2.0::API 레퍼런스::Web::LocalScreen

페이지 이동경로

LocalScreen

LocalScreen 클래스는 Local Participant(로컬 참여자)의 화면 공유를 제어합니다. LocalScreen 클래스는 Property와 Method로 구성됩니다.

LocalScreen 클래스 전체 목록
클래스 구분 항목 설명
LocalScreen Property room Room 객체
- LocalScreen 객체가 Room에 공유되면 해당 속성으로 접근 가능
audio LocalScreen에 속해 있는 LocalAudio 객체
video LocalScreen에 속해 있는 LocalVideo 객체
Method switchDisplay() 화면 공유 변경
stop() 화면 공유를 위해 생성된 오디오 객체와 비디오 객체 중지

Property

LocalScreen 클래스의 프로퍼티는 다음과 같습니다.

LocalScreen 프로퍼티 목록
Property 타입 설명
room Room Room 객체
- LocalScreen 객체가 Room에 공유되면 해당 속성으로 접근 가능
audio LocalAudio LocalScreen에 속해 있는 LocalAudio 객체
video LocalVideo LocalScreen에 속해 있는 LocalVideo 객체

Method

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

switchDisplay()

화면 공유를 변경합니다. 예를 들어, Chrome 탭을 공유하다 Desktop 화면을 전체 공유하는 등의 화면 공유 변경을 의미합니다.

코드예제switchDisplay() Syntax

await localScreen.switchDisplay();

switchDisplay() Returns
반환 구분 타입 설명
promise 성공 N/A 화면 캡처 전환 성공 시 아무것도 반환하지 않음
실패 Promise<ServerError>,
Promise<ClientError>
호출 실패 시 반환
- 화면 공유 해제 후 재공유(예외 발생 시 ServerError 발생)
- 화면 캡처 실패 시 ClientError 발생

stop()

화면 공유를 위해 생성된 오디오 객체와 비디오 객체를 중지합니다.

코드예제stop() Syntax

localScreen.stop();

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

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