Agora Web SDK API Reference

Overview AgoraRTC AgoraRTCClient LocalTrack RemoteTrack Error codes

Channel information in the media relay, used in ChannelMediaRelayConfiguration.

Hierarchy

ChannelMediaRelayInfo

Index

Properties

channelName

channelName: string

The channel name.

Optional token

token: undefined | string

The token generated with the channelName and uid. Do not set this parameter if you have not enabled token. The token for authentication. Do not set this parameter if you have not enabled token authentication.

When you set the information of the source channel, the token is generated with 0 and the source channel name.
When you set the information of the destination channel, the token is generated with uid and the destination channel name.

uid

uid: number

The unique ID to identify the relay stream.

A 32-bit unsigned integer with a value ranging from 0 to (2³²-1). If you set it as 0, the server assigns a random one.

When used for the source channel, it is the ID to identify the relay stream in the source channel.

When used for the destination channel, it is the ID to identify the relay stream in the destination channel. To avoid UID conflicts, this value must be different from any other user IDs in the destination channel.

When you set the information of the source channel, set uid as the ID of the host whose stream is relayed.
When you set the information of the destination channel, you can set uid as 0 (the server assigns a random one) or a 32-bit unsigned integer with a value ranging from 0 to (2³²-1). To avoid UID conflicts, this value must be different from any other user IDs in the destination channel.