RTCIceCandidate.candidate

RTCIceCandidate 인터페이스에 대한 읽기 속성인 candidate는 candidate에 대해 자세히 설명해주는 DOMString를 반환합니다. 

RTCIceCandidate의 거의 모든 다른 속성들은 사실 이 문자열에서 가져와진 것입니다.

이 속성은 RTCIceCandidate() (en-US)를 사용해서 신규 candidate 객체를 구성 할 때, candidate (en-US) 속성의 값을 지정해서 설정 할 수 있습니다.

Syntax

var candidate = RTCIceCandidate.candidate;

반환되는 DOMString 값은 SDP (en-US)의 속성인 "candidate"에서 직접 가져와진 candidate의 속성에 대해 알려줍니다. candidate 문자열은 해당 candidate에 대한 네트워크 연결 정보를 명시합니다. candidate가 빈 문자열 ("")이라면, 더 이상 남아있는 candidate가 없다는 뜻입니다. 빈 문자열은 "candidate 종료" 표시자로도 알려져있습니다.

candidate 문자열에 대한 구문은 RFC 5245, section 15.1에 설명되어있습니다. 

a=candidate:4234997325 1 udp 2043278322 192.168.0.56 44323 typ host

위와 같은 a-line (속성 line)에서 해당하는 candidate 문자열의 값은 "candidate:4234997325 1 udp 2043278322 192.168.0.56 44323 typ host"가 됩니다.

user agent는 항상 가장 높거나 같은 priority (en-US)를 가진 candidate를 선호합니다. 위의 예시에서, 우선 순위는 2043278322 입니다. 속성은 단일 스페이스로 특정한 순서가 있습니다. 위의 candidate에 대한 전체 속성 리스트는 다음과 같습니다:

예시

아래 예제에서는 시그널링 과정에서 원격 유저에게서 수신 받은 ICE candidate 정보를 가진 SDP 문자열을 입력으로 받는 함수입니다. 

function handleNewIceCandidate(candidateSDP) {
  var candidateObj = new RTCIceCandidate(candidateSDP);

  myPeerConnection.addIceCandidate(candidateObj).catch({
    /* handle the error thrown by addIceCandidate() */
  });
}

handleNewIceCandidate() 함수는 수신 받은 candidate의 SDP 문자를 RTCIceCandidate() (en-US)에 보내고, candidate를 알려주는 RTCIceCanddiate 객체를 반환 받습니다.

그 후, 신규 candidatesms RTCPeerConnection.addIceCandidate()에 전달되서 candidate의 리스트에 추가해서 WebRTC가 연결 설정으로 사용 하도록 고려합니다. 

위 예제는 더 간단하게 표현 될 수 있습니다. ECMAScript 2016의 고급 기능들을 사용해서 아래와 같이 나타낼 수 있습니다:

let handleNewIceCandidate = candidateSDP =>
  myPeerConnection.addIceCandidate(new RTCIceCandidate(candidateSDP));

명세

명세 상태 코멘트
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCIceCandidate.candidate' in that specification.
Candidate Recommendation Initial definition.

브라우저 호환성

BCD tables only load in the browser