RTCPeerConnection.currentLocalDescription

 

Только для чтения свойство  RTCPeerConnection.currentLocalDescription возвращает объект  RTCSessionDescription , описывающий локальную сторону соединения, как  самый последний, удачно согласованный объект описания, с момента последнего завершения согласования  RTCPeerConnection и соединения с удаленным пиром (участником соединения) . 

Для изменения currentLocalDescription, вызовите метод RTCPeerConnection.setLocalDescription(), который запускает серию событий, приводящих к присвоению значения. Более подробно о том, что точно происходит и почему изменения происходят не сразу, смотрите   Ожидающие и текущие объекты описания в WebRTC connectivity.

В отличие от  RTCPeerConnection.localDescription, это значение представляет актуальный, текущий статус локальной стороны соединения; localDescription может устанавливать описание, на которое соединение находится в процессе перехода.

Синтаксис

sessionDescription = RTCPeerConnection.currentLocalDescription;

Возвращаемое значение

Текущий объект описания локальной стороны соединения. Если установка значения не удалась, значением станет null.

Пример

В этом примере рассматривается свойство currentLocalDescription  и отображается предупреждение, содержащее свойства объекта RTCSessionDescription  type и sdp .

var pc = new RTCPeerConnection();
…
var sd = pc.currentLocalDescription;
if (sd) {
  alert("Локальная сессия: type='" +
        sd.type + "'; sdp description='" +
        sd.sdp + "'");
}
else {
  alert("Локальной сессии еще нет.");
}

Спецификации

Спецификация Статус Комментарий
WebRTC 1.0: Real-time Communication Between Browsers
Определение 'RTCPeerConnection.currentLocalDescription' в этой спецификации.		 Кандидат в рекомендации Initial specification.

Совместимость с браузерами

BCD tables only load in the browser

The addition of currentLocalDescription and pendingLocalDescription to the WebRTC spec is relatively recent. In browsers which don't support them, just use localDescription.

See also