ZegoRangeSceneStream

Declared in ZegoExpressDefines.h

方法

setEventHandler:

- (BOOL)setEventHandler:(nullable id<ZegoRangeSceneStreamEventHandler>) handler;

设置范围场景流管理回调。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
handler	nullable id<ZegoRangeSceneStreamEventHandler>	用于接收范围场景流管理回调的对象。

详情

设置范围场景流管理模块回调。

调用时机：通过 [getRangeSceneStream] 获取范围场景流管理之后。

支持版本：3.0.0 及以上。

返回值

设置范围场景流管理回调结果。true: 成功, false: 失败。

setReceiveRange:

- (int)setReceiveRange:(float) range;

设置音视频流的接收范围。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
range	float	以本人为中心点的范围距离。

详情

该接口会设置音视频流的接收范围，ZEGO SDK 会主动拉取进去该范围的用户的流。

调用时机：[getRangeSceneStream] 之后。
默认值：接受范围的默认值是 0.0。

支持版本：3.0.0 及以上。
使用限制：无。
注意事项：无。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

setReceiveRangeWithParam:

- (int)setReceiveRangeWithParam:(ZegoReceiveRangeParam *) param;

设置音视频流的接收范围。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
param	ZegoReceiveRangeParam *	音频接受范围配置。

详情

该接口会设置音视频流的接收范围，ZEGO SDK 会主动拉取进去该范围的用户的流。

调用时机：[getRangeSceneStream] 之后。
默认值：接受范围的默认值是 0.0。

支持版本：3.7.0 及以上。
使用限制：无。
注意事项：无。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

enableRangeSpatializer:

- (int)enableRangeSpatializer:(BOOL) enable;

开启或关闭 3D 空间音效。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
enable	BOOL	true: 开启 3D 空间音效， false: 关闭 3D 空间音效。

详情

开启后，在世界内非小队成员的音频，会随与本人的距离、方向产生空间变化。

调用时机：[getRangeSceneStream] 之后。
默认值：Disable。

支持版本：3.0.0 及以上。
使用限制：使用 3D 空间音效需要使用媒体音量。
注意事项：无。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

mutePlayAudio:mute:

- (int)mutePlayAudio:(NSString *) userID mute:(BOOL) mute;

设置是否接收指定用户的音频数据。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
userID	NSString *	用户 ID。
mute	BOOL	true: 不接收用户的音频流，false: 接收用户的音频流。

详情

设置是否接收指定用户的音频数据。

调用时机：[LoginScene] 之后，[LogoutScene] 之前。
默认值：接收。

支持版本：3.0.0 及以上。
使用限制：无。
注意事项：无。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html

mutePlayVideo:mute:

- (int)mutePlayVideo:(NSString *) userID mute:(BOOL) mute;

设置是否接收指定用户的视频数据。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
userID	NSString *	用户 ID。
mute	BOOL	true: 不接收用户的视频流，false: 接收用户的视频流。

详情

开启后，在世界内非小队成员的音频，会随与本人的距离、方向产生空间变化。

调用时机：[LoginScene] 之后，[LogoutScene] 之前。
默认值：接收。

支持版本：3.0.0 及以上。
使用限制：无。
注意事项：无。

返回值

错误码，详情请参考常用错误码文档 https://doc-zh.zego.im/zh/4378.html