Documentation
All
Agora Web SDK API Reference
Hierarchy
- IChannelMediaRelayConfiguration
Index
Methods
addDestChannelInfo
-
Adds a destination channel.
To relay a media stream across multiple channels, call this method as many times (to a maximum of four).
const config = new ChannelMediaRelayConfiguration(); config.addDestChannelInfo({ channelName: "test2", token: "xxx", uid: 23456 }); config.addDestChannelInfo({ channelName: "test3", token: "xxx", uid: 23457 });Parameters
-
info: ChannelMediaRelayInfo
The information of the destination channel.
Returns void
-
removeDestChannelInfo
-
Removes the destination channel added through addDestChannelInfo.
Parameters
-
channelName: string
The name of the destination channel to be removed.
Returns void
-
setSrcChannelInfo
-
Sets the information of the source channel.
const config = new ChannelMediaRelayConfiguration(); config.setSrcChannelInfo({ channelName: "test", token: "xxx", uid: 123456 });Parameters
-
info: ChannelMediaRelayInfo
The information of the source channel.
Returns void
-
Configurations of the media stream relay.
Use this interface to set the media stream relay when calling startChannelMediaRelay or updateChannelMediaRelay.
const configuration = AgoraRTC.createChannelMediaRelayConfiguration(); configuration.setSrcChannelInfo({ channelName: "test", token: "xxx", uid: 12345 }); configuration.addDestChannelInfo({ channelName: "test2", token: "xxx", uid: 23456 });