Agora C++ API Reference for All Platforms

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

`#include <NGIAgoraDataChannel.h>`

## Public Member Functions
| DataChannelConfig ()

## Public Attributes
bool | syncWithMedia
bool | ordered
int | compressionLength
Optional< int > | channelId
int32_t | priority

## Detailed Description

The definition of the DataChannelConfig struct.

## Constructor & Destructor Documentation

## ◆ DataChannelConfig()

agora::DataChannelConfig::DataChannelConfig | ( |  | ) |
| inline

## Member Data Documentation

## ◆ syncWithMedia

bool agora::DataChannelConfig::syncWithMedia

Whether this channel should sync with media stream:

- true: sync .
- false: not sync.

## ◆ ordered

bool agora::DataChannelConfig::ordered

Whether this channel should ensure oredered message:

- true: orderd .
- false: not orderd.

## ◆ compressionLength

int agora::DataChannelConfig::compressionLength

Whether this channel should compress the data packet:

- <= 0: We dont compress the data packet
- > 0: Once the packet length exceeds the compressionLength, we compress it.

## ◆ channelId

Optional<int> agora::DataChannelConfig::channelId

## ◆ priority

int32_t agora::DataChannelConfig::priority

The priority