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

페이지 이동경로

LocalVideo

LocalVideo 클래스는 LocalMedia의 video 속성에 해당되는 객체입니다. LocalVideo클래스는 Property와 Method로 구성됩니다.

LocalVideo 클래스 전체 목록
클래스 구분 항목 설명
LocalVideo Property streamId 미디어의 고유 아이디
videoElements attach() 메서드를 통해 비디오를 바인딩하고 있는 비디오 엘리먼트
hd HD(High Definition, 고해상도) 모드
Method getMediaStreamTrack() 미디어 스트림 트랙 반환
getMediaStream() 미디어 스트림 반환
getStreamId() 미디어의 고유 아이디인 streamId 반환
setExtraValue() 서비스에서 필요한 값을 extraValue로 설정
getExtraValue() 서비스에서 설정한 extraValue 반환
setEnabled() 미디어 트랙의 상태 변경
stop() 미디어 트랙 중지
attach() 새로 생성한 비디오 엘리먼트에 비디오를 바인딩하거나, 기존 비디오 엘리먼트에 비디오를 바인딩
detach() attach()로 생성된 비디오 엘리먼트 삭제
setHd() HD(High Definition, 고해상도) 모드 설정

Property

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

LocalVideo 프로퍼티 목록
Property 타입 설명
streamId Number 미디어의 고유 아이디
videoElements HTMLVideoElement[] attach() 메서드를 통해 비디오를 바인딩하고 있는 비디오 엘리먼트
hd Boolean HD(High Definition, 고해상도) 모드

Method

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

getMediaStreamTrack()

미디어 스트림 트랙을 반환합니다. 미디어 스트림 트랙은 스트림 내의 단일 미디어 트랙으로, 비디오 트랙을 의미합니다.

코드예제getMediaStreamTrack() Syntax

const track = localVideo.getMediaStreamTrack();

getMediaStreamTrack() Returns
반환 타입 설명
MediaStreamTrack MediaStreamTrack 미디어 스트림 트랙(비디오)

getMediaStream()

미디어 스트림을 반환합니다.

코드예제getMediaStream() Syntax

const stream = localVideo.getMediaStream();

getMediaStream() Returns
반환 타입 설명
MediaStream MediaStream 미디어 스트림 트랙(비디오)

getStreamId()

미디어의 고유 아이디인 streamId를 반환합니다.

코드예제getStreamId() Syntax

const streamId = localVideo.getStreamId();

getStreamId() Returns
반환 타입 설명
streamId Number 미디어 고유 아이디

setExtraValue()

서비스에서 필요한 값을 extraValue로 설정합니다. 설정된 extraValue는 다른 참여자들과 공유됩니다.

코드예제setExtraValue() Syntax

localVideo.setExtraValue('{extraValue}');

setExtraValue() Parameters
파라미터 타입 필수 여부 설명
extraValue String 필수 저장이 필요한 문자열

getExtraValue()

서비스에서 설정한 extraValue를 반환합니다.

코드예제getExtraValue() Syntax

localVideo.setExtraValue('{extraValue}');

getExtraValue() Returns
반환 타입 설명
extra value String 서비스에서 설정한 값

setEnabled()

미디어 트랙의 상태를 변경합니다. 미디어 트랙 상태를 true로 설정하여 미디어 스트림 트랙을 활성화하면, 미디어 출처 스트림의 렌더링을 허용합니다. 반대로, false로 설정 시 미디어 스트림 트랙이 비활성화됩니다. 경우에 따라, 검은 화면으로 또는 멈춰진 화면으로 표시됩니다.

코드예제setEnabled() Syntax

await localVideo.setEnabled({enabled});

setEnabled() Parameters
파라미터 타입 필수 여부 설명
enabled Boolean 필수 미디어 트랙(비디오)의 상태 설정
true: 활성화
false: 비활성화
setEnabled() Returns
반환 구분 타입 설명
promise 성공 N/A 성공 시 아무것도 반환하지 않음
실패 Promise<ServerError> 호출 실패 시 반환
- 상세 에러 정보는 Error code 문서 참고

stop()

미디어 트랙을 중지합니다.

코드예제stop() Syntax

localVideo.stop();

attach()

새로운 비디오 엘리먼트를 생성해 이에 비디오를 바인딩하거나, 기존 비디오 엘리먼트에 비디오를 바인딩합니다.

코드예제attach() Syntax

const videoElement = localVideo.attach({element});

attach() Parameters
파라미터 타입 필수 여부 설명
element Undefined,
HTMLVideoElement
선택 엘리먼트 반환 타입
- 파라미터 미입력 시: 새로운 비디오 엘리먼트를 생성하여 반환
 ex. localVideo.attach()
- 파라미터 입력 시: HTMLVideoElement를 지정하여 해당 엘리먼트에 비디오를 바인딩
 ex. localVideo.attach(document.getElementById('video'))
attach() Returns
반환 타입 설명
HTMLVideoElement HTMLVideoElement 비디오가 바인딩된 비디오 엘리먼트 반환

detach()

attach()로 생성된 비디오 엘리먼트를 삭제합니다.

코드예제detach() Syntax

localVideo.detach();

setHd()

HD(High Definition, 고해상도) 모드를 설정합니다.

코드예제setHd() Syntax

localVideo.setHd({enabled});

setHd() Parameters
파라미터 타입 필수 여부 설명
enabled Boolean 필수 HD(High Definition, 고해상도) 모드를 설정
true: 고해상도 모드 활성화
false: 고해상도 모드 비활성화
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

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