RemoteVideo
RemoteVideo 클래스는 RemoteMedia의 비디오 속성에 해당되는 객체입니다. RemoteVideo클래스는 Property와 Method로 구성됩니다.
표RemoteVideo 클래스 전체 목록클래스 | 구분 | 항목 | 설명 |
---|---|---|---|
RemoteVideo | Property | participantId | Remote Participant(리모트 참여자)의 아이디 |
videoElements | attach() 메서드에 의해 바인딩된 비디오 엘리먼트 배열 반환 | ||
videoId | 고유 아이디 | ||
paused | 원격 비디오가 멈춰 있는지 표시 | ||
active | 활성화 상태 | ||
Method | getParticipantId() | 참여자 아이디(participantId) 반환 | |
getExtraValue() | Remote Participant(리모트 참여자)가 비디오에 기록한 Extra Value 반환 | ||
getVideoId() | 리모트 참여자의 비디오 아이디(videoId) 반환 | ||
attach() | 비디오 엘리먼트를 생성하여 비디오를 바인딩해 이를 반환하거나, 기존 비디오 엘리먼트에 비디오를 바인딩 | ||
detach() | attach() 메서드 호출로 생성한 비디오 엘리먼트 삭제 | ||
getMediaStreamTrack() | 미디어 스트림 트랙 반환 | ||
getMediaStream() | 미디어 스트림(비디오) 반환 | ||
setPaused() | 수신 중인 리모트 비디오 일시 정지 | ||
setQuality() | 수신 중인 리모트 비디오의 품질(Quality) 변경 |
Property
RemoteVideo 클래스의 프로퍼티는 다음과 같습니다.
표RemoteVideo 프로퍼티 목록Property | 타입 | 설명 |
---|---|---|
participantId | String | 리모트 참여자의 아이디 |
videoElements | HTMLVideoElement[] | attach() 메서드에 의해 바인딩된 비디오 엘리먼트 배열 반환 |
videoId | Number | 고유 아이디 |
paused | Boolean | 원격 비디오가 멈춰 있는지 표시 |
active | Boolean | 활성화 상태 |
Method
getParticipantId()
참여자 아이디(participantId)를 반환합니다. participantId는 getRemoteParticipant() 메서드의 인자로 사용될 수 있습니다.
코드예제getParticipantId() Syntax
const participantId = remoteVideo.getParticipantId();
Returns
표getParticipantId() Returns반환 | 타입 | 설명 |
---|---|---|
participantId | String | 리모트 참여자의 고유한 아이디 - getRemoteParticipant() 메서드의 인자로 사용 |
getExtraValue()
Remote Participant(리모트 참여자)가 비디오에 기록한 Extra Value를 반환합니다.
코드예제getExtraValue() Syntax
const extraValue = remoteVideo.getExtraValue();
Returns
표getExtraValue() Returns반환 | 타입 | 설명 |
---|---|---|
extra value | String | 리모트 참여자가 비디오에 기록한 extra value를 반환 |
getVideoId()
리모트 참여자의 비디오 아이디(videoId)를 반환합니다. videoId는 getRemotevideo() 메서드를 호출할 때 인자로 사용될 수 있습니다.
코드예제getVideoId() Syntax
const videoId = remoteVideo.getVideoId();
Returns
표getVideoId() Returns반환 | 타입 | 설명 |
---|---|---|
videoId | String | 리모트 참여자가 사용 중인 비디오 아이디 |
attach()
비디오 엘리먼트를 생성하여 비디오를 바인딩해 이를 반환하거나, 기존 비디오 엘리먼트에 비디오를 바인딩합니다. 파라미터 미 입력 시, 새로운 비디오 엘리먼트를 생성하여 반환합니다. 반면 파라미터를 입력하면 해당 엘리먼트에 비디오를 바인딩하고 해당 엘리먼트를 반환합니다.
코드예제attach() Syntax
const videoElement = remoteVideo.attach({element});
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
element | Undefined, HTMLVideoElement |
선택 |
엘리먼트 반환 타입 - 파라미터 미입력 시: 새로운 비디오 엘리먼트를 생성하여 반환 ex. remoteVideo.attach() - 파라미터 입력 시: HTMLVideoElement를 지정하여 해당 엘리먼트에 비디오를 바인딩 ex. remoteVideo.attach(document.getElementById('video')) |
Returns
표attach() Returns반환 | 타입 | 설명 |
---|---|---|
HTMLVideoElement | HTMLVideoElement | 비디오가 바인딩된 비디오 엘리먼트 |
detach()
attach()로 생성된 비디오 엘리먼트를 삭제합니다.
코드예제detach() Syntax
remoteVideo.detach();
getMediaStreamTrack()
미디어 스트림 트랙을 반환합니다. 미디어 스트림 트랙은 스트림 내의 단일 미디어 트랙으로, 비디오 트랙을 의미합니다.
코드예제getMediaStreamTrack() Syntax
const track = remoteVideo.getMediaStreamTrack();
Returns
표getMediaStreamTrack() Returns반환 | 타입 | 설명 |
---|---|---|
MediaStreamTrack | MediaStreamTrack | 미디어 스트림 트랙(비디오) |
getMediaStream()
미디어 스트림(비디오)을 반환합니다.
코드예제getMediaStream() Syntax
const stream = remoteVideo.getMediaStream();
Returns
표getMediaStream() Returns반환 | 타입 | 설명 |
---|---|---|
MediaStream | MediaStream | 미디어 스트림(비디오) |
setPaused()
수신 중인 리모트 비디오를 일시 정지합니다.
코드예제setPaused() Syntax
await remoteVideo.setPaused({enabled});
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
enabled | Boolean | 필수 |
수신 중인 리모트 비디오 일시 정지 |
true : 비디오 일시 정지 |
|||
false : 비디오 다시 재생 |
Returns
표setPaused() Returns반환 | 구분 | 타입 | 설명 |
---|---|---|---|
promise | 성공 | N/A | 성공 시 아무것도 반환하지 않음 |
실패 | Promise<ServerError> |
호출 실패 시 반환 - 상세 에러 정보는 Error code 문서 참고 |
setQuality()
수신 중인 리모트 비디오의 품질(Quality)을 변경합니다. 단, h
(높은 품질)로 설정 시, 디바이스 성능에 영향이 있을 수 있습니다.
코드예제setQuality() Syntax
await remoteVideo.setQuality({quality});
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
quality | String | 필수 |
수신 중인 리모트 비디오의 품질 |
l : 낮은 품질 |
|||
m : 중간 품질 |
|||
h : 높은 품질 |
Returns
표setQuality() Returns반환 | 구분 | 타입 | 설명 |
---|---|---|---|
promise | 성공 | N/A | 성공 시 아무것도 반환하지 않음 |
실패 | Promise<ServerError> |
호출 실패 시 반환 - 상세 에러 정보는 Error code 문서 참고 |