GETICESERVERCONFIG()`¶

About GetIceServerConfig¶

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.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_channelarn` `TYPE /AWS1/KNGRESOURCEARN` `/AWS1/KNGRESOURCEARN`¶

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

Optional arguments:¶

`iv_clientid` `TYPE /AWS1/KNGCLIENTID` `/AWS1/KNGCLIENTID`¶

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

`iv_service` `TYPE /AWS1/KNGSERVICE` `/AWS1/KNGSERVICE`¶

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

`iv_username` `TYPE /AWS1/KNGUSERNAME` `/AWS1/KNGUSERNAME`¶

An optional user ID to be associated with the credentials.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_knggeticeservercfgrsp` `/AWS1/CL_KNGGETICESERVERCFGRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_kng~geticeserverconfig(
  iv_channelarn = |string|
  iv_clientid = |string|
  iv_service = |string|
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_iceserverlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      LOOP AT lo_row_1->get_uris( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_uri = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_username = lo_row_1->get_username( ).
      lv_password = lo_row_1->get_password( ).
      lv_ttl = lo_row_1->get_ttl( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_KNG=>GETICESERVERCONFIG()¶