

语音通话 (Legacy)

Console 官网社区技术支持





Agora Web API Reference

概览 AgoraRTC Client Stream Error Codes Warning Codes

跨频道媒体流转发的配置。

自从
3.0.0

在调用 startChannelMediaRelay 和 updateChannelMediaRelay 时，通过该接口设置跨频道媒体流转发的具体信息。

Hierarchy

ChannelMediaRelayConfiguration

Index

Methods

Methods

removeDestChannelInfo

removeDestChannelInfo(channelName: string): void

- Defined in index.d.ts:4215
删除目标频道
example
示例代码
```
configuration.removeDestChannelInfo("cname")
```
Parameters
- channelName: string
  
  想要删除的目标频道名。
Returns void

setDestChannelInfo

setDestChannelInfo(channelName: string, destInfo: any): void

- Defined in index.d.ts:4205
设置目标频道信息

如果你想将流转发到多个目标频道，可以多次调用该方法。该方法支持最多设置 4 个目标频道。
example
示例代码
```
var configuration = new AgoraRTC.ChannelMediaRelayConfiguration();
configuration.setDestChannelInfo("cname", {
 channelName: "destChannel",
 uid: 123,
 token: "yourDestToken",
});
```
Parameters
- channelName: string
  
  目标频道名，该参数必须与 destInfo 参数中的 channelName 一致。
- destInfo: any
  目标频道信息，包含以下参数：
  - channelName：String 类型，目标频道名。
  - uid：Number 类型，32 位无符号整数。用于标识目标频道中的转发媒体流的 UID，需确保与目标频道中的其他用户 ID 不同，防止造成互踢，设置范围：0 到 (2³²-1)，设为 0 服务器会自动分配一个 UID。
  - token：String 类型，用上面设置的频道名和 uid 生成的 token。如果未启用 token 则无需设置。
Returns void

setSrcChannelInfo

setSrcChannelInfo(srcInfo: any): void

- Defined in index.d.ts:4182
设置源频道信息
example
示例代码
```
var configuration = new AgoraRTC.ChannelMediaRelayConfiguration();
configuration.setSrcChannelInfo({
 channelName: "srcChannel",
 uid: 123,
 token: "yourSrcToken",
});
```
Parameters
- srcInfo: any
  源频道信息，包含以下参数：
  - channelName：String 类型，源频道的频道名。
  - uid：Number 类型，32 位无符号整数。用于标识源频道中的转发媒体流的 UID，不可与当前主播的 UID 相同，设置范围：0 到 (2³²-1)，设为 0 服务器会自动分配一个 UID。
  - token：String 类型，用上面设置的频道名和 uid 生成的 token。如果未启用 token 则无需设置。
Returns void