ZegoRangeScene

Declared in ZegoExpressDefines.h

方法

getRangeSceneStream

- (ZegoRangeSceneStream *)getRangeSceneStream;

获取范围场景流管理实例对象。

Declared in ZegoExpressDefines.h

获取范围场景流管理实例对象。

业务场景：常用于虚拟世界场景中，用户可通过获取范围场景流管理实例对象使用相关功能。
调用时机：通过 [createRangeScene] 创建范围场景之后，通过 [destroyRangeScene] 销毁范围场景之前。

支持版本：3.0.0 及以上。
使用限制：无。

范围场景流管理实例。

getRangeSceneTeam

- (ZegoRangeSceneTeam *)getRangeSceneTeam;

获取范围场景小队管理实例对象。

Declared in ZegoExpressDefines.h

获取范围场景小队管理实例对象。

业务场景：常用于虚拟世界场景中，用户可通过获取范围场景小队管理实例对象使用相关功能。
调用时机：通过 [createRangeScene] 创建范围场景之后，通过 [destroyRangeScene] 销毁范围场景之前。

支持版本：3.1.0 及以上。
使用限制：无。

范围场景小队管理实例。

getRangeSceneItem

- (ZegoRangeSceneItem *)getRangeSceneItem;

获取范围场景物品管理实例对象。

Declared in ZegoExpressDefines.h

获取范围场景物品管理实例对象。

业务场景：常用于虚拟世界场景中，用户可通过获取范围场景物品管理实例对象使用相关功能。
调用时机：通过 [createRangeScene] 创建范围场景之后，通过 [destroyRangeScene] 销毁范围场景之前。

支持版本：3.1.0 及以上。
使用限制：无。

范围场景物品管理实例。

getRangeSceneHandle

- (int)getRangeSceneHandle;

获取范围场景实例句柄。

Declared in ZegoExpressDefines.h

获取范围场景实例句柄。

业务场景：用于推流到场景。
调用时机：通过 [createRangeScene] 创建范围场景之后，通过 [destroyRangeScene] 销毁范围场景之前。

支持版本：3.0.0 及以上。
使用限制：无。

范围场景实例句柄。

setEventHandler:

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

设置范围场景回调。

Declared in ZegoExpressDefines.h

参数

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

详情

设置范围场景模块回调。

调用时机：通过 [createRangeScene] 创建范围场景之后，通过 [destroyRangeScene] 销毁范围场景之前。

支持版本：3.0.0 及以上。

返回值

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

loginScene:callback:

- (int)loginScene:(ZegoSceneParam *) param callback:(nullable ZegoRangeSceneLoginSceneCallback) callback;

登录场景。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
param	ZegoSceneParam *	场景参数。
callback	nullable ZegoRangeSceneLoginSceneCallback	登录场景结果回调。

详情

SDK 范围场景功能用"场景"概念来组织用户。

业务场景：在同一个场景内用户在虚拟世界内互动。
调用时机：通过 [createRangeScene] 创建范围场景之后，通过 [destroyRangeScene] 销毁范围场景之前。
相关回调： 1. 当用户开始登录场景、登录场景成功或登录场景失败后，将会触发 [onSceneStateUpdate] 回调通知开发者当前用户连接场景的状态。 2. 如果由于网络质量原因导致网络临时中断，SDK 内部会自动进行重连。可通过监听 [onSceneStateUpdate] 回调获取本端当前场景连接状态的变化情况。
相关接口：1. 可调用 [logoutScene] 退出登录。

支持版本：3.0.0 及以上。
注意事项： 1. 使用不同 appID 的 App 不能互通。 2. 强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。隐私保护申明：请勿在此接口填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

返回值

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

logoutScene:

- (int)logoutScene:(nullable ZegoRangeSceneLogoutSceneCallback) callback;

退出场景。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
callback	nullable ZegoRangeSceneLogoutSceneCallback	退出场景结果回调。

详情

该接口会退出当前用户已登录的场景。

调用时机：登录场景成功后，若不再使用场景功能，用户可以调用函数 [logoutScene]。
相关回调：调用此函数后会收到 [onSceneStateUpdate] 回调通知成功退出场景。
相关接口：用户可以调用 [loginScene] 函数登录场景。

支持版本：3.0.0 及以上。
使用限制：无。
注意事项：退出场景会停止该用户与场景相关的所有推拉流。

返回值

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

updateUserStatus:channel:status:

- (int)updateUserStatus:(ZegoPosition *) position channel:(unsigned int) channel status:(NSData *) status;

更新用户的状态。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
position	ZegoPosition *	用户当前位置。
channel	unsigned int	状态所属通道，从0开始，不能超过最大通道号。
status	NSData *	用户当前状态数据。

详情

开发者可以调用该接口更新用户的状态。

调用时机：[LoginScene] 之后，[LogoutScene] 之前。

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

返回值

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

updateUserCommand:channel:command:

- (int)updateUserCommand:(ZegoPosition *) position channel:(unsigned int) channel command:(NSData *) command;

更新用户的指令。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
position	ZegoPosition *	用户当前位置。
channel	unsigned int	指令所属通道，从0开始，不能超过最大通道号。
command	NSData *	用户下一步命令数据。

详情

开发者可以调用该接口更新用户的指令。

调用时机：[LoginScene] 之后，[LogoutScene] 之前。

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

返回值

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

updateUserPosition:

- (int)updateUserPosition:(ZegoPosition *) position;

更新用户的位置。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
position	ZegoPosition *	用户当前位置。

详情

开发者可以调用该接口更新用户的位置。

调用时机：[LoginScene] 之后，[LogoutScene] 之前。

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

返回值

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

getUserCount:

- (int)getUserCount:(nullable ZegoRangeSceneGetUserCountCallback) callback;

获取场景内总人数。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
callback	nullable ZegoRangeSceneGetUserCountCallback	获取场景内总人数结果回调。

详情

开发者可以调用该接口获取场景内总人数。

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

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

返回值

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

getUserListInView:

- (int)getUserListInView:(nullable ZegoRangeSceneGetUserListInViewCallback) callback;

获取范围内用户列表。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
callback	nullable ZegoRangeSceneGetUserListInViewCallback	获取范围内用户列表结果回调。

详情

开发者可以调用该接口获取范围内用户列表。

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

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

返回值

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

sendCustomCommand:callback:

- (int)sendCustomCommand:(NSData *) command callback:(nullable ZegoRangeSceneSendCustomCommandCallback) callback;

发送用户自定义信令。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
command	NSData *	自定义信令。
callback	nullable ZegoRangeSceneSendCustomCommandCallback	发送用户自定义信令结果回调。

详情

开发者可以调用该接口发送用户自定义信令。

调用时机：[loginScene] 之后，[logoutScene] 之前。
默认值：nil。

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

返回值

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

renewToken:

- (int)renewToken:(NSString *) token;

更新 Token 鉴权信息。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
token	NSString *	需要更新的 Token。

详情

当开发者收到 [onSceneTokenWillExpire] 之后，可使用此 API 更新 Token 鉴权信息，保障后续 RTC 功能正常。

业务场景：Token 将要过期时使用。
调用时机：收到 [onSceneTokenWillExpire] 之后。

支持版本：3.1.0 及以上。
使用限制：无。

返回值

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

setStreamConfig:

- (int)setStreamConfig:(ZegoSceneStreamConfig *) config;

设置场景推拉流模式。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
config	ZegoSceneStreamConfig *	场景推拉流模式。

详情

开发者可以调用该接口设置场景推拉流模式。

调用时机：[createRangeScene] 之后。
默认值：nil。

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

返回值

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