From 2058a5784b73a709fdefa3c167f834e5ccbd1fda Mon Sep 17 00:00:00 2001 From: Alexander Gorbunov Date: Tue, 8 Aug 2023 17:07:45 +0900 Subject: [PATCH] docs: Add some details about PeerConnectionOptions parameter for transport creation methods --- _includes/documentation/v3/libmediasoupclient/api/Device.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/documentation/v3/libmediasoupclient/api/Device.md b/_includes/documentation/v3/libmediasoupclient/api/Device.md index c1f823e..0115cd9 100644 --- a/_includes/documentation/v3/libmediasoupclient/api/Device.md +++ b/_includes/documentation/v3/libmediasoupclient/api/Device.md @@ -144,7 +144,7 @@ Argument | Type | Description | Required | Default `iceParameters` | const nlohmann::json& [IceParameters](/documentation/v3/mediasoup/api/#WebRtcTransportIceParameters) | ICE parameters of the server side transport. | Yes | `iceCandidates` | const nlohmann::json& Array<[IceCandidate](/documentation/v3/mediasoup/api/#WebRtcTransportIceCandidate)> | ICE candidates of the server side transport. | Yes | `dtlsParameters` | const nlohmann::json& [DtlsParameters](/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters) | DTLS parameters of the server side transport. | Yes | -`peerConnectionOptions` | [PeerConnection::Options\*](#PeerConnectionOptions) | PeerConnection options. | No | +`peerConnectionOptions` | [PeerConnection::Options\*](#PeerConnectionOptions) | PeerConnection options. `peerConnectionOptions.config` can be used as a counterpart for `iceServers`, `iceTransportPolicy` and `additionalSettings` parameters from TypeScript mediasoup-client implementation. | No | `appData` | nlohmann::json | Custom application data. | No | `{ }` @@ -177,7 +177,7 @@ Argument | Type | Description | Required | Default `iceParameters` | const nlohmann::json& [IceParameters](/documentation/v3/mediasoup/api/#WebRtcTransportIceParameters) | ICE parameters of the server side transport. | Yes | `iceCandidates` | const nlohmann::json& Array<[IceCandidate](/documentation/v3/mediasoup/api/#WebRtcTransportIceCandidate)> | ICE candidates of the server side transport. | Yes | `dtlsParameters` | const nlohmann::json& [DtlsParameters](/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters) | DTLS parameters of the server side transport. | Yes | -`peerConnectionOptions` | [PeerConnection::Options](#PeerConnectionOptions) | PeerConnection options. | No | +`peerConnectionOptions` | [PeerConnection::Options](#PeerConnectionOptions) | PeerConnection options. `peerConnectionOptions.config` can be used as a counterpart for `iceServers`, `iceTransportPolicy` and `additionalSettings` parameters from TypeScript mediasoup-client implementation. | No | `appData` | nlohmann::json | Custom application data. | No | `{ }`