blob: a252f198f3adf3e143c4bb7855b67848b4d2174d [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001/*
kjellanderb24317b2016-02-10 07:54:43 -08002 * Copyright 2013 The WebRTC project authors. All Rights Reserved.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00003 *
kjellanderb24317b2016-02-10 07:54:43 -08004 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00009 */
10
henrike@webrtc.org28e20752013-07-10 00:45:36 +000011package org.webrtc;
12
Magnus Jedvert6062f372017-11-16 16:53:12 +010013import java.util.ArrayList;
Sami Kalliomäki3e189a62017-11-24 11:13:39 +010014import java.util.Collections;
henrike@webrtc.org28e20752013-07-10 00:45:36 +000015import java.util.List;
Sami Kalliomäkie7592d82018-03-22 13:32:44 +010016import javax.annotation.Nullable;
henrike@webrtc.org28e20752013-07-10 00:45:36 +000017
18/**
19 * Java-land version of the PeerConnection APIs; wraps the C++ API
20 * http://www.webrtc.org/reference/native-apis, which in turn is inspired by the
21 * JS APIs: http://dev.w3.org/2011/webrtc/editor/webrtc.html and
22 * http://www.w3.org/TR/mediacapture-streams/
23 */
24public class PeerConnection {
henrike@webrtc.org28e20752013-07-10 00:45:36 +000025 /** Tracks PeerConnectionInterface::IceGatheringState */
Magnus Jedvertba700f62017-12-04 13:43:27 +010026 public enum IceGatheringState {
27 NEW,
28 GATHERING,
29 COMPLETE;
30
31 @CalledByNative("IceGatheringState")
32 static IceGatheringState fromNativeIndex(int nativeIndex) {
33 return values()[nativeIndex];
34 }
35 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +000036
37 /** Tracks PeerConnectionInterface::IceConnectionState */
38 public enum IceConnectionState {
sakalb6760f92016-09-29 04:12:44 -070039 NEW,
40 CHECKING,
41 CONNECTED,
42 COMPLETED,
43 FAILED,
44 DISCONNECTED,
Magnus Jedvertba700f62017-12-04 13:43:27 +010045 CLOSED;
46
47 @CalledByNative("IceConnectionState")
48 static IceConnectionState fromNativeIndex(int nativeIndex) {
49 return values()[nativeIndex];
50 }
sakalb6760f92016-09-29 04:12:44 -070051 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +000052
hnsl04833622017-01-09 08:35:45 -080053 /** Tracks PeerConnectionInterface::TlsCertPolicy */
54 public enum TlsCertPolicy {
55 TLS_CERT_POLICY_SECURE,
56 TLS_CERT_POLICY_INSECURE_NO_CHECK,
57 }
58
henrike@webrtc.org28e20752013-07-10 00:45:36 +000059 /** Tracks PeerConnectionInterface::SignalingState */
60 public enum SignalingState {
sakalb6760f92016-09-29 04:12:44 -070061 STABLE,
62 HAVE_LOCAL_OFFER,
63 HAVE_LOCAL_PRANSWER,
64 HAVE_REMOTE_OFFER,
65 HAVE_REMOTE_PRANSWER,
Magnus Jedvertba700f62017-12-04 13:43:27 +010066 CLOSED;
67
68 @CalledByNative("SignalingState")
69 static SignalingState fromNativeIndex(int nativeIndex) {
70 return values()[nativeIndex];
71 }
sakalb6760f92016-09-29 04:12:44 -070072 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +000073
74 /** Java version of PeerConnectionObserver. */
75 public static interface Observer {
76 /** Triggered when the SignalingState changes. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010077 @CalledByNative("Observer") void onSignalingChange(SignalingState newState);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000078
79 /** Triggered when the IceConnectionState changes. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010080 @CalledByNative("Observer") void onIceConnectionChange(IceConnectionState newState);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000081
Peter Thatcher54360512015-07-08 11:08:35 -070082 /** Triggered when the ICE connection receiving status changes. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010083 @CalledByNative("Observer") void onIceConnectionReceivingChange(boolean receiving);
Peter Thatcher54360512015-07-08 11:08:35 -070084
henrike@webrtc.org28e20752013-07-10 00:45:36 +000085 /** Triggered when the IceGatheringState changes. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010086 @CalledByNative("Observer") void onIceGatheringChange(IceGatheringState newState);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000087
88 /** Triggered when a new ICE candidate has been found. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010089 @CalledByNative("Observer") void onIceCandidate(IceCandidate candidate);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000090
Honghai Zhang7fb69db2016-03-14 11:59:18 -070091 /** Triggered when some ICE candidates have been removed. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010092 @CalledByNative("Observer") void onIceCandidatesRemoved(IceCandidate[] candidates);
Honghai Zhang7fb69db2016-03-14 11:59:18 -070093
henrike@webrtc.org28e20752013-07-10 00:45:36 +000094 /** Triggered when media is received on a new stream from remote peer. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010095 @CalledByNative("Observer") void onAddStream(MediaStream stream);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000096
97 /** Triggered when a remote peer close a stream. */
Magnus Jedvertba700f62017-12-04 13:43:27 +010098 @CalledByNative("Observer") void onRemoveStream(MediaStream stream);
henrike@webrtc.org723d6832013-07-12 16:04:50 +000099
100 /** Triggered when a remote peer opens a DataChannel. */
Magnus Jedvertba700f62017-12-04 13:43:27 +0100101 @CalledByNative("Observer") void onDataChannel(DataChannel dataChannel);
fischman@webrtc.orgd7568a02014-01-13 22:04:12 +0000102
103 /** Triggered when renegotiation is necessary. */
Magnus Jedvertba700f62017-12-04 13:43:27 +0100104 @CalledByNative("Observer") void onRenegotiationNeeded();
zhihuangdcccda72016-12-21 14:08:03 -0800105
106 /**
107 * Triggered when a new track is signaled by the remote peer, as a result of
108 * setRemoteDescription.
109 */
Magnus Jedvertba700f62017-12-04 13:43:27 +0100110 @CalledByNative("Observer") void onAddTrack(RtpReceiver receiver, MediaStream[] mediaStreams);
Seth Hampson31dbc242018-05-07 09:28:19 -0700111
112 /**
113 * Triggered when the signaling from SetRemoteDescription indicates that a transceiver
114 * will be receiving media from a remote endpoint. This is only called if UNIFIED_PLAN
115 * semantics are specified. The transceiver will be disposed automatically.
116 */
117 @CalledByNative("Observer") default void onTrack(RtpTransceiver transceiver){};
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000118 }
119
120 /** Java version of PeerConnectionInterface.IceServer. */
121 public static class IceServer {
Emad Omaradab1d2d2017-06-16 15:43:11 -0700122 // List of URIs associated with this server. Valid formats are described
123 // in RFC7064 and RFC7065, and more may be added in the future. The "host"
124 // part of the URI may contain either an IP address or a hostname.
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700125 @Deprecated public final String uri;
126 public final List<String> urls;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000127 public final String username;
128 public final String password;
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000129 public final TlsCertPolicy tlsCertPolicy;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000130
Emad Omaradab1d2d2017-06-16 15:43:11 -0700131 // If the URIs in |urls| only contain IP addresses, this field can be used
132 // to indicate the hostname, which may be necessary for TLS (using the SNI
133 // extension). If |urls| itself contains the hostname, this isn't
134 // necessary.
135 public final String hostname;
136
Diogo Real1dca9d52017-08-29 12:18:32 -0700137 // List of protocols to be used in the TLS ALPN extension.
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000138 public final List<String> tlsAlpnProtocols;
Diogo Real1dca9d52017-08-29 12:18:32 -0700139
Diogo Real7bd1f1b2017-09-08 12:50:41 -0700140 // List of elliptic curves to be used in the TLS elliptic curves extension.
141 // Only curve names supported by OpenSSL should be used (eg. "P-256","X25519").
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000142 public final List<String> tlsEllipticCurves;
Diogo Real7bd1f1b2017-09-08 12:50:41 -0700143
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000144 /** Convenience constructor for STUN servers. */
Diogo Real05ea2b32017-08-31 00:12:58 -0700145 @Deprecated
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000146 public IceServer(String uri) {
147 this(uri, "", "");
148 }
149
Diogo Real05ea2b32017-08-31 00:12:58 -0700150 @Deprecated
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000151 public IceServer(String uri, String username, String password) {
hnsl04833622017-01-09 08:35:45 -0800152 this(uri, username, password, TlsCertPolicy.TLS_CERT_POLICY_SECURE);
153 }
154
Diogo Real05ea2b32017-08-31 00:12:58 -0700155 @Deprecated
hnsl04833622017-01-09 08:35:45 -0800156 public IceServer(String uri, String username, String password, TlsCertPolicy tlsCertPolicy) {
Emad Omaradab1d2d2017-06-16 15:43:11 -0700157 this(uri, username, password, tlsCertPolicy, "");
158 }
159
Diogo Real05ea2b32017-08-31 00:12:58 -0700160 @Deprecated
Emad Omaradab1d2d2017-06-16 15:43:11 -0700161 public IceServer(String uri, String username, String password, TlsCertPolicy tlsCertPolicy,
162 String hostname) {
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700163 this(uri, Collections.singletonList(uri), username, password, tlsCertPolicy, hostname, null,
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000164 null);
Diogo Real1dca9d52017-08-29 12:18:32 -0700165 }
166
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700167 private IceServer(String uri, List<String> urls, String username, String password,
168 TlsCertPolicy tlsCertPolicy, String hostname, List<String> tlsAlpnProtocols,
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000169 List<String> tlsEllipticCurves) {
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700170 if (uri == null || urls == null || urls.isEmpty()) {
171 throw new IllegalArgumentException("uri == null || urls == null || urls.isEmpty()");
172 }
173 for (String it : urls) {
174 if (it == null) {
175 throw new IllegalArgumentException("urls element is null: " + urls);
176 }
177 }
178 if (username == null) {
179 throw new IllegalArgumentException("username == null");
180 }
181 if (password == null) {
182 throw new IllegalArgumentException("password == null");
183 }
184 if (hostname == null) {
185 throw new IllegalArgumentException("hostname == null");
186 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000187 this.uri = uri;
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700188 this.urls = urls;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000189 this.username = username;
190 this.password = password;
hnsl04833622017-01-09 08:35:45 -0800191 this.tlsCertPolicy = tlsCertPolicy;
Emad Omaradab1d2d2017-06-16 15:43:11 -0700192 this.hostname = hostname;
Diogo Real1dca9d52017-08-29 12:18:32 -0700193 this.tlsAlpnProtocols = tlsAlpnProtocols;
Diogo Real7bd1f1b2017-09-08 12:50:41 -0700194 this.tlsEllipticCurves = tlsEllipticCurves;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000195 }
196
Sami Kalliomäkibde473e2017-10-30 13:34:41 +0100197 @Override
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000198 public String toString() {
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700199 return urls + " [" + username + ":" + password + "] [" + tlsCertPolicy + "] [" + hostname
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000200 + "] [" + tlsAlpnProtocols + "] [" + tlsEllipticCurves + "]";
Diogo Real1dca9d52017-08-29 12:18:32 -0700201 }
202
203 public static Builder builder(String uri) {
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700204 return new Builder(Collections.singletonList(uri));
205 }
206
207 public static Builder builder(List<String> urls) {
208 return new Builder(urls);
Diogo Real1dca9d52017-08-29 12:18:32 -0700209 }
210
211 public static class Builder {
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100212 @Nullable private final List<String> urls;
Diogo Real1dca9d52017-08-29 12:18:32 -0700213 private String username = "";
214 private String password = "";
215 private TlsCertPolicy tlsCertPolicy = TlsCertPolicy.TLS_CERT_POLICY_SECURE;
216 private String hostname = "";
217 private List<String> tlsAlpnProtocols;
Diogo Real7bd1f1b2017-09-08 12:50:41 -0700218 private List<String> tlsEllipticCurves;
Diogo Real1dca9d52017-08-29 12:18:32 -0700219
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700220 private Builder(List<String> urls) {
221 if (urls == null || urls.isEmpty()) {
222 throw new IllegalArgumentException("urls == null || urls.isEmpty(): " + urls);
223 }
224 this.urls = urls;
Diogo Real1dca9d52017-08-29 12:18:32 -0700225 }
226
227 public Builder setUsername(String username) {
228 this.username = username;
229 return this;
230 }
231
232 public Builder setPassword(String password) {
233 this.password = password;
234 return this;
235 }
236
237 public Builder setTlsCertPolicy(TlsCertPolicy tlsCertPolicy) {
238 this.tlsCertPolicy = tlsCertPolicy;
239 return this;
240 }
241
242 public Builder setHostname(String hostname) {
243 this.hostname = hostname;
244 return this;
245 }
246
247 public Builder setTlsAlpnProtocols(List<String> tlsAlpnProtocols) {
248 this.tlsAlpnProtocols = tlsAlpnProtocols;
249 return this;
250 }
251
Diogo Real7bd1f1b2017-09-08 12:50:41 -0700252 public Builder setTlsEllipticCurves(List<String> tlsEllipticCurves) {
253 this.tlsEllipticCurves = tlsEllipticCurves;
254 return this;
255 }
256
Diogo Real1dca9d52017-08-29 12:18:32 -0700257 public IceServer createIceServer() {
korniltsev.anatoly0ea03102017-09-11 06:41:38 -0700258 return new IceServer(urls.get(0), urls, username, password, tlsCertPolicy, hostname,
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000259 tlsAlpnProtocols, tlsEllipticCurves);
Diogo Real1dca9d52017-08-29 12:18:32 -0700260 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000261 }
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100262
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100263 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100264 @CalledByNative("IceServer")
265 List<String> getUrls() {
266 return urls;
267 }
268
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100269 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100270 @CalledByNative("IceServer")
271 String getUsername() {
272 return username;
273 }
274
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100275 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100276 @CalledByNative("IceServer")
277 String getPassword() {
278 return password;
279 }
280
281 @CalledByNative("IceServer")
282 TlsCertPolicy getTlsCertPolicy() {
283 return tlsCertPolicy;
284 }
285
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100286 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100287 @CalledByNative("IceServer")
288 String getHostname() {
289 return hostname;
290 }
291
292 @CalledByNative("IceServer")
293 List<String> getTlsAlpnProtocols() {
294 return tlsAlpnProtocols;
295 }
296
297 @CalledByNative("IceServer")
298 List<String> getTlsEllipticCurves() {
299 return tlsEllipticCurves;
300 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000301 }
302
Jiayang Liucac1b382015-04-30 12:35:24 -0700303 /** Java version of PeerConnectionInterface.IceTransportsType */
sakalb6760f92016-09-29 04:12:44 -0700304 public enum IceTransportsType { NONE, RELAY, NOHOST, ALL }
Jiayang Liucac1b382015-04-30 12:35:24 -0700305
306 /** Java version of PeerConnectionInterface.BundlePolicy */
sakalb6760f92016-09-29 04:12:44 -0700307 public enum BundlePolicy { BALANCED, MAXBUNDLE, MAXCOMPAT }
Jiayang Liucac1b382015-04-30 12:35:24 -0700308
Peter Thatcheraf55ccc2015-05-21 07:48:41 -0700309 /** Java version of PeerConnectionInterface.RtcpMuxPolicy */
sakalb6760f92016-09-29 04:12:44 -0700310 public enum RtcpMuxPolicy { NEGOTIATE, REQUIRE }
glaznev97579a42015-09-01 11:31:27 -0700311
Peter Thatcheraf55ccc2015-05-21 07:48:41 -0700312 /** Java version of PeerConnectionInterface.TcpCandidatePolicy */
sakalb6760f92016-09-29 04:12:44 -0700313 public enum TcpCandidatePolicy { ENABLED, DISABLED }
Jiayang Liucac1b382015-04-30 12:35:24 -0700314
honghaiz60347052016-05-31 18:29:12 -0700315 /** Java version of PeerConnectionInterface.CandidateNetworkPolicy */
sakalb6760f92016-09-29 04:12:44 -0700316 public enum CandidateNetworkPolicy { ALL, LOW_COST }
honghaiz60347052016-05-31 18:29:12 -0700317
Qingsi Wang9a5c6f82018-02-01 10:38:40 -0800318 // Keep in sync with webrtc/rtc_base/network_constants.h.
319 public enum AdapterType {
320 UNKNOWN,
321 ETHERNET,
322 WIFI,
323 CELLULAR,
324 VPN,
325 LOOPBACK,
326 }
327
glaznev97579a42015-09-01 11:31:27 -0700328 /** Java version of rtc::KeyType */
sakalb6760f92016-09-29 04:12:44 -0700329 public enum KeyType { RSA, ECDSA }
glaznev97579a42015-09-01 11:31:27 -0700330
honghaiz1f429e32015-09-28 07:57:34 -0700331 /** Java version of PeerConnectionInterface.ContinualGatheringPolicy */
sakalb6760f92016-09-29 04:12:44 -0700332 public enum ContinualGatheringPolicy { GATHER_ONCE, GATHER_CONTINUALLY }
honghaiz1f429e32015-09-28 07:57:34 -0700333
Steve Antond960a0c2017-07-17 12:33:07 -0700334 /** Java version of rtc::IntervalRange */
335 public static class IntervalRange {
336 private final int min;
337 private final int max;
338
339 public IntervalRange(int min, int max) {
340 this.min = min;
341 this.max = max;
342 }
343
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100344 @CalledByNative("IntervalRange")
Steve Antond960a0c2017-07-17 12:33:07 -0700345 public int getMin() {
346 return min;
347 }
348
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100349 @CalledByNative("IntervalRange")
Steve Antond960a0c2017-07-17 12:33:07 -0700350 public int getMax() {
351 return max;
352 }
353 }
354
Seth Hampsonc384e142018-03-06 15:47:10 -0800355 /**
356 * Java version of webrtc::SdpSemantics.
357 *
358 * Configure the SDP semantics used by this PeerConnection. Note that the
359 * WebRTC 1.0 specification requires UNIFIED_PLAN semantics. The
360 * RtpTransceiver API is only available with UNIFIED_PLAN semantics.
361 *
362 * <p>PLAN_B will cause PeerConnection to create offers and answers with at
363 * most one audio and one video m= section with multiple RtpSenders and
364 * RtpReceivers specified as multiple a=ssrc lines within the section. This
365 * will also cause PeerConnection to ignore all but the first m= section of
366 * the same media type.
367 *
368 * <p>UNIFIED_PLAN will cause PeerConnection to create offers and answers with
369 * multiple m= sections where each m= section maps to one RtpSender and one
370 * RtpReceiver (an RtpTransceiver), either both audio or both video. This
371 * will also cause PeerConnection to ignore all but the first a=ssrc lines
372 * that form a Plan B stream.
373 *
374 * <p>For users who wish to send multiple audio/video streams and need to stay
375 * interoperable with legacy WebRTC implementations, specify PLAN_B.
376 *
377 * <p>For users who wish to send multiple audio/video streams and/or wish to
378 * use the new RtpTransceiver API, specify UNIFIED_PLAN.
379 */
380 public enum SdpSemantics { PLAN_B, UNIFIED_PLAN }
381
Jiayang Liucac1b382015-04-30 12:35:24 -0700382 /** Java version of PeerConnectionInterface.RTCConfiguration */
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800383 // TODO(qingsi): Resolve the naming inconsistency of fields with/without units.
Jiayang Liucac1b382015-04-30 12:35:24 -0700384 public static class RTCConfiguration {
385 public IceTransportsType iceTransportsType;
386 public List<IceServer> iceServers;
387 public BundlePolicy bundlePolicy;
Michael Iedema02137862018-10-09 15:30:01 +0200388 @Nullable public RtcCertificatePem certificate;
Peter Thatcheraf55ccc2015-05-21 07:48:41 -0700389 public RtcpMuxPolicy rtcpMuxPolicy;
Jiayang Liucac1b382015-04-30 12:35:24 -0700390 public TcpCandidatePolicy tcpCandidatePolicy;
honghaiz60347052016-05-31 18:29:12 -0700391 public CandidateNetworkPolicy candidateNetworkPolicy;
Henrik Lundin64dad832015-05-11 12:44:23 +0200392 public int audioJitterBufferMaxPackets;
Henrik Lundin5263b3c2015-06-01 10:29:41 +0200393 public boolean audioJitterBufferFastAccelerate;
honghaiz4edc39c2015-09-01 09:53:56 -0700394 public int iceConnectionReceivingTimeout;
Honghai Zhang381b4212015-12-04 12:24:03 -0800395 public int iceBackupCandidatePairPingInterval;
glaznev97579a42015-09-01 11:31:27 -0700396 public KeyType keyType;
honghaiz1f429e32015-09-28 07:57:34 -0700397 public ContinualGatheringPolicy continualGatheringPolicy;
deadbeefbe0c96f2016-05-18 16:20:14 -0700398 public int iceCandidatePoolSize;
Honghai Zhangd78ecf72016-07-01 14:40:40 -0700399 public boolean pruneTurnPorts;
Taylor Brandstettere9851112016-07-01 11:11:13 -0700400 public boolean presumeWritableWhenFullyRelayed;
Qingsi Wange6826d22018-03-08 14:55:14 -0800401 // The following fields define intervals in milliseconds at which ICE
402 // connectivity checks are sent.
403 //
404 // We consider ICE is "strongly connected" for an agent when there is at
405 // least one candidate pair that currently succeeds in connectivity check
406 // from its direction i.e. sending a ping and receives a ping response, AND
407 // all candidate pairs have sent a minimum number of pings for connectivity
408 // (this number is implementation-specific). Otherwise, ICE is considered in
409 // "weak connectivity".
410 //
411 // Note that the above notion of strong and weak connectivity is not defined
412 // in RFC 5245, and they apply to our current ICE implementation only.
413 //
414 // 1) iceCheckIntervalStrongConnectivityMs defines the interval applied to
415 // ALL candidate pairs when ICE is strongly connected,
416 // 2) iceCheckIntervalWeakConnectivityMs defines the counterpart for ALL
417 // pairs when ICE is weakly connected, and
418 // 3) iceCheckMinInterval defines the minimal interval (equivalently the
419 // maximum rate) that overrides the above two intervals when either of them
420 // is less.
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100421 @Nullable public Integer iceCheckIntervalStrongConnectivityMs;
422 @Nullable public Integer iceCheckIntervalWeakConnectivityMs;
423 @Nullable public Integer iceCheckMinInterval;
Qingsi Wang22e623a2018-03-13 10:53:57 -0700424 // The time period in milliseconds for which a candidate pair must wait for response to
425 // connectivitiy checks before it becomes unwritable.
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100426 @Nullable public Integer iceUnwritableTimeMs;
Qingsi Wang22e623a2018-03-13 10:53:57 -0700427 // The minimum number of connectivity checks that a candidate pair must sent without receiving
428 // response before it becomes unwritable.
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100429 @Nullable public Integer iceUnwritableMinChecks;
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800430 // The interval in milliseconds at which STUN candidates will resend STUN binding requests
431 // to keep NAT bindings open.
432 // The default value in the implementation is used if this field is null.
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100433 @Nullable public Integer stunCandidateKeepaliveIntervalMs;
zhihuangb09b3f92017-03-07 14:40:51 -0800434 public boolean disableIPv6OnWifi;
deadbeef28e29192017-07-27 09:14:38 -0700435 // By default, PeerConnection will use a limited number of IPv6 network
436 // interfaces, in order to avoid too many ICE candidate pairs being created
437 // and delaying ICE completion.
438 //
439 // Can be set to Integer.MAX_VALUE to effectively disable the limit.
440 public int maxIPv6Networks;
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100441 @Nullable public IntervalRange iceRegatherIntervalRange;
Jiayang Liucac1b382015-04-30 12:35:24 -0700442
Sami Kalliomäkie8b26cd2017-12-19 12:51:53 +0100443 // These values will be overridden by MediaStream constraints if deprecated constraints-based
444 // create peerconnection interface is used.
445 public boolean disableIpv6;
446 public boolean enableDscp;
447 public boolean enableCpuOveruseDetection;
448 public boolean enableRtpDataChannel;
449 public boolean suspendBelowMinBitrate;
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100450 @Nullable public Integer screencastMinBitrate;
451 @Nullable public Boolean combinedAudioVideoBwe;
452 @Nullable public Boolean enableDtlsSrtp;
Qingsi Wang9a5c6f82018-02-01 10:38:40 -0800453 // Use "Unknown" to represent no preference of adapter types, not the
454 // preference of adapters of unknown types.
455 public AdapterType networkPreference;
Seth Hampsonc384e142018-03-06 15:47:10 -0800456 public SdpSemantics sdpSemantics;
Sami Kalliomäkie8b26cd2017-12-19 12:51:53 +0100457
Jonas Orelandbdcee282017-10-10 14:01:40 +0200458 // This is an optional wrapper for the C++ webrtc::TurnCustomizer.
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100459 @Nullable public TurnCustomizer turnCustomizer;
Jonas Orelandbdcee282017-10-10 14:01:40 +0200460
Zhi Huangb57e1692018-06-12 11:41:11 -0700461 // Actively reset the SRTP parameters whenever the DTLS transports underneath are reset for
462 // every offer/answer negotiation.This is only intended to be a workaround for crbug.com/835958
463 public boolean activeResetSrtpParams;
464
deadbeef28e29192017-07-27 09:14:38 -0700465 // TODO(deadbeef): Instead of duplicating the defaults here, we should do
466 // something to pick up the defaults from C++. The Objective-C equivalent
467 // of RTCConfiguration does that.
Jiayang Liucac1b382015-04-30 12:35:24 -0700468 public RTCConfiguration(List<IceServer> iceServers) {
469 iceTransportsType = IceTransportsType.ALL;
470 bundlePolicy = BundlePolicy.BALANCED;
zhihuang4dfb8ce2016-11-23 10:30:12 -0800471 rtcpMuxPolicy = RtcpMuxPolicy.REQUIRE;
Jiayang Liucac1b382015-04-30 12:35:24 -0700472 tcpCandidatePolicy = TcpCandidatePolicy.ENABLED;
Sami Kalliomäki9828beb2017-10-26 16:21:22 +0200473 candidateNetworkPolicy = CandidateNetworkPolicy.ALL;
Jiayang Liucac1b382015-04-30 12:35:24 -0700474 this.iceServers = iceServers;
Henrik Lundin64dad832015-05-11 12:44:23 +0200475 audioJitterBufferMaxPackets = 50;
Henrik Lundin5263b3c2015-06-01 10:29:41 +0200476 audioJitterBufferFastAccelerate = false;
honghaiz4edc39c2015-09-01 09:53:56 -0700477 iceConnectionReceivingTimeout = -1;
Honghai Zhang381b4212015-12-04 12:24:03 -0800478 iceBackupCandidatePairPingInterval = -1;
glaznev97579a42015-09-01 11:31:27 -0700479 keyType = KeyType.ECDSA;
honghaiz1f429e32015-09-28 07:57:34 -0700480 continualGatheringPolicy = ContinualGatheringPolicy.GATHER_ONCE;
deadbeefbe0c96f2016-05-18 16:20:14 -0700481 iceCandidatePoolSize = 0;
Honghai Zhangd78ecf72016-07-01 14:40:40 -0700482 pruneTurnPorts = false;
Taylor Brandstettere9851112016-07-01 11:11:13 -0700483 presumeWritableWhenFullyRelayed = false;
Qingsi Wange6826d22018-03-08 14:55:14 -0800484 iceCheckIntervalStrongConnectivityMs = null;
485 iceCheckIntervalWeakConnectivityMs = null;
skvlad51072462017-02-02 11:50:14 -0800486 iceCheckMinInterval = null;
Qingsi Wang22e623a2018-03-13 10:53:57 -0700487 iceUnwritableTimeMs = null;
488 iceUnwritableMinChecks = null;
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800489 stunCandidateKeepaliveIntervalMs = null;
zhihuangb09b3f92017-03-07 14:40:51 -0800490 disableIPv6OnWifi = false;
deadbeef28e29192017-07-27 09:14:38 -0700491 maxIPv6Networks = 5;
Steve Antond960a0c2017-07-17 12:33:07 -0700492 iceRegatherIntervalRange = null;
Sami Kalliomäkie8b26cd2017-12-19 12:51:53 +0100493 disableIpv6 = false;
494 enableDscp = false;
495 enableCpuOveruseDetection = true;
496 enableRtpDataChannel = false;
497 suspendBelowMinBitrate = false;
498 screencastMinBitrate = null;
499 combinedAudioVideoBwe = null;
500 enableDtlsSrtp = null;
Qingsi Wang9a5c6f82018-02-01 10:38:40 -0800501 networkPreference = AdapterType.UNKNOWN;
Seth Hampsonc384e142018-03-06 15:47:10 -0800502 sdpSemantics = SdpSemantics.PLAN_B;
Zhi Huangb57e1692018-06-12 11:41:11 -0700503 activeResetSrtpParams = false;
Jiayang Liucac1b382015-04-30 12:35:24 -0700504 }
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100505
506 @CalledByNative("RTCConfiguration")
507 IceTransportsType getIceTransportsType() {
508 return iceTransportsType;
509 }
510
511 @CalledByNative("RTCConfiguration")
512 List<IceServer> getIceServers() {
513 return iceServers;
514 }
515
516 @CalledByNative("RTCConfiguration")
517 BundlePolicy getBundlePolicy() {
518 return bundlePolicy;
519 }
520
Michael Iedema02137862018-10-09 15:30:01 +0200521 @Nullable
522 @CalledByNative("RTCConfiguration")
523 RtcCertificatePem getCertificate() {
524 return certificate;
525 }
526
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100527 @CalledByNative("RTCConfiguration")
528 RtcpMuxPolicy getRtcpMuxPolicy() {
529 return rtcpMuxPolicy;
530 }
531
532 @CalledByNative("RTCConfiguration")
533 TcpCandidatePolicy getTcpCandidatePolicy() {
534 return tcpCandidatePolicy;
535 }
536
537 @CalledByNative("RTCConfiguration")
538 CandidateNetworkPolicy getCandidateNetworkPolicy() {
539 return candidateNetworkPolicy;
540 }
541
542 @CalledByNative("RTCConfiguration")
543 int getAudioJitterBufferMaxPackets() {
544 return audioJitterBufferMaxPackets;
545 }
546
547 @CalledByNative("RTCConfiguration")
548 boolean getAudioJitterBufferFastAccelerate() {
549 return audioJitterBufferFastAccelerate;
550 }
551
552 @CalledByNative("RTCConfiguration")
553 int getIceConnectionReceivingTimeout() {
554 return iceConnectionReceivingTimeout;
555 }
556
557 @CalledByNative("RTCConfiguration")
558 int getIceBackupCandidatePairPingInterval() {
559 return iceBackupCandidatePairPingInterval;
560 }
561
562 @CalledByNative("RTCConfiguration")
563 KeyType getKeyType() {
564 return keyType;
565 }
566
567 @CalledByNative("RTCConfiguration")
568 ContinualGatheringPolicy getContinualGatheringPolicy() {
569 return continualGatheringPolicy;
570 }
571
572 @CalledByNative("RTCConfiguration")
573 int getIceCandidatePoolSize() {
574 return iceCandidatePoolSize;
575 }
576
577 @CalledByNative("RTCConfiguration")
578 boolean getPruneTurnPorts() {
579 return pruneTurnPorts;
580 }
581
582 @CalledByNative("RTCConfiguration")
583 boolean getPresumeWritableWhenFullyRelayed() {
584 return presumeWritableWhenFullyRelayed;
585 }
586
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100587 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100588 @CalledByNative("RTCConfiguration")
Qingsi Wange6826d22018-03-08 14:55:14 -0800589 Integer getIceCheckIntervalStrongConnectivity() {
590 return iceCheckIntervalStrongConnectivityMs;
591 }
592
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100593 @Nullable
Qingsi Wange6826d22018-03-08 14:55:14 -0800594 @CalledByNative("RTCConfiguration")
595 Integer getIceCheckIntervalWeakConnectivity() {
596 return iceCheckIntervalWeakConnectivityMs;
597 }
598
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100599 @Nullable
Qingsi Wange6826d22018-03-08 14:55:14 -0800600 @CalledByNative("RTCConfiguration")
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100601 Integer getIceCheckMinInterval() {
602 return iceCheckMinInterval;
603 }
604
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100605 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100606 @CalledByNative("RTCConfiguration")
Qingsi Wang22e623a2018-03-13 10:53:57 -0700607 Integer getIceUnwritableTimeout() {
608 return iceUnwritableTimeMs;
609 }
610
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100611 @Nullable
Qingsi Wang22e623a2018-03-13 10:53:57 -0700612 @CalledByNative("RTCConfiguration")
613 Integer getIceUnwritableMinChecks() {
614 return iceUnwritableMinChecks;
615 }
616
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100617 @Nullable
Qingsi Wang22e623a2018-03-13 10:53:57 -0700618 @CalledByNative("RTCConfiguration")
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800619 Integer getStunCandidateKeepaliveInterval() {
620 return stunCandidateKeepaliveIntervalMs;
621 }
622
623 @CalledByNative("RTCConfiguration")
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100624 boolean getDisableIPv6OnWifi() {
625 return disableIPv6OnWifi;
626 }
627
628 @CalledByNative("RTCConfiguration")
629 int getMaxIPv6Networks() {
630 return maxIPv6Networks;
631 }
632
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100633 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100634 @CalledByNative("RTCConfiguration")
635 IntervalRange getIceRegatherIntervalRange() {
636 return iceRegatherIntervalRange;
637 }
638
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100639 @Nullable
Magnus Jedvert9060eb12017-12-12 12:52:54 +0100640 @CalledByNative("RTCConfiguration")
641 TurnCustomizer getTurnCustomizer() {
642 return turnCustomizer;
643 }
Sami Kalliomäkie8b26cd2017-12-19 12:51:53 +0100644
645 @CalledByNative("RTCConfiguration")
646 boolean getDisableIpv6() {
647 return disableIpv6;
648 }
649
650 @CalledByNative("RTCConfiguration")
651 boolean getEnableDscp() {
652 return enableDscp;
653 }
654
655 @CalledByNative("RTCConfiguration")
656 boolean getEnableCpuOveruseDetection() {
657 return enableCpuOveruseDetection;
658 }
659
660 @CalledByNative("RTCConfiguration")
661 boolean getEnableRtpDataChannel() {
662 return enableRtpDataChannel;
663 }
664
665 @CalledByNative("RTCConfiguration")
666 boolean getSuspendBelowMinBitrate() {
667 return suspendBelowMinBitrate;
668 }
669
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100670 @Nullable
Sami Kalliomäkie8b26cd2017-12-19 12:51:53 +0100671 @CalledByNative("RTCConfiguration")
672 Integer getScreencastMinBitrate() {
673 return screencastMinBitrate;
674 }
675
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100676 @Nullable
Sami Kalliomäkie8b26cd2017-12-19 12:51:53 +0100677 @CalledByNative("RTCConfiguration")
678 Boolean getCombinedAudioVideoBwe() {
679 return combinedAudioVideoBwe;
680 }
681
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100682 @Nullable
Sami Kalliomäkie8b26cd2017-12-19 12:51:53 +0100683 @CalledByNative("RTCConfiguration")
684 Boolean getEnableDtlsSrtp() {
685 return enableDtlsSrtp;
686 }
Qingsi Wang9a5c6f82018-02-01 10:38:40 -0800687
688 @CalledByNative("RTCConfiguration")
689 AdapterType getNetworkPreference() {
690 return networkPreference;
691 }
Seth Hampsonc384e142018-03-06 15:47:10 -0800692
693 @CalledByNative("RTCConfiguration")
694 SdpSemantics getSdpSemantics() {
695 return sdpSemantics;
696 }
Zhi Huangb57e1692018-06-12 11:41:11 -0700697
698 @CalledByNative("RTCConfiguration")
699 boolean getActiveResetSrtpParams() {
700 return activeResetSrtpParams;
701 }
Jiayang Liucac1b382015-04-30 12:35:24 -0700702 };
703
Magnus Jedvert6062f372017-11-16 16:53:12 +0100704 private final List<MediaStream> localStreams = new ArrayList<>();
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000705 private final long nativePeerConnection;
Magnus Jedvert6062f372017-11-16 16:53:12 +0100706 private List<RtpSender> senders = new ArrayList<>();
707 private List<RtpReceiver> receivers = new ArrayList<>();
Seth Hampsonc384e142018-03-06 15:47:10 -0800708 private List<RtpTransceiver> transceivers = new ArrayList<>();
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000709
Sami Kalliomäki1ece1ed2017-12-20 11:59:22 +0100710 /**
711 * Wraps a PeerConnection created by the factory. Can be used by clients that want to implement
712 * their PeerConnection creation in JNI.
713 */
714 public PeerConnection(NativePeerConnectionFactory factory) {
Sami Kalliomäkice5c19a2018-01-15 09:28:34 +0100715 this(factory.createNativePeerConnection());
Sami Kalliomäki1ece1ed2017-12-20 11:59:22 +0100716 }
717
Sami Kalliomäkice5c19a2018-01-15 09:28:34 +0100718 PeerConnection(long nativePeerConnection) {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000719 this.nativePeerConnection = nativePeerConnection;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000720 }
721
722 // JsepInterface.
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100723 public SessionDescription getLocalDescription() {
724 return nativeGetLocalDescription();
725 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000726
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100727 public SessionDescription getRemoteDescription() {
728 return nativeGetRemoteDescription();
729 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000730
Michael Iedema02137862018-10-09 15:30:01 +0200731 public RtcCertificatePem getCertificate() {
732 return nativeGetCertificate();
733 }
734
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100735 public DataChannel createDataChannel(String label, DataChannel.Init init) {
736 return nativeCreateDataChannel(label, init);
737 }
henrike@webrtc.org723d6832013-07-12 16:04:50 +0000738
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100739 public void createOffer(SdpObserver observer, MediaConstraints constraints) {
740 nativeCreateOffer(observer, constraints);
741 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000742
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100743 public void createAnswer(SdpObserver observer, MediaConstraints constraints) {
744 nativeCreateAnswer(observer, constraints);
745 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000746
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100747 public void setLocalDescription(SdpObserver observer, SessionDescription sdp) {
748 nativeSetLocalDescription(observer, sdp);
749 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000750
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100751 public void setRemoteDescription(SdpObserver observer, SessionDescription sdp) {
752 nativeSetRemoteDescription(observer, sdp);
753 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000754
Seth Hampsonc384e142018-03-06 15:47:10 -0800755 /**
756 * Enables/disables playout of received audio streams. Enabled by default.
757 *
758 * Note that even if playout is enabled, streams will only be played out if
759 * the appropriate SDP is also applied. The main purpose of this API is to
760 * be able to control the exact time when audio playout starts.
761 */
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100762 public void setAudioPlayout(boolean playout) {
763 nativeSetAudioPlayout(playout);
764 }
henrika5f6bf242017-11-01 11:06:56 +0100765
Seth Hampsonc384e142018-03-06 15:47:10 -0800766 /**
767 * Enables/disables recording of transmitted audio streams. Enabled by default.
768 *
769 * Note that even if recording is enabled, streams will only be recorded if
770 * the appropriate SDP is also applied. The main purpose of this API is to
771 * be able to control the exact time when audio recording starts.
772 */
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100773 public void setAudioRecording(boolean recording) {
774 nativeSetAudioRecording(recording);
775 }
henrika5f6bf242017-11-01 11:06:56 +0100776
deadbeef5d0b6d82017-01-09 16:05:28 -0800777 public boolean setConfiguration(RTCConfiguration config) {
Sami Kalliomäkice5c19a2018-01-15 09:28:34 +0100778 return nativeSetConfiguration(config);
deadbeef5d0b6d82017-01-09 16:05:28 -0800779 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000780
781 public boolean addIceCandidate(IceCandidate candidate) {
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100782 return nativeAddIceCandidate(candidate.sdpMid, candidate.sdpMLineIndex, candidate.sdp);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000783 }
784
Honghai Zhang7fb69db2016-03-14 11:59:18 -0700785 public boolean removeIceCandidates(final IceCandidate[] candidates) {
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100786 return nativeRemoveIceCandidates(candidates);
Honghai Zhang7fb69db2016-03-14 11:59:18 -0700787 }
788
Seth Hampsonc384e142018-03-06 15:47:10 -0800789 /**
790 * Adds a new MediaStream to be sent on this peer connection.
791 * Note: This method is not supported with SdpSemantics.UNIFIED_PLAN. Please
792 * use addTrack instead.
793 */
perkj@webrtc.orgc2dd5ee2014-11-04 11:31:29 +0000794 public boolean addStream(MediaStream stream) {
Sami Kalliomäkiee05e902018-09-28 14:38:21 +0200795 boolean ret = nativeAddLocalStream(stream.getNativeMediaStream());
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000796 if (!ret) {
797 return false;
798 }
799 localStreams.add(stream);
800 return true;
801 }
802
Seth Hampsonc384e142018-03-06 15:47:10 -0800803 /**
804 * Removes the given media stream from this peer connection.
805 * This method is not supported with SdpSemantics.UNIFIED_PLAN. Please use
806 * removeTrack instead.
807 */
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000808 public void removeStream(MediaStream stream) {
Sami Kalliomäkiee05e902018-09-28 14:38:21 +0200809 nativeRemoveLocalStream(stream.getNativeMediaStream());
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000810 localStreams.remove(stream);
811 }
812
deadbeef7a246882017-08-09 08:40:10 -0700813 /**
814 * Creates an RtpSender without a track.
Seth Hampsonc384e142018-03-06 15:47:10 -0800815 *
816 * <p>This method allows an application to cause the PeerConnection to negotiate
deadbeef7a246882017-08-09 08:40:10 -0700817 * sending/receiving a specific media type, but without having a track to
818 * send yet.
Seth Hampsonc384e142018-03-06 15:47:10 -0800819 *
820 * <p>When the application does want to begin sending a track, it can call
deadbeef7a246882017-08-09 08:40:10 -0700821 * RtpSender.setTrack, which doesn't require any additional SDP negotiation.
Seth Hampsonc384e142018-03-06 15:47:10 -0800822 *
823 * <p>Example use:
deadbeef7a246882017-08-09 08:40:10 -0700824 * <pre>
825 * {@code
826 * audioSender = pc.createSender("audio", "stream1");
827 * videoSender = pc.createSender("video", "stream1");
828 * // Do normal SDP offer/answer, which will kick off ICE/DTLS and negotiate
829 * // media parameters....
830 * // Later, when the endpoint is ready to actually begin sending:
831 * audioSender.setTrack(audioTrack, false);
832 * videoSender.setTrack(videoTrack, false);
833 * }
834 * </pre>
Seth Hampsonc384e142018-03-06 15:47:10 -0800835 * <p>Note: This corresponds most closely to "addTransceiver" in the official
deadbeef7a246882017-08-09 08:40:10 -0700836 * WebRTC API, in that it creates a sender without a track. It was
837 * implemented before addTransceiver because it provides useful
838 * functionality, and properly implementing transceivers would have required
839 * a great deal more work.
840 *
Seth Hampsonc384e142018-03-06 15:47:10 -0800841 * <p>Note: This is only available with SdpSemantics.PLAN_B specified. Please use
842 * addTransceiver instead.
843 *
deadbeef7a246882017-08-09 08:40:10 -0700844 * @param kind Corresponds to MediaStreamTrack kinds (must be "audio" or
845 * "video").
846 * @param stream_id The ID of the MediaStream that this sender's track will
847 * be associated with when SDP is applied to the remote
848 * PeerConnection. If createSender is used to create an
849 * audio and video sender that should be synchronized, they
850 * should use the same stream ID.
851 * @return A new RtpSender object if successful, or null otherwise.
852 */
deadbeefbd7d8f72015-12-18 16:58:44 -0800853 public RtpSender createSender(String kind, String stream_id) {
Seth Hampsonc384e142018-03-06 15:47:10 -0800854 RtpSender newSender = nativeCreateSender(kind, stream_id);
855 if (newSender != null) {
856 senders.add(newSender);
deadbeefee524f72015-12-02 11:27:40 -0800857 }
Seth Hampsonc384e142018-03-06 15:47:10 -0800858 return newSender;
deadbeefee524f72015-12-02 11:27:40 -0800859 }
860
Seth Hampsonc384e142018-03-06 15:47:10 -0800861 /**
862 * Gets all RtpSenders associated with this peer connection.
863 * Note that calling getSenders will dispose of the senders previously
864 * returned.
865 */
deadbeef4139c0f2015-10-06 12:29:25 -0700866 public List<RtpSender> getSenders() {
867 for (RtpSender sender : senders) {
868 sender.dispose();
869 }
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100870 senders = nativeGetSenders();
deadbeef4139c0f2015-10-06 12:29:25 -0700871 return Collections.unmodifiableList(senders);
872 }
873
Seth Hampsonc384e142018-03-06 15:47:10 -0800874 /**
875 * Gets all RtpReceivers associated with this peer connection.
876 * Note that calling getReceivers will dispose of the receivers previously
877 * returned.
878 */
deadbeef4139c0f2015-10-06 12:29:25 -0700879 public List<RtpReceiver> getReceivers() {
880 for (RtpReceiver receiver : receivers) {
881 receiver.dispose();
882 }
Magnus Jedvert84d8ae52017-12-20 15:12:10 +0100883 receivers = nativeGetReceivers();
deadbeef4139c0f2015-10-06 12:29:25 -0700884 return Collections.unmodifiableList(receivers);
885 }
886
Seth Hampsonc384e142018-03-06 15:47:10 -0800887 /**
888 * Gets all RtpTransceivers associated with this peer connection.
889 * Note that calling getTransceivers will dispose of the transceivers previously
890 * returned.
891 * Note: This is only available with SdpSemantics.UNIFIED_PLAN specified.
892 */
893 public List<RtpTransceiver> getTransceivers() {
894 for (RtpTransceiver transceiver : transceivers) {
895 transceiver.dispose();
896 }
897 transceivers = nativeGetTransceivers();
898 return Collections.unmodifiableList(transceivers);
899 }
900
901 /**
902 * Adds a new media stream track to be sent on this peer connection, and returns
903 * the newly created RtpSender. If streamIds are specified, the RtpSender will
904 * be associated with the streams specified in the streamIds list.
905 *
906 * @throws IllegalStateException if an error accors in C++ addTrack.
907 * An error can occur if:
908 * - A sender already exists for the track.
909 * - The peer connection is closed.
910 */
911 public RtpSender addTrack(MediaStreamTrack track) {
912 return addTrack(track, Collections.emptyList());
913 }
914
915 public RtpSender addTrack(MediaStreamTrack track, List<String> streamIds) {
916 if (track == null || streamIds == null) {
917 throw new NullPointerException("No MediaStreamTrack specified in addTrack.");
918 }
Sami Kalliomäkiee05e902018-09-28 14:38:21 +0200919 RtpSender newSender = nativeAddTrack(track.getNativeMediaStreamTrack(), streamIds);
Seth Hampsonc384e142018-03-06 15:47:10 -0800920 if (newSender == null) {
921 throw new IllegalStateException("C++ addTrack failed.");
922 }
923 senders.add(newSender);
924 return newSender;
925 }
926
927 /**
928 * Stops sending media from sender. The sender will still appear in getSenders. Future
929 * calls to createOffer will mark the m section for the corresponding transceiver as
930 * receive only or inactive, as defined in JSEP. Returns true on success.
931 */
932 public boolean removeTrack(RtpSender sender) {
933 if (sender == null) {
934 throw new NullPointerException("No RtpSender specified for removeTrack.");
935 }
Sami Kalliomäkiee05e902018-09-28 14:38:21 +0200936 return nativeRemoveTrack(sender.getNativeRtpSender());
Seth Hampsonc384e142018-03-06 15:47:10 -0800937 }
938
939 /**
940 * Creates a new RtpTransceiver and adds it to the set of transceivers. Adding a
941 * transceiver will cause future calls to CreateOffer to add a media description
942 * for the corresponding transceiver.
943 *
944 * <p>The initial value of |mid| in the returned transceiver is null. Setting a
945 * new session description may change it to a non-null value.
946 *
947 * <p>https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-addtransceiver
948 *
949 * <p>If a MediaStreamTrack is specified then a transceiver will be added with a
950 * sender set to transmit the given track. The kind
951 * of the transceiver (and sender/receiver) will be derived from the kind of
952 * the track.
953 *
954 * <p>If MediaType is specified then a transceiver will be added based upon that type.
955 * This can be either MEDIA_TYPE_AUDIO or MEDIA_TYPE_VIDEO.
956 *
957 * <p>Optionally, an RtpTransceiverInit structure can be specified to configure
958 * the transceiver from construction. If not specified, the transceiver will
959 * default to having a direction of kSendRecv and not be part of any streams.
960 *
961 * <p>Note: These methods are only available with SdpSemantics.UNIFIED_PLAN specified.
962 * @throws IllegalStateException if an error accors in C++ addTransceiver
963 */
964 public RtpTransceiver addTransceiver(MediaStreamTrack track) {
965 return addTransceiver(track, new RtpTransceiver.RtpTransceiverInit());
966 }
967
968 public RtpTransceiver addTransceiver(
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100969 MediaStreamTrack track, @Nullable RtpTransceiver.RtpTransceiverInit init) {
Seth Hampsonc384e142018-03-06 15:47:10 -0800970 if (track == null) {
971 throw new NullPointerException("No MediaStreamTrack specified for addTransceiver.");
972 }
973 if (init == null) {
974 init = new RtpTransceiver.RtpTransceiverInit();
975 }
Sami Kalliomäkiee05e902018-09-28 14:38:21 +0200976 RtpTransceiver newTransceiver =
977 nativeAddTransceiverWithTrack(track.getNativeMediaStreamTrack(), init);
Seth Hampsonc384e142018-03-06 15:47:10 -0800978 if (newTransceiver == null) {
979 throw new IllegalStateException("C++ addTransceiver failed.");
980 }
981 transceivers.add(newTransceiver);
982 return newTransceiver;
983 }
984
985 public RtpTransceiver addTransceiver(MediaStreamTrack.MediaType mediaType) {
986 return addTransceiver(mediaType, new RtpTransceiver.RtpTransceiverInit());
987 }
988
989 public RtpTransceiver addTransceiver(
Sami Kalliomäkie7592d82018-03-22 13:32:44 +0100990 MediaStreamTrack.MediaType mediaType, @Nullable RtpTransceiver.RtpTransceiverInit init) {
Seth Hampsonc384e142018-03-06 15:47:10 -0800991 if (mediaType == null) {
992 throw new NullPointerException("No MediaType specified for addTransceiver.");
993 }
994 if (init == null) {
995 init = new RtpTransceiver.RtpTransceiverInit();
996 }
997 RtpTransceiver newTransceiver = nativeAddTransceiverOfType(mediaType, init);
998 if (newTransceiver == null) {
999 throw new IllegalStateException("C++ addTransceiver failed.");
1000 }
1001 transceivers.add(newTransceiver);
1002 return newTransceiver;
1003 }
1004
deadbeef82215872017-04-18 10:27:51 -07001005 // Older, non-standard implementation of getStats.
1006 @Deprecated
Sami Kalliomäkie7592d82018-03-22 13:32:44 +01001007 public boolean getStats(StatsObserver observer, @Nullable MediaStreamTrack track) {
Sami Kalliomäkiee05e902018-09-28 14:38:21 +02001008 return nativeOldGetStats(observer, (track == null) ? 0 : track.getNativeMediaStreamTrack());
deadbeef82215872017-04-18 10:27:51 -07001009 }
1010
Seth Hampsonc384e142018-03-06 15:47:10 -08001011 /**
1012 * Gets stats using the new stats collection API, see webrtc/api/stats/. These
1013 * will replace old stats collection API when the new API has matured enough.
1014 */
deadbeef82215872017-04-18 10:27:51 -07001015 public void getStats(RTCStatsCollectorCallback callback) {
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001016 nativeNewGetStats(callback);
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001017 }
1018
Seth Hampsonc384e142018-03-06 15:47:10 -08001019 /**
1020 * Limits the bandwidth allocated for all RTP streams sent by this
1021 * PeerConnection. Pass null to leave a value unchanged.
1022 */
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001023 public boolean setBitrate(Integer min, Integer current, Integer max) {
1024 return nativeSetBitrate(min, current, max);
1025 }
zsteind89b0bc2017-08-03 11:11:40 -07001026
Seth Hampsonc384e142018-03-06 15:47:10 -08001027 /**
1028 * Starts recording an RTC event log.
1029 *
1030 * Ownership of the file is transfered to the native code. If an RTC event
1031 * log is already being recorded, it will be stopped and a new one will start
1032 * using the provided file. Logging will continue until the stopRtcEventLog
1033 * function is called. The max_size_bytes argument is ignored, it is added
1034 * for future use.
1035 */
ivoc0c6f0f62016-07-06 04:34:23 -07001036 public boolean startRtcEventLog(int file_descriptor, int max_size_bytes) {
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001037 return nativeStartRtcEventLog(file_descriptor, max_size_bytes);
ivoc14d5dbe2016-07-04 07:06:55 -07001038 }
1039
Seth Hampsonc384e142018-03-06 15:47:10 -08001040 /**
1041 * Stops recording an RTC event log. If no RTC event log is currently being
1042 * recorded, this call will have no effect.
1043 */
ivoc14d5dbe2016-07-04 07:06:55 -07001044 public void stopRtcEventLog() {
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001045 nativeStopRtcEventLog();
ivoc14d5dbe2016-07-04 07:06:55 -07001046 }
1047
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001048 // TODO(fischman): add support for DTMF-related methods once that API
1049 // stabilizes.
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001050 public SignalingState signalingState() {
1051 return nativeSignalingState();
1052 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001053
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001054 public IceConnectionState iceConnectionState() {
1055 return nativeIceConnectionState();
1056 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001057
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001058 public IceGatheringState iceGatheringState() {
1059 return nativeIceGatheringState();
1060 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001061
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001062 public void close() {
1063 nativeClose();
1064 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001065
deadbeef43697f62017-09-12 10:52:14 -07001066 /**
1067 * Free native resources associated with this PeerConnection instance.
Seth Hampsonc384e142018-03-06 15:47:10 -08001068 *
deadbeef43697f62017-09-12 10:52:14 -07001069 * This method removes a reference count from the C++ PeerConnection object,
1070 * which should result in it being destroyed. It also calls equivalent
1071 * "dispose" methods on the Java objects attached to this PeerConnection
1072 * (streams, senders, receivers), such that their associated C++ objects
1073 * will also be destroyed.
Seth Hampsonc384e142018-03-06 15:47:10 -08001074 *
1075 * <p>Note that this method cannot be safely called from an observer callback
deadbeef43697f62017-09-12 10:52:14 -07001076 * (PeerConnection.Observer, DataChannel.Observer, etc.). If you want to, for
1077 * example, destroy the PeerConnection after an "ICE failed" callback, you
1078 * must do this asynchronously (in other words, unwind the stack first). See
1079 * <a href="https://bugs.chromium.org/p/webrtc/issues/detail?id=3721">bug
1080 * 3721</a> for more details.
1081 */
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001082 public void dispose() {
1083 close();
1084 for (MediaStream stream : localStreams) {
Sami Kalliomäkiee05e902018-09-28 14:38:21 +02001085 nativeRemoveLocalStream(stream.getNativeMediaStream());
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001086 stream.dispose();
1087 }
1088 localStreams.clear();
deadbeef4139c0f2015-10-06 12:29:25 -07001089 for (RtpSender sender : senders) {
1090 sender.dispose();
1091 }
1092 senders.clear();
1093 for (RtpReceiver receiver : receivers) {
1094 receiver.dispose();
1095 }
Seth Hampsonc384e142018-03-06 15:47:10 -08001096 for (RtpTransceiver transceiver : transceivers) {
1097 transceiver.dispose();
1098 }
1099 transceivers.clear();
deadbeef4139c0f2015-10-06 12:29:25 -07001100 receivers.clear();
Sami Kalliomäkice5c19a2018-01-15 09:28:34 +01001101 nativeFreeOwnedPeerConnection(nativePeerConnection);
1102 }
1103
1104 /** Returns a pointer to the native webrtc::PeerConnectionInterface. */
1105 public long getNativePeerConnection() {
1106 return nativeGetNativePeerConnection();
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001107 }
1108
Magnus Jedvert9060eb12017-12-12 12:52:54 +01001109 @CalledByNative
Sami Kalliomäkice5c19a2018-01-15 09:28:34 +01001110 long getNativeOwnedPeerConnection() {
Magnus Jedvert9060eb12017-12-12 12:52:54 +01001111 return nativePeerConnection;
1112 }
1113
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001114 public static long createNativePeerConnectionObserver(Observer observer) {
1115 return nativeCreatePeerConnectionObserver(observer);
1116 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001117
Sami Kalliomäkice5c19a2018-01-15 09:28:34 +01001118 private native long nativeGetNativePeerConnection();
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001119 private native SessionDescription nativeGetLocalDescription();
1120 private native SessionDescription nativeGetRemoteDescription();
Michael Iedema02137862018-10-09 15:30:01 +02001121 private native RtcCertificatePem nativeGetCertificate();
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001122 private native DataChannel nativeCreateDataChannel(String label, DataChannel.Init init);
1123 private native void nativeCreateOffer(SdpObserver observer, MediaConstraints constraints);
1124 private native void nativeCreateAnswer(SdpObserver observer, MediaConstraints constraints);
1125 private native void nativeSetLocalDescription(SdpObserver observer, SessionDescription sdp);
1126 private native void nativeSetRemoteDescription(SdpObserver observer, SessionDescription sdp);
1127 private native void nativeSetAudioPlayout(boolean playout);
1128 private native void nativeSetAudioRecording(boolean recording);
1129 private native boolean nativeSetBitrate(Integer min, Integer current, Integer max);
1130 private native SignalingState nativeSignalingState();
1131 private native IceConnectionState nativeIceConnectionState();
1132 private native IceGatheringState nativeIceGatheringState();
1133 private native void nativeClose();
1134 private static native long nativeCreatePeerConnectionObserver(Observer observer);
Sami Kalliomäkice5c19a2018-01-15 09:28:34 +01001135 private static native void nativeFreeOwnedPeerConnection(long ownedPeerConnection);
1136 private native boolean nativeSetConfiguration(RTCConfiguration config);
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001137 private native boolean nativeAddIceCandidate(
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001138 String sdpMid, int sdpMLineIndex, String iceCandidateSdp);
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001139 private native boolean nativeRemoveIceCandidates(final IceCandidate[] candidates);
1140 private native boolean nativeAddLocalStream(long stream);
1141 private native void nativeRemoveLocalStream(long stream);
1142 private native boolean nativeOldGetStats(StatsObserver observer, long nativeTrack);
1143 private native void nativeNewGetStats(RTCStatsCollectorCallback callback);
1144 private native RtpSender nativeCreateSender(String kind, String stream_id);
1145 private native List<RtpSender> nativeGetSenders();
1146 private native List<RtpReceiver> nativeGetReceivers();
Seth Hampsonc384e142018-03-06 15:47:10 -08001147 private native List<RtpTransceiver> nativeGetTransceivers();
1148 private native RtpSender nativeAddTrack(long track, List<String> streamIds);
1149 private native boolean nativeRemoveTrack(long sender);
1150 private native RtpTransceiver nativeAddTransceiverWithTrack(
1151 long track, RtpTransceiver.RtpTransceiverInit init);
1152 private native RtpTransceiver nativeAddTransceiverOfType(
1153 MediaStreamTrack.MediaType mediaType, RtpTransceiver.RtpTransceiverInit init);
Magnus Jedvert84d8ae52017-12-20 15:12:10 +01001154 private native boolean nativeStartRtcEventLog(int file_descriptor, int max_size_bytes);
1155 private native void nativeStopRtcEventLog();
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001156}