AgoraChannelMediaRelayConfiguration 类

Inherits from NSObject
Declared in AgoraObjects.h

概览

AgoraChannelMediaRelayConfiguration 类定义

  destinationInfos

目标频道信息 AgoraChannelMediaRelayInfo ，包含如下成员：

@property (strong, nonatomic, readonly) NSDictionary<NSString*AgoraChannelMediaRelayInfo*> *destinationInfos

详情

  • channelName：目标频道的频道名。
  • uid：标识转发流到目标频道的主播 ID。取值范围为 0 到（232-1），请确保与目标频道中的所有 UID 不同。默认值为 0，表示 SDK 随机分配一个 UID。

  • token：能加入目标频道的 token。由你在 destinationInfos 中设置的 channelName 和 uid 生成。

    • 如未启用 App Certificate，可直接将该参数设为默认值 nil，表示 SDK 填充 App ID。
    • 如已启用 App Certificate，则务必填入使用 channelName 和 uid 生成的 token。

Declared In

AgoraObjects.h

  sourceInfo

源频道信息 AgoraChannelMediaRelayInfo ，包含如下成员：

@property (strong, nonatomic) AgoraChannelMediaRelayInfo *sourceInfo

详情

  • channelName：源频道名。默认值为 nil，表示 SDK 填充当前的频道名。
  • uid：标识源频道中想要转发流的主播 ID。默认值为 0，表示 SDK 随机分配一个 uid。请确保设为 0。

  • token：能加入源频道的 token。由你在 sourceInfo 中设置的 channelName 和 uid 生成。

    • 如未启用 App Certificate，可直接将该参数设为默认值 nil，表示 SDK 填充 App ID。
    • 如已启用 App Certificate，则务必填入使用 channelName 和 uid 生成的 token，且其中的 uid 必须为 0。

Declared In

AgoraObjects.h

– setDestinationInfo:forChannelName:

设置目标频道信息。

- (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName

参数

destinationInfo

目标频道信息 AgoraChannelMediaRelayInfo ，包含如下成员：

  • channelName：目标频道的频道名。
  • uid：标识转发流到目标频道的主播 ID。取值范围为 0 到（232-1），请确保与目标频道中的所有 UID 不同。默认值为 0，表示 SDK 随机分配一个 UID。

  • token：能加入目标频道的 token。由你在 destinationInfo 中设置的 channelName 和 uid 生成。

    • 如未启用 App Certificate，可直接将该参数设为默认值 nil，表示 SDK 填充 App ID。
    • 如已启用 App Certificate，则务必填入使用 channelName 和 uid 生成的 token。
channelName

目标频道名，该参数必填，且需与该方法 destinationInfo 参数中的 channelName 一致。

返回

  • YES：方法调用成功。
  • NO：方法调用失败。

详情

如果你想将流转发到多个目标频道，可以多次调用该方法，设置多个频道的 AgoraChannelMediaRelayInfo 。该方法支持最多设置 4 个目标频道。

Declared In

AgoraObjects.h

– removeDestinationInfoForChannelName:

删除目标频道。

- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName

参数

channelName

想要删除的目标频道名。

返回

  • YES：方法调用成功。
  • NO：方法调用失败。

Declared In

AgoraObjects.h