Interface IChannelMediaRelayConfiguration
- React
更新时间不可用
跨频道媒体流转发的配置。
在调用 startChannelMediaRelay 和 updateChannelMediaRelay 时，通过该接口设置跨频道媒体流转发的具体信息。
const configuration = AgoraRTC.createChannelMediaRelayConfiguration();
configuration.setSrcChannelInfo({ channelName: "test", token: "xxx", uid: 12345 });
configuration.addDestChannelInfo({ channelName: "test2", token: "xxx", uid: 23456 });Methods
addDestChannelInfo
addDestChannelInfo(info: ChannelMediaRelayInfo): void添加目标频道信息。
如果你想将流转发到多个目标频道，可以多次调用该方法。该方法支持最多设置 4 个目标频道。
const config = AgoraRTC.createChannelMediaRelayConfiguration();
config.addDestChannelInfo({ channelName: "test2", token: "xxx", uid: 23456 });
config.addDestChannelInfo({ channelName: "test3", token: "xxx", uid: 23457 });| 参数名 | 描述 |
|---|---|
required | 频道信息，详见 ChannelMediaRelayInfo。 |
| 返回类型 | 描述 |
|---|---|
void |
removeDestChannelInfo
removeDestChannelInfo(channelName: string): void删除通过 addDestChannelInfo 添加的目标频道。
| 参数名 | 描述 |
|---|---|
channelNamestring | 待删除的目标频道名。 |
| 返回类型 | 描述 |
|---|---|
void |
setSrcChannelInfo
setSrcChannelInfo(info: ChannelMediaRelayInfo): void设置源频道信息。
const config = AgoraRTC.createChannelMediaRelayConfiguration();
config.setSrcChannelInfo({ channelName: "test", token: "xxx", uid: 123456 });| 参数名 | 描述 |
|---|---|
required | 频道信息，详见 ChannelMediaRelayInfo。 |
| 返回类型 | 描述 |
|---|---|
void |