Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChannelMediaRelayConfiguration

The definition of ChannelMediaRelayConfiguration.

Hierarchy

  • ChannelMediaRelayConfiguration

Index

Constructors

Properties

Constructors

constructor

Properties

destCount

destCount: number

The number of destination channels. The default value is 0, and the value range is [0,4). Ensure that the value of this parameter corresponds to the number of ChannelMediaInfo structs you define in destInfos.

destInfos

destInfos: ChannelMediaInfo[]

The information of the destination channel: ChannelMediaInfo. It contains the following members:

  • channelName: The name of the destination channel.
  • uid: The unique ID to identify the relay stream in the destination channel. The value ranges from 0 to (232-1). To avoid UID conflicts, do not set this parameter as the uid of the host in the destination channel, and ensure that this uid is different from any other uid in the destination channel. The default value is 0, which means the SDK generates a random UID.
  • token: The token for joining the destination channel. It is generated with the channelName and uid you set in destInfos.
    • If you have not enabled the App Certificate, set this parameter as the default value null, which means the SDK applies the App ID.
    • If you have enabled the App Certificate, you must use the token generated with the channelName and uid.

srcInfo

The information of the source channel: ChannelMediaInfo. It contains the following members:

  • channelName: The name of the source channel. The default value is null, which means the SDK applies the name of the current channel.
  • uid: The unique ID to identify the relay stream in the source channel. The default value is 0, which means the SDK generates a random UID. You must set it as 0.
  • token: The token for joining the source channel. It is generated with the channelName and uid you set in srcInfo.
    • If you have not enabled the App Certificate, set this parameter as the default value null, which means the SDK applies the App ID.
    • If you have enabled the App Certificate, you must use the token generated with the channelName and uid, and the uid must be set as 0.

Generated using TypeDoc