Agora C++ API Reference for All Platforms
agora::rtc::ChannelMediaRelayConfiguration Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions

 ChannelMediaRelayConfiguration ()
 

Public Attributes

ChannelMediaInfosrcInfo
 
ChannelMediaInfodestInfos
 
int destCount
 

Detailed Description

The definition of ChannelMediaRelayConfiguration.

Constructor & Destructor Documentation

◆ ChannelMediaRelayConfiguration()

agora::rtc::ChannelMediaRelayConfiguration::ChannelMediaRelayConfiguration ( )
inline

Member Data Documentation

◆ srcInfo

ChannelMediaInfo* agora::rtc::ChannelMediaRelayConfiguration::srcInfo

Pointer to the information of the source channel: ChannelMediaInfo. It contains the following members:

  • channelName: The name of the source channel. The default value is NULL, which means the SDK applies the name of the current channel.
  • token: The token for joining the source channel. It is generated with the channelName and uid you set in srcInfo.
    • If you have not enabled the App Certificate, set this parameter as the default value NULL, which means the SDK applies the App ID.
    • If you have enabled the App Certificate, you must use the token generated with the channelName and uid, and the uid must be set as 0.
  • uid: The unique ID to identify the relay stream in the source channel. The default value is 0, which means the SDK generates a random UID. You must set it as 0.

◆ destInfos

ChannelMediaInfo* agora::rtc::ChannelMediaRelayConfiguration::destInfos

Pointer to the information of the destination channel: ChannelMediaInfo. It contains the following members:

  • channelName: The name of the destination channel.
  • token: The token for joining the destination channel. It is generated with the channelName and uid you set in destInfos.
    • If you have not enabled the App Certificate, set this parameter as the default value NULL, which means the SDK applies the App ID.
    • If you have enabled the App Certificate, you must use the token generated with the channelName and uid.
  • uid: The unique ID to identify the relay stream in the destination channel. The value ranges from 0 to (232-1). To avoid UID conflicts, this uid must be different from any other UIDs in the destination channel. The default value is 0, which means the SDK generates a random UID. Do not set this parameter as the uid of the host in the destination channel, and ensure that this uid is different from any other uid in the channel.

◆ destCount

int agora::rtc::ChannelMediaRelayConfiguration::destCount

The number of destination channels. The default value is 0, and the value range is [0,4]. Ensure that the value of this parameter corresponds to the number of ChannelMediaInfo structs you define in destInfos.