getIceServerConfig method

Future<GetIceServerConfigResponse> getIceServerConfig({ required String channelARN, String? clientId, Service? service, String? username, })

Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server.

TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services.

You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API.

May throw InvalidClientException. May throw SessionExpiredException. May throw ClientLimitExceededException. May throw ResourceNotFoundException. May throw InvalidArgumentException. May throw NotAuthorizedException.

Parameter channelARN : The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

Parameter clientId : Unique identifier for the viewer. Must be unique within the signaling channel.

Parameter service : Specifies the desired service. Currently, TURN is the only valid value.

Parameter username : An optional user ID to be associated with the credentials.

Implementation

Future<GetIceServerConfigResponse> getIceServerConfig({
  required String channelARN,
  String? clientId,
  Service? service,
  String? username,
}) async {
  ArgumentError.checkNotNull(channelARN, 'channelARN');
  _s.validateStringLength(
    'channelARN',
    channelARN,
    1,
    1024,
    isRequired: true,
  );
  _s.validateStringLength(
    'clientId',
    clientId,
    1,
    256,
  );
  _s.validateStringLength(
    'username',
    username,
    1,
    256,
  );
  final $payload = <String, dynamic>{
    'ChannelARN': channelARN,
    if (clientId != null) 'ClientId': clientId,
    if (service != null) 'Service': service.toValue(),
    if (username != null) 'Username': username,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v1/get-ice-server-config',
    exceptionFnMap: _exceptionFns,
  );
  return GetIceServerConfigResponse.fromJson(response);
}