ZegoRangeScene Class Reference
Inherits from | NSObject |
---|---|
Declared in | ZegoExpressDefines.h |
– getRangeSceneStream
range scene stream instance.
- (ZegoRangeSceneStream *)getRangeSceneStream
Return Value
range scene stream instance.
Declared In
ZegoExpressDefines.h
– getRangeSceneTeam
range scene team instance.
- (ZegoRangeSceneTeam *)getRangeSceneTeam
Return Value
range scene team instance.
Declared In
ZegoExpressDefines.h
– getRangeSceneItem
range scene item instance.
- (ZegoRangeSceneItem *)getRangeSceneItem
Return Value
range scene item instance.
Declared In
ZegoExpressDefines.h
– getRangeSceneHandle
Range scene instance handle.
- (int)getRangeSceneHandle
Return Value
Range scene instance handle.
Declared In
ZegoExpressDefines.h
– setEventHandler:
The object used to receive range scene callbacks.
- (BOOL)setEventHandler:(nullable id<ZegoRangeSceneEventHandler>)handler
Parameters
handler |
The object used to receive range scene callbacks. |
---|
Return Value
The result of set range scene event handler, YES: success, NO: fail.
Declared In
ZegoExpressDefines.h
– loginScene:callback:
Scene param.
- (void)loginScene:(ZegoSceneParam *)param callback:(nullable ZegoRangeSceneLoginSceneCallback)callback
Parameters
param |
Scene param. |
---|---|
callback |
The callback of login scene. |
Declared In
ZegoExpressDefines.h
– logoutScene:
The callback of logout scene.
- (void)logoutScene:(nullable ZegoRangeSceneLogoutSceneCallback)callback
Parameters
callback |
The callback of logout scene. |
---|
Declared In
ZegoExpressDefines.h
– updateUserStatus:channel:status:
User’s current location.
- (int)updateUserStatus:(ZegoPosition *)position channel:(unsigned int)channel status:(NSData *)status
Parameters
position |
User’s current location. |
---|---|
channel |
The channel to which the status belongs, starting from 0, cannot exceed the maximum channel number. |
status |
Current status data. |
Return Value
Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
Declared In
ZegoExpressDefines.h
– updateUserCommand:channel:command:
User’s current location.
- (int)updateUserCommand:(ZegoPosition *)position channel:(unsigned int)channel command:(NSData *)command
Parameters
position |
User’s current location. |
---|---|
channel |
The channel to which the command belongs, starting from 0, cannot exceed the maximum channel number. |
command |
Next command data. |
Return Value
Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
Declared In
ZegoExpressDefines.h
– updateUserPosition:
User’s current location.
- (int)updateUserPosition:(ZegoPosition *)position
Parameters
position |
User’s current location. |
---|
Return Value
Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
Declared In
ZegoExpressDefines.h
– getUserCount:
The callback of get user count in scene.
- (void)getUserCount:(nullable ZegoRangeSceneGetUserCountCallback)callback
Parameters
callback |
The callback of get user count in scene. |
---|
Declared In
ZegoExpressDefines.h
– getUserListInView:
The callback of get user list in view.
- (void)getUserListInView:(nullable ZegoRangeSceneGetUserListInViewCallback)callback
Parameters
callback |
The callback of get user list in view. |
---|
Declared In
ZegoExpressDefines.h
– sendCustomCommand:callback:
Custom command.
- (void)sendCustomCommand:(NSData *)command callback:(nullable ZegoRangeSceneSendCustomCommandCallback)callback
Parameters
command |
Custom command. |
---|---|
callback |
The callback of send custom command. |
Declared In
ZegoExpressDefines.h
– renewToken:
The token that needs to be renew.
- (int)renewToken:(NSString *)token
Parameters
token |
The token that needs to be renew. |
---|
Return Value
Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
Declared In
ZegoExpressDefines.h
– setStreamConfig:
Range scene stream config.
- (int)setStreamConfig:(ZegoSceneStreamConfig *)config
Parameters
config |
Range scene stream config. |
---|
Return Value
Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
Declared In
ZegoExpressDefines.h
+ new
Please use the [createRangeScene] function in ZegoExpressEngine class instead.
+ (instancetype)new
Declared In
ZegoExpressDefines.h
– init
Please use the [createRangeScene] function in ZegoExpressEngine class instead.
- (instancetype)init
Declared In
ZegoExpressDefines.h