Be ready fow new IceCandidate.address field in mediasoup server

versatica · Feb 12, 2024 · 9af8136 · 9af8136
1 parent 1a591fa
commit 9af8136
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/src/Transport.ts b/src/Transport.ts
@@ -65,7 +65,12 @@ export type IceCandidate = {
 	 */
 	priority: number;
 	/**
-	 * The IP address of the candidate.
+	 * The IP address or hostname of the candidate.
+	 */
+	address: string;
+	/**
+	 * The IP address  or hostname of the candidate.
+	 * @deprecated Use |address| instead.
 	 */
 	ip: string;
 	/**

diff --git a/src/handlers/sdp/MediaSection.ts b/src/handlers/sdp/MediaSection.ts
@@ -51,7 +51,9 @@ export abstract class MediaSection {
 				// RTP (1).
 				candidateObject.component = 1;
 				candidateObject.foundation = candidate.foundation;
-				candidateObject.ip = candidate.ip;
+				// Be ready for new candidate.address field in mediasoup server side
+				// field and keep backward compatibility with deprecated candidate.ip.
+				candidateObject.ip = candidate.address ?? candidate.ip;
 				candidateObject.port = candidate.port;
 				candidateObject.priority = candidate.priority;
 				candidateObject.transport = candidate.protocol;

diff --git a/src/test/fakeParameters.ts b/src/test/fakeParameters.ts
@@ -319,6 +319,7 @@ export function generateTransportRemoteParameters(): mediasoupClient.types.Trans
 		iceCandidates: [
 			{
 				foundation: 'udpcandidate',
+				address: '9.9.9.9',
 				ip: '9.9.9.9',
 				port: 40533,
 				priority: 1078862079,
@@ -328,6 +329,7 @@ export function generateTransportRemoteParameters(): mediasoupClient.types.Trans
 			},
 			{
 				foundation: 'udpcandidate',
+				address: '9.9.9.9',
 				ip: '9:9:9:9:9:9',
 				port: 41333,
 				priority: 1078862089,