Agora C++ API Reference for All Platforms

Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
agora::rtc::EchoTestConfiguration Struct Reference

`#include <AgoraBase.h>`

## Public Member Functions
| EchoTestConfiguration (view_t v, bool ea, bool ev, const char *t, const char *c, const int is)
| EchoTestConfiguration ()

## Public Attributes
view_t | view
bool | enableAudio
bool | enableVideo
const char * | token
const char * | channelId
int | intervalInSeconds

## Constructor & Destructor Documentation

## ◆ EchoTestConfiguration() [1/2]

agora::rtc::EchoTestConfiguration::EchoTestConfiguration | ( | view_t | v,
|  | bool | ea,
|  | bool | ev,
|  | const char * | t,
|  | const char * | c,
|  | const int | is )
| inline

## ◆ EchoTestConfiguration() [2/2]

agora::rtc::EchoTestConfiguration::EchoTestConfiguration | ( |  | ) |
| inline

## Member Data Documentation

## ◆ view

view_t agora::rtc::EchoTestConfiguration::view

The view used to render the local user's video. This parameter is only applicable to scenarios testing video devices, that is, when `enableVideo` is true.

## ◆ enableAudio

bool agora::rtc::EchoTestConfiguration::enableAudio

Whether to enable the audio device for the loop test:

- `true`: (Default) Enable the audio device. To test the audio device, set this parameter as true.
- `false`: Disable the audio device.

## ◆ enableVideo

bool agora::rtc::EchoTestConfiguration::enableVideo

Whether to enable the video device for the loop test:

- `true`: (Default) Enable the video device. To test the video device, set this parameter as true.
- `false`: Disable the video device.

## ◆ token

const char* agora::rtc::EchoTestConfiguration::token

The token used to secure the audio and video call loop test. If you do not enable App Certificate in Agora Console, you do not need to pass a value in this parameter; if you have enabled App Certificate in Agora Console, you must pass a token in this parameter; the `uid` used when you generate the token must be 0xFFFFFFFF, and the channel name used must be the channel name that identifies each audio and video call loop tested. For server-side token generation, see .

## ◆ channelId

const char* agora::rtc::EchoTestConfiguration::channelId

The channel name that identifies each audio and video call loop. To ensure proper loop test functionality, the channel name passed in to identify each loop test cannot be the same when users of the same project (App ID) perform audio and video call loop tests on different devices.

## ◆ intervalInSeconds

int agora::rtc::EchoTestConfiguration::intervalInSeconds

Set the time interval or delay for returning the results of the audio and video loop test. The value range is [2,10], in seconds, with the default value being 2 seconds.

- For audio loop tests, the test results will be returned according to the time interval you set.
- For video loop tests, the video will be displayed in a short time, after which the delay will gradually increase until it reaches the delay you set.