AgoraChannelMediaRelayConfiguration Class Reference
Inherits from | NSObject |
---|---|
Declared in | AgoraObjects.h |
destinationInfos
目标频道信息 AgoraChannelMediaRelayInfo ,包含如下成员:
@property (strong, nonatomic, readonly) NSDictionary<NSString*AgoraChannelMediaRelayInfo*> *destinationInfos
Discussion
channelName
:目标频道的频道名。token
:能加入目标频道的token
。由你在destinationInfos
中设置的channelName
和uid
生成。- 如未启用 App Certificate,可直接将该参数设为默认值
nil
,表示 SDK 填充 App ID。 - 如已启用 App Certificate,则务必填入使用
channelName
和uid
生成的token
。
- 如未启用 App Certificate,可直接将该参数设为默认值
uid
:标识目标频道中的转发媒体流的 UID。取值范围为 0 到(232-1),请确保不要将该参数设为目标频道的主播的 UID,并与目标频道中的 所有 UID 都不同。默认值为 0,表示 SDK 随机分配一个 UID。
Declared In
AgoraObjects.h
sourceInfo
源频道信息 AgoraChannelMediaRelayInfo ,包含如下成员:
@property (strong, nonatomic) AgoraChannelMediaRelayInfo *sourceInfo
Discussion
channelName
:源频道名。默认值为nil
,表示 SDK 填充当前的频道名。token
:能加入源频道的token
。由你在sourceInfo
中设置的channelName
和uid
生成。- 如未启用 App Certificate,可直接将该参数设为默认值
nil
,表示 SDK 填充 App ID。 - 如已启用 App Certificate,则务必填入使用
channelName
和uid
生成的token
,且其中的uid
必须为 0。
- 如未启用 App Certificate,可直接将该参数设为默认值
uid
:标识源频道中的转发媒体流的 UID。默认值为 0,表示 SDK 随机分配一个uid
。请确保设为 0。
Declared In
AgoraObjects.h
– setDestinationInfo:forChannelName:
设置目标频道信息。
- (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName
Parameters
destinationInfo |
目标频道信息 AgoraChannelMediaRelayInfo ,包含如下成员:
|
---|---|
channelName |
目标频道名,该参数必填,且需与该方法 |
Return Value
- YES:方法调用成功。
- NO:方法调用失败。
Discussion
如果你想将流转发到多个目标频道,可以多次调用该方法,设置多个频道的 AgoraChannelMediaRelayInfo 。该方法支持最多设置 4 个目标频道。
Declared In
AgoraObjects.h
– removeDestinationInfoForChannelName:
删除目标频道。
- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName
Parameters
channelName |
想要删除的目标频道名。 |
---|
Return Value
- YES:方法调用成功。
- NO:方法调用失败。
Declared In
AgoraObjects.h