zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement JNI and objc implementation for icecandidateerror event

Browse Source 
This CL adds the callback on ICE Candidate Error to the Android and
the iOS SDKs.

Spec: https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection-onicecandidateerror

Bug: webrtc:13446
Change-Id: I6e511aaa80f1aa8f4310d8518d1144d97470cd7e
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/239460
Reviewed-by: Henrik Andreassson <henrika@webrtc.org>
Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org>
Commit-Queue: Henrik Andreassson <henrika@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#35531}
This commit is contained in:
Jaehyun Ko
2021-11-30 19:01:43 +09:00
committed by WebRTC LUCI CQ
parent 63b97de330
commit d211098392
15 changed files with 233 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
examples/androidapp/src/org/appspot/apprtc/PeerConnectionClient.java
View File

@ -46,6 +46,7 @@ import org.webrtc.DefaultVideoDecoderFactory;
import org.webrtc.DefaultVideoEncoderFactory;
import org.webrtc.EglBase;
import org.webrtc.IceCandidate;
import org.webrtc.IceCandidateErrorEvent;
import org.webrtc.Logging;
import org.webrtc.MediaConstraints;
import org.webrtc.MediaStream;
@ -1213,6 +1214,13 @@ public class PeerConnectionClient {
executor.execute(() -> events.onIceCandidate(candidate));
}
@Override
public void onIceCandidateError(final IceCandidateErrorEvent event) {
Log.d(TAG,
"IceCandidateError address: " + event.address + ", port: " + event.port + ", url: "
+ event.url + ", errorCode: " + event.errorCode + ", errorText: " + event.errorText);
}
@Override
public void onIceCandidatesRemoved(final IceCandidate[] candidates) {
executor.execute(() -> events.onIceCandidatesRemoved(candidates));

12
examples/objc/AppRTCMobile/ARDAppClient.m
View File

@ -13,6 +13,7 @@
#import "sdk/objc/api/peerconnection/RTCAudioTrack.h"
#import "sdk/objc/api/peerconnection/RTCConfiguration.h"
#import "sdk/objc/api/peerconnection/RTCFileLogger.h"
#import "sdk/objc/api/peerconnection/RTCIceCandidateErrorEvent.h"
#import "sdk/objc/api/peerconnection/RTCIceServer.h"
#import "sdk/objc/api/peerconnection/RTCMediaConstraints.h"
#import "sdk/objc/api/peerconnection/RTCMediaStream.h"
@ -425,6 +426,17 @@ static int const kKbpsMultiplier = 1000;
});
}
- (void)peerConnection:(RTC_OBJC_TYPE(RTCPeerConnection) *)peerConnection
didFailToGatherIceCandidate:(RTC_OBJC_TYPE(RTCIceCandidateErrorEvent) *)event {
RTCLog(@"Failed to gather ICE candidate. address: %@, port: %d, url: %@, errorCode: %d, "
@"errorText: %@",
event.address,
event.port,
event.url,
event.errorCode,
event.errorText);
}
- (void)peerConnection:(RTC_OBJC_TYPE(RTCPeerConnection) *)peerConnection
didRemoveIceCandidates:(NSArray<RTC_OBJC_TYPE(RTCIceCandidate) *> *)candidates {
dispatch_async(dispatch_get_main_queue(), ^{

5
sdk/BUILD.gn
View File

@ -890,6 +890,9 @@ if (is_ios || is_mac) {
"objc/api/peerconnection/RTCIceCandidate+Private.h",
"objc/api/peerconnection/RTCIceCandidate.h",
"objc/api/peerconnection/RTCIceCandidate.mm",
"objc/api/peerconnection/RTCIceCandidateErrorEvent+Private.h",
"objc/api/peerconnection/RTCIceCandidateErrorEvent.h",
"objc/api/peerconnection/RTCIceCandidateErrorEvent.mm",
"objc/api/peerconnection/RTCIceServer+Private.h",
"objc/api/peerconnection/RTCIceServer.h",
"objc/api/peerconnection/RTCIceServer.mm",
@ -1261,6 +1264,7 @@ if (is_ios || is_mac) {
"objc/api/peerconnection/RTCDataChannelConfiguration.h",
"objc/api/peerconnection/RTCFieldTrials.h",
"objc/api/peerconnection/RTCIceCandidate.h",
"objc/api/peerconnection/RTCIceCandidateErrorEvent.h",
"objc/api/peerconnection/RTCIceServer.h",
"objc/api/peerconnection/RTCLegacyStatsReport.h",
"objc/api/peerconnection/RTCMediaConstraints.h",
@ -1375,6 +1379,7 @@ if (is_ios || is_mac) {
"objc/api/peerconnection/RTCDtmfSender.h",
"objc/api/peerconnection/RTCFieldTrials.h",
"objc/api/peerconnection/RTCIceCandidate.h",
"objc/api/peerconnection/RTCIceCandidateErrorEvent.h",
"objc/api/peerconnection/RTCIceServer.h",
"objc/api/peerconnection/RTCLegacyStatsReport.h",
"objc/api/peerconnection/RTCMediaConstraints.h",

2
sdk/android/BUILD.gn
View File

@ -263,6 +263,7 @@ if (is_android) {
"api/org/webrtc/FrameDecryptor.java",
"api/org/webrtc/FrameEncryptor.java",
"api/org/webrtc/IceCandidate.java",
"api/org/webrtc/IceCandidateErrorEvent.java",
"api/org/webrtc/MediaConstraints.java",
"api/org/webrtc/MediaSource.java",
"api/org/webrtc/MediaStream.java",
@ -1330,6 +1331,7 @@ if (current_os == "linux" || is_android) {
"api/org/webrtc/DataChannel.java",
"api/org/webrtc/DtmfSender.java",
"api/org/webrtc/IceCandidate.java",
"api/org/webrtc/IceCandidateErrorEvent.java",
"api/org/webrtc/MediaConstraints.java",
"api/org/webrtc/MediaSource.java",
"api/org/webrtc/MediaStream.java",

43
sdk/android/api/org/webrtc/IceCandidateErrorEvent.java Normal file
View File

@ -0,0 +1,43 @@
/*
* Copyright (c) 2021 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
package org.webrtc;
public final class IceCandidateErrorEvent {
/** The local IP address used to communicate with the STUN or TURN server. */
public final String address;
/** The port used to communicate with the STUN or TURN server. */
public final int port;
/**
* The STUN or TURN URL that identifies the STUN or TURN server for which the failure occurred.
*/
public final String url;
/**
* The numeric STUN error code returned by the STUN or TURN server. If no host candidate can reach
* the server, errorCode will be set to the value 701 which is outside the STUN error code range.
* This error is only fired once per server URL while in the RTCIceGatheringState of "gathering".
*/
public final int errorCode;
/**
* The STUN reason text returned by the STUN or TURN server. If the server could not be reached,
* errorText will be set to an implementation-specific value providing details about the error.
*/
public final String errorText;
@CalledByNative
public IceCandidateErrorEvent(
String address, int port, String url, int errorCode, String errorText) {
this.address = address;
this.port = port;
this.url = url;
this.errorCode = errorCode;
this.errorText = errorText;
}
}

3
sdk/android/api/org/webrtc/PeerConnection.java
View File

@ -118,6 +118,9 @@ public class PeerConnection {
/** Triggered when a new ICE candidate has been found. */
@CalledByNative("Observer") void onIceCandidate(IceCandidate candidate);
/** Triggered when gathering of an ICE candidate failed. */
default @CalledByNative("Observer") void onIceCandidateError(IceCandidateErrorEvent event) {}
/** Triggered when some ICE candidates have been removed. */
@CalledByNative("Observer") void onIceCandidatesRemoved(IceCandidate[] candidates);

3
sdk/android/instrumentationtests/src/org/webrtc/PeerConnectionEndToEndTest.java
View File

@ -125,6 +125,9 @@ public class PeerConnectionEndToEndTest {
}
}
@Override
public void onIceCandidateError(IceCandidateErrorEvent event) {}
@Override
public void onIceCandidatesRemoved(IceCandidate[] candidates) {}

14
sdk/android/src/jni/pc/peer_connection.cc
View File

@ -41,6 +41,7 @@
#include "rtc_base/logging.h"
#include "rtc_base/numerics/safe_conversions.h"
#include "sdk/android/generated_peerconnection_jni/CandidatePairChangeEvent_jni.h"
#include "sdk/android/generated_peerconnection_jni/IceCandidateErrorEvent_jni.h"
#include "sdk/android/generated_peerconnection_jni/PeerConnection_jni.h"
#include "sdk/android/native_api/jni/java_types.h"
#include "sdk/android/src/jni/jni_helpers.h"
@ -306,6 +307,19 @@ void PeerConnectionObserverJni::OnIceCandidate(
NativeToJavaIceCandidate(env, *candidate));
}
void PeerConnectionObserverJni::OnIceCandidateError(
const std::string& address,
int port,
const std::string& url,
int error_code,
const std::string& error_text) {
JNIEnv* env = AttachCurrentThreadIfNeeded();
ScopedJavaLocalRef<jobject> event = Java_IceCandidateErrorEvent_Constructor(
env, NativeToJavaString(env, address), port, NativeToJavaString(env, url),
error_code, NativeToJavaString(env, error_text));
Java_Observer_onIceCandidateError(env, j_observer_global_, event);
}
void PeerConnectionObserverJni::OnIceCandidatesRemoved(
const std::vector<cricket::Candidate>& candidates) {
JNIEnv* env = AttachCurrentThreadIfNeeded();

6
sdk/android/src/jni/pc/peer_connection.h
View File

@ -48,6 +48,12 @@ class PeerConnectionObserverJni : public PeerConnectionObserver {
// Implementation of PeerConnectionObserver interface, which propagates
// the callbacks to the Java observer.
void OnIceCandidate(const IceCandidateInterface* candidate) override;
void OnIceCandidateError(const std::string& address,
int port,
const std::string& url,
int error_code,
const std::string& error_text) override;
void OnIceCandidatesRemoved(
const std::vector<cricket::Candidate>& candidates) override;
void OnSignalingChange(

26
sdk/objc/api/peerconnection/RTCIceCandidateErrorEvent+Private.h Normal file
View File

@ -0,0 +1,26 @@
/*
* Copyright (c) 2021 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#import "RTCIceCandidateErrorEvent.h"
#include <string>
NS_ASSUME_NONNULL_BEGIN
@interface RTC_OBJC_TYPE (RTCIceCandidateErrorEvent)
()
- (instancetype)initWithAddress : (const std::string&)address port : (const int)port url
: (const std::string&)url errorCode : (const int)errorCode errorText
: (const std::string&)errorText;
@end
NS_ASSUME_NONNULL_END

42
sdk/objc/api/peerconnection/RTCIceCandidateErrorEvent.h Normal file
View File

@ -0,0 +1,42 @@
/*
* Copyright (c) 2021 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#import <Foundation/Foundation.h>
#import "RTCMacros.h"
NS_ASSUME_NONNULL_BEGIN
RTC_OBJC_EXPORT
@interface RTC_OBJC_TYPE (RTCIceCandidateErrorEvent) : NSObject
/** The local IP address used to communicate with the STUN or TURN server. */
@property(nonatomic, readonly) NSString *address;
/** The port used to communicate with the STUN or TURN server. */
@property(nonatomic, readonly) int port;
/** The STUN or TURN URL that identifies the STUN or TURN server for which the failure occurred. */
@property(nonatomic, readonly) NSString *url;
/** The numeric STUN error code returned by the STUN or TURN server. If no host candidate can reach
* the server, errorCode will be set to the value 701 which is outside the STUN error code range.
* This error is only fired once per server URL while in the RTCIceGatheringState of "gathering". */
@property(nonatomic, readonly) int errorCode;
/** The STUN reason text returned by the STUN or TURN server. If the server could not be reached,
* errorText will be set to an implementation-specific value providing details about the error. */
@property(nonatomic, readonly) NSString *errorText;
- (instancetype)init NS_DESIGNATED_INITIALIZER;
@end
NS_ASSUME_NONNULL_END

42
sdk/objc/api/peerconnection/RTCIceCandidateErrorEvent.mm Normal file
View File

@ -0,0 +1,42 @@
/*
* Copyright (c) 2021 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#import "RTCIceCandidateErrorEvent+Private.h"
#import "helpers/NSString+StdString.h"
@implementation RTC_OBJC_TYPE (RTCIceCandidateErrorEvent)
@synthesize address = _address;
@synthesize port = _port;
@synthesize url = _url;
@synthesize errorCode = _errorCode;
@synthesize errorText = _errorText;
- (instancetype)init {
return [super init];
}
- (instancetype)initWithAddress:(const std::string&)address
port:(const int)port
url:(const std::string&)url
errorCode:(const int)errorCode
errorText:(const std::string&)errorText {
if (self = [self init]) {
_address = [NSString stringForStdString:address];
_port = port;
_url = [NSString stringForStdString:url];
_errorCode = errorCode;
_errorText = [NSString stringForStdString:errorText];
}
return self;
}
@end

6
sdk/objc/api/peerconnection/RTCPeerConnection+Private.h
View File

@ -48,6 +48,12 @@ class PeerConnectionDelegateAdapter : public PeerConnectionObserver {
void OnIceCandidate(const IceCandidateInterface *candidate) override;
void OnIceCandidateError(const std::string &address,
int port,
const std::string &url,
int error_code,
const std::string &error_text) override;
void OnIceCandidatesRemoved(const std::vector<cricket::Candidate> &candidates) override;
void OnIceSelectedCandidatePairChanged(const cricket::CandidatePairChangeEvent &event) override;

5
sdk/objc/api/peerconnection/RTCPeerConnection.h
View File

@ -16,6 +16,7 @@
@class RTC_OBJC_TYPE(RTCDataChannel);
@class RTC_OBJC_TYPE(RTCDataChannelConfiguration);
@class RTC_OBJC_TYPE(RTCIceCandidate);
@class RTC_OBJC_TYPE(RTCIceCandidateErrorEvent);
@class RTC_OBJC_TYPE(RTCMediaConstraints);
@class RTC_OBJC_TYPE(RTCMediaStream);
@class RTC_OBJC_TYPE(RTCMediaStreamTrack);
@ -164,6 +165,10 @@ RTC_OBJC_EXPORT
lastReceivedMs:(int)lastDataReceivedMs
changeReason:(NSString *)reason;
/** Called when gathering of an ICE candidate failed. */
- (void)peerConnection:(RTC_OBJC_TYPE(RTCPeerConnection) *)peerConnection
didFailToGatherIceCandidate:(RTC_OBJC_TYPE(RTCIceCandidateErrorEvent) *)event;
@end
RTC_OBJC_EXPORT

16
sdk/objc/api/peerconnection/RTCPeerConnection.mm
View File

@ -13,6 +13,7 @@
#import "RTCConfiguration+Private.h"
#import "RTCDataChannel+Private.h"
#import "RTCIceCandidate+Private.h"
#import "RTCIceCandidateErrorEvent+Private.h"
#import "RTCLegacyStatsReport+Private.h"
#import "RTCMediaConstraints+Private.h"
#import "RTCMediaStream+Private.h"
@ -226,6 +227,21 @@ void PeerConnectionDelegateAdapter::OnIceCandidate(
didGenerateIceCandidate:iceCandidate];
}
void PeerConnectionDelegateAdapter::OnIceCandidateError(const std::string &address,
int port,
const std::string &url,
int error_code,
const std::string &error_text) {
RTC_OBJC_TYPE(RTCPeerConnection) *peer_connection = peer_connection_;
RTC_OBJC_TYPE(RTCIceCandidateErrorEvent) *event =
[[RTC_OBJC_TYPE(RTCIceCandidateErrorEvent) alloc] initWithAddress:address
port:port
url:url
errorCode:error_code
errorText:error_text];
[peer_connection.delegate peerConnection:peer_connection didFailToGatherIceCandidate:event];
}
void PeerConnectionDelegateAdapter::OnIceCandidatesRemoved(
const std::vector<cricket::Candidate>& candidates) {
NSMutableArray* ice_candidates =