Agora C++ API Reference for All Platforms

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

`#include <IAgoraRtcEngine.h>`

## Public Member Functions
| ExtensionInfo ()

## Public Attributes
agora::media::MEDIA_SOURCE_TYPE | mediaSourceType
uid_t | remoteUid
const char * | channelId
uid_t | localUid

## Detailed Description

The information for extension.

## Constructor & Destructor Documentation

## ◆ ExtensionInfo()

agora::rtc::ExtensionInfo::ExtensionInfo | ( |  | ) |
| inline

## Member Data Documentation

## ◆ mediaSourceType

agora::media::MEDIA_SOURCE_TYPE agora::rtc::ExtensionInfo::mediaSourceType

The type of media device.

## ◆ remoteUid

uid_t agora::rtc::ExtensionInfo::remoteUid

The id of the remote user on which the extension works.

Note
  remoteUid = 0 means that the extension works on all remote streams.

## ◆ channelId

const char* agora::rtc::ExtensionInfo::channelId

The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:

- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- The space character.
- Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".

## ◆ localUid

uid_t agora::rtc::ExtensionInfo::localUid

User ID: A 32-bit unsigned integer ranging from 1 to (2^32-1). It must be unique.