Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelMediaRelayConfiguration

The configuration of the media stream relay.

Warning:

  • If you want to relay the media stream to multiple channels, define as many ChannelMediaInfo interface (at most four).

Hierarchy

  • ChannelMediaRelayConfiguration

Index

Properties

Properties

destInfos

destInfos: [ChannelMediaInfo]

The information of the destination channel. See ChannelMediaInfo

It contains the following properties:

  • channel: The name of the destination channel.
  • token:Token for joining the destination channel. It is generated with channel and uid you set in destInfos.
    • If you have not enabled the App Certificate, Token is unnecessary here and set it as the default value NULL, which means that the SDK passes in the APP ID.
    • If you have enabled the App Certificate, you must use Token.
  • uid: ID of the host in the destination channel. The value ranges from 0 to 232-1. To avoid UID conflicts, this uid must be different from any other UIDs in the destination channel. The default value is 0, which means the SDK randomly generates a UID.

srcInfo

srcInfo: ChannelMediaInfo

The information of the source channel. See ChannelMediaInfo

It contains the following properties:

  • Note:

    • If you have not enabled the App Certificate, Token is unnecessary here and set the following properties as the default value.
    • If you have enabled the App Certificate, you must use Token.

  • channel: The name of the source channel. The default value is NULL, which means that the SDK passes in the name of the current channel.

  • token: Token for joining the source channel. It is generated with channel and uid you set in srcInfo. The default value is NULL, which means that the SDK passes in the APP ID.

  • uid:

    • ID of the host whose media stream you want to relay. The default value is 0, which means that the SDK randomly generates a UID.
    • You must set it as 0.