RTCIceCandidate

생성자

RTCIceCandidate()

단일 ICE candidate를 나타내기 위해 RTCIceCandidate 객체를 생성합니다. 옵션으로 RTCIceCandidateInit 딕셔너리에 존재하는 객체를 이용해 설정이 가능합니다.

참고 : 이전 버전의 호환성을 위해서는, 생성자가 candidate 속성의 값을 가진 문자열을 RTCIceCandidateInit 객체 대신에 입력 인자로 받습니다. 이는 candidate가 RTCIceCandidateInit보다 더 많은 정보를 가지고 있기 때문입니다.

속성

candidate 읽기 전용

연결성 확인을 위해 사용 될 수 있는 candidate에 대한 전달 주소를 나타내는 DOMString입니다. 이 주소의 형식은 RFC 5245에 정의된바와 같이 candidate-attribute 입니다. RTCIceCandidate가 "마지막 candidate"를 알려주면, 이 문자열은 빈 문자열 ("")이 됩니다.

component 읽기 전용

ICE candidate가 RTP (rtp) 인지 RTCP (rtcp)인지 알려주는 DOMString입니다. 이 값들은 candidate 라인 문자열에 있는 "component-id" 필드에서 가져와집니다. 허용되는 값은 RTCIceComponent enum 타입에 정리되어있습니다.

foundation 읽기 전용

같은 유형의 candidate와 동일한 식별자를 가진 DOMString를 반환합니다. DOMString는 동일한 베이스 (ICE 에이전트가 candidate를 보낸 주소)를 공유하고, 동일한 STUN서버에서 가져와집니다. 이 속성을 사용해서 RTCIceTransport객체에 나타나는 candidate의 우선 순위를 매기고 연관을 시키면서 ICE 성능을 최적화 할 수 있습니다.

ip 읽기 전용

candidate의 IP 주소를 가지고 있는 DOMString입니다.

port 읽기 전용

candidate의 포트 넘버를 알려주는 정수 값 입니다.

priority 읽기 전용

candidate의 우선순위를 알려주는 long 정수 값 입니다.

protocol 읽기 전용

candidate의 프로토콜이 "tcp"인지 "udp"인지 알려주는 문자열입니다. 이 문자열은 RTCIceProtocol enum 타입 중 하나 입니다.

relatedAddress 읽기 전용

candidate가 다른 candidate, 즉 호스트 candidate에서 가져와졌다면, relatedAddress는 호스트 candidate의 IP 주소를 포함하는 DOMString입니다. 호스트 candidate에서 이 값은 null 입니다.

relatedPort 읽기 전용

candidate가 relay 혹은 reflexive candidate로 부터 가져와진 경우, relatedPort는 해당하는 호스트 candidate의 포트 넘버를 가르킵니다. 마찬가지로, 호스트 candidate에서 이 값은 null 입니다.

sdpMid 읽기 전용

candidate의 미디어 스트림 식별 태그를 정의하는 DOMString입니다. 여기서 식별 태그는 candidate와 연관이 있는 컴포넌트안의 미디어 스트림을 유일하게 식별합니다. candidate와 관련이 있는 미디어 스트림이 존재하지 않으면, 이 값은 null 입니다.

sdpMLineIndex 읽기 전용

이 값이 null이 아니라면, sdpMLineIndex는 candidate와 연관 된 SDP의 미디어 설명에 대한, 0을 기준으로 하는 색인 번호를 알려줍니다 (RFC 4566에 정의되어 있습니다.).

tcpType 읽기 전용

protocol이 "tcp"라면,tcpType은 TCP candidate의 타입을 알려줍니다. 이외에는 tcpType은 null 입니다.

type 읽기 전용

RTCIceCandidateType enum 타입에 존재하는 문자열에 속하는 candidate의 타입을 알려주는 DOMString입니다.

usernameFragment 읽기 전용

ICE가 무작위로 생성된 비밀번호 ("ice-pwd") 와 함께 메세지의 무결성을 확인하기 위해 사용하는 무작위로 생성된 유저 이름 조각 ("ice-ufrag")을 가지고 있는 DOMString입니다. 이 문자열을 사용해서 ICE 생성의 버전을 확인 할 수 있습니다. ICE가 재시작하더라도, 같은 버전의 ICE 프로세스는 동일한 usernameFragment를 가지게 됩니다.

메소드

toJSON()

toJSON()은 RTCIceCandidate의 현재 저장된 설정을 담은 JSON 표현식을 RTCIceCandidateInit 객체의 형태로 변환시킨 DOMString를 반환합니다.

예시

예시를 보려면, 전체 과정을 설명해주는 Signaling and video calling문서를 확인하십시오.

명세

브라우저 호환성