logo
On this page

ZegoRangeSceneItemEventHandler

ZegoRangeSceneItemEventHandler

Declared in ZegoExpressEventHandler.h

Methods

rangeScene:itemEnterView:capacity:position:userList

rangeScene:itemEnterView:capacity:position:userList
- (void)rangeScene:(ZegoRangeScene *)rangeScene itemEnterView:(long long)itemID capacity:(unsigned int)capacity position:(ZegoPosition *)position userList:(NSArray<NSString *> *)userList;
Callback notification when item enters the current user's field of view.
Declared in ZegoExpressEventHandler.h

Parameters

NameTypeDescription
rangeSceneZegoRangeScene *Range scene instance that triggers this callback.
itemIDlong longItem ID.
capacityunsigned intThe number of users allowed to bind the item.
positionZegoPosition *Item position.
userListNSArray<NSString *> *List of users the item is currently bound to.

Details

Callback notification when item enters the current user's field of view. When to trigger: Item enters the current user's field of view.

  • Restrictions: Do not call the SDK interface in the callback thread.

rangeScene:itemLeaveView

rangeScene:itemLeaveView
- (void)rangeScene:(ZegoRangeScene *)rangeScene itemLeaveView:(long long)itemID;
Callback notification when item leave the current user's field of view.
Declared in ZegoExpressEventHandler.h

Parameters

NameTypeDescription
rangeSceneZegoRangeScene *Range scene instance that triggers this callback.
itemIDlong longItem ID.

Details

Callback notification when item leave the current user's field of view. When to trigger: Item leave the current user's field of view.

  • Restrictions: Do not call the SDK interface in the callback thread.

rangeScene:itemBindUpdate:userID

rangeScene:itemBindUpdate:userID
- (void)rangeScene:(ZegoRangeScene *)rangeScene itemBindUpdate:(long long)itemID userID:(NSString *)userID;
Item binding user change callback notification.
Declared in ZegoExpressEventHandler.h

Parameters

NameTypeDescription
rangeSceneZegoRangeScene *Range scene instance that triggers this callback.
itemIDlong longItem ID.
userIDNSString *The user ID of the item binding.

Details

Item binding user change callback notification. When to trigger: Item binding user change.

  • Restrictions: Do not call the SDK interface in the callback thread.

rangeScene:itemUnbindUpdate:userList

rangeScene:itemUnbindUpdate:userList
- (void)rangeScene:(ZegoRangeScene *)rangeScene itemUnbindUpdate:(long long)itemID userList:(NSArray<NSString *> *)userList;
Item unbind user change callback notification.
Declared in ZegoExpressEventHandler.h

Parameters

NameTypeDescription
rangeSceneZegoRangeScene *Range scene instance that triggers this callback.
itemIDlong longItem ID.
userListNSArray<NSString *> *List of users the item unbind.

Details

Item unbind user change callback notification. When to trigger: Item unbind user change.

  • Restrictions: Do not call the SDK interface in the callback thread.

rangeScene:itemStatusUpdate:position:channel:status

rangeScene:itemStatusUpdate:position:channel:status
- (void)rangeScene:(ZegoRangeScene *)rangeScene itemStatusUpdate:(long long)itemID position:(ZegoPosition *)position channel:(unsigned int)channel status:(NSData *)status;
Item state update callback.
Declared in ZegoExpressEventHandler.h

Parameters

NameTypeDescription
rangeSceneZegoRangeScene *Range scene instance that triggers this callback.
itemIDlong longItem ID.
positionZegoPosition *Item's current position.
channelunsigned intThe channel to which the status belongs.
statusNSData *Current status data.

Details

Item state update callback. When to trigger: Item state update.

  • Caution: This callback is a high-frequency callback, please do not perform time-consuming operations in this callback.
  • Restrictions: Do not call the SDK interface in the callback thread.

rangeScene:itemCommandUpdate:position:channel:command

rangeScene:itemCommandUpdate:position:channel:command
- (void)rangeScene:(ZegoRangeScene *)rangeScene itemCommandUpdate:(long long)itemID position:(ZegoPosition *)position channel:(unsigned int)channel command:(NSData *)command;
Item command update callback.
Declared in ZegoExpressEventHandler.h

Parameters

NameTypeDescription
rangeSceneZegoRangeScene *Range scene instance that triggers this callback.
itemIDlong longItem ID.
positionZegoPosition *Item's current position.
channelunsigned intThe channel to which the command belongs.
commandNSData *Next command data.

Details

Item command update callback. When to trigger: Item command update.

  • Caution: This callback is a high-frequency callback, please do not perform time-consuming operations in this callback.
  • Restrictions: Do not call the SDK interface in the callback thread.

Previous

zegorangesceneitem

Next

zegorangescenestream

On this page

Back to top