Dev Center
Voice Call
Agora.io Community
English
search-icon
Agora Java API Reference for Android
Overview RtcEngine IRtcEngineEventHandler Warning Codes Error Codes

Public Member Functions

 ChannelMediaRelayConfiguration ()
 
void setSrcChannelInfo (ChannelMediaInfo srcInfo)
 
void setDestChannelInfo (String channelName, ChannelMediaInfo destInfo)
 
void removeDestChannelInfo (String channelName)
 
ChannelMediaInfo getSrcChannelMediaInfo ()
 
Map< String, ChannelMediaInfo > getDestChannelMediaInfos ()
 

Detailed Description

Created by TongJiangyong on 31/01/2018. The ChannelMediaRelayConfiguration class.

Constructor & Destructor Documentation

◆ ChannelMediaRelayConfiguration()

io.agora.rtc.video.ChannelMediaRelayConfiguration.ChannelMediaRelayConfiguration ( )

The definition of ChannelMediaRelayConfiguration.

Since
v2.9.0.

The information of the destination channel: ChannelMediaInfo.

Note
uid: The user ID in the destination channel.

The information of the source channel: ChannelMediaInfo.

Note
  • uid: ID of the user whose media stream you want to relay. We recommend setting it as 0, which means that the SDK relays the media stream of the current broadcaster.
  • If you do not use a token, we recommend using the default values of the parameters in ChannelMediaInfo.
  • If you use a token, set uid as 0, and ensure that the token is generated with the uid set as 0.

Member Function Documentation

◆ setSrcChannelInfo()

void io.agora.rtc.video.ChannelMediaRelayConfiguration.setSrcChannelInfo ( ChannelMediaInfo  srcInfo)

Sets the information of the source channel.

Parameters
srcInfoThe information of the source channel: ChannelMediaInfo.

◆ setDestChannelInfo()

void io.agora.rtc.video.ChannelMediaRelayConfiguration.setDestChannelInfo ( String  channelName,
ChannelMediaInfo  destInfo 
)

Sets the information of the destination channel.

If you want to relay the media stream to multiple channels, call this method as many times (at most four).

Parameters
channelNameThe name of the destination channel. Ensure that the value of this parameter is the same as that of the channelName member in destInfo.
destInfoThe information of the destination channel: ChannelMediaInfo.

◆ removeDestChannelInfo()

void io.agora.rtc.video.ChannelMediaRelayConfiguration.removeDestChannelInfo ( String  channelName)

Removes the destination channel.

Parameters
channelNameThe name of the destination channel.
score