Class ZegoRangeSceneInternalImpl

    • Field Detail

      • mUIHandler

        public static android.os.Handler mUIHandler
      • rangeSceneToHandleAndHandler

        public static java.util.concurrent.ConcurrentHashMap<ZegoRangeScene,​im.zego.zegoexpress.internal.ZegoRangeSceneInternalImpl.HandleAndHandler> rangeSceneToHandleAndHandler
    • Method Detail

      • destroyRangeSceneInstance

        public static void destroyRangeSceneInstance​(ZegoRangeScene rangeScene)
      • destroyAllRangeSceneInstance

        public static void destroyAllRangeSceneInstance()
      • getRangeSceneStream

        public ZegoRangeSceneStream getRangeSceneStream()
        Description copied from class: ZegoRangeScene
        Get a range scene stream instance. Available since: 3.0.0 Description: Get a range scene stream instance. Use case: Often used in meta world scenarios, users can use related functions by getting range scene stream instance objects. When to call: After creating the range scene via [createRangeScene], before destroying the range scene via [destroyRangeScene]. Restrictions: None.
        Specified by:
        getRangeSceneStream in class ZegoRangeScene
        Returns:
        range scene stream instance.
      • getRangeSceneTeam

        public ZegoRangeSceneTeam getRangeSceneTeam()
        Description copied from class: ZegoRangeScene
        Get a range scene team instance. Available since: 3.1.0 Description: Get a range scene team instance. Use case: Often used in meta world scenarios, users can use related functions by getting range scene team instance objects. When to call: After creating the range scene via [createRangeScene], before destroying the range scene via [destroyRangeScene]. Restrictions: None.
        Specified by:
        getRangeSceneTeam in class ZegoRangeScene
        Returns:
        range scene team instance.
      • getRangeSceneItem

        public ZegoRangeSceneItem getRangeSceneItem()
        Description copied from class: ZegoRangeScene
        Get a range scene item instance. Available since: 3.1.0 Description: Get a range scene item instance. Use case: Often used in meta world scenarios, users can use related functions by getting range scene item instance objects. When to call: After creating the range scene via [createRangeScene], before destroying the range scene via [destroyRangeScene]. Restrictions: None.
        Specified by:
        getRangeSceneItem in class ZegoRangeScene
        Returns:
        range scene item instance.
      • getRangeSceneHandle

        public int getRangeSceneHandle()
        Description copied from class: ZegoRangeScene
        Get range scene instance handle. Available since: 3.0.0 Description: Get range scene instance handle. Use case: Used to publish stream to the scene. When to call: After creating the range scene via [createRangeScene], before destroying the range scene via [destroyRangeScene]. Restrictions: None.
        Specified by:
        getRangeSceneHandle in class ZegoRangeScene
        Returns:
        Range scene instance handle.
      • setEventHandler

        public boolean setEventHandler​(IZegoRangeSceneEventHandler handler)
        Description copied from class: ZegoRangeScene
        set range scene event handler. Available since: 3.0.0 Description: Set the callback function of the range scene module. When to call: After creating the range scene via [createRangeScene], before destroying the range scene via [destroyRangeScene].
        Specified by:
        setEventHandler in class ZegoRangeScene
        Parameters:
        handler - The object used to receive range scene callbacks.
        Returns:
        The result of set range scene event handler, true: success, false: fail.
      • loginScene

        public void loginScene​(ZegoSceneParam config,
                               IZegoRangeSceneLoginSceneCallback callback)
        Description copied from class: ZegoRangeScene
        Logs in to a scene. Available: since 3.0.0 Description: SDK RangeScene uses the 'scene' to organize users. Use cases: Users interact in the RangeScene within the same scene. When to call: After creating the range scene via [createRangeScene], before destroying the range scene via [destroyRangeScene]. Caution: 1. Apps that use different appIDs cannot intercommunication with each other. 2. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems. Privacy reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc. Related callbacks: 1. When the user starts to log in to the scene, the scene is successfully logged in, or the scene fails to log in, the [onSceneStateUpdate] callback will be triggered to notify the developer of the status of the current user connected to the scene. 2. If the network is temporarily interrupted due to network quality reasons, the SDK will automatically reconnect internally. You can get the current connection status of the local scene by listening to the [onSceneStateUpdate] callback method. Related APIs: 1. Users can call [logoutScene] to log out.
        Specified by:
        loginScene in class ZegoRangeScene
        Parameters:
        config - Scene param.
        callback - The callback of login scene.
      • logoutScene

        public void logoutScene​(IZegoRangeSceneLogoutSceneCallback callback)
        Description copied from class: ZegoRangeScene
        Logs out of a scene. Available: since 3.0.0 Description: This API will log out the current user has logged in the scene. When to call: After successfully logging in to the scene, if the scene is no longer used, the user can call the function [logoutScene]. Restrictions: None. Caution: Exiting a scene stops all publishing and playing stream associated with the scene for that user. Related callbacks: After calling this function, you will receive [onSceneStateUpdate] callback notification successfully exits the scene. Related APIs: Users can use [loginScene] functions to log in scene.
        Specified by:
        logoutScene in class ZegoRangeScene
        Parameters:
        callback - The callback of logout scene.
      • updateUserStatus

        public int updateUserStatus​(ZegoPosition position,
                                    int channel,
                                    byte[] status)
        Description copied from class: ZegoRangeScene
        Update user status. Available: since 3.0.0 Description: Developers can call this function to update the user status. When to call: After [LoginScene], before [LogoutScene]. Restrictions: None. Caution: None.
        Specified by:
        updateUserStatus in class ZegoRangeScene
        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.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • updateUserCommand

        public int updateUserCommand​(ZegoPosition position,
                                     int channel,
                                     byte[] command)
        Description copied from class: ZegoRangeScene
        Update user status. Available: since 3.0.0 Description: Developers can call this function to update the user command. When to call: After [LoginScene], before [LogoutScene]. Restrictions: None. Caution: None.
        Specified by:
        updateUserCommand in class ZegoRangeScene
        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.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • updateUserPosition

        public int updateUserPosition​(ZegoPosition position)
        Description copied from class: ZegoRangeScene
        Update user position. Available: since 3.0.0 Description: Developers can call this function to update the user position. When to call: After [LoginScene], before [LogoutScene]. Restrictions: None. Caution: None.
        Specified by:
        updateUserPosition in class ZegoRangeScene
        Parameters:
        position - User's current location.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • getUserCount

        public void getUserCount​(IZegoRangeSceneGetUserCountCallback callback)
        Description copied from class: ZegoRangeScene
        Get user count in scene. Available: since 3.0.0 Description: Developers can call this function to get user count in scene. When to call: After [LoginScene], before [LogoutScene]. Default value: NULL. Restrictions: None. Caution: None.
        Specified by:
        getUserCount in class ZegoRangeScene
        Parameters:
        callback - The callback of get user count in scene.
      • getUserListInView

        public void getUserListInView​(IZegoRangeSceneGetUserListInViewCallback callback)
        Description copied from class: ZegoRangeScene
        Get user list in view. Available: since 3.0.0 Description: Developers can call this function to get user list in view. When to call: After [LoginScene], before [LogoutScene]. Default value: NULL. Restrictions: None. Caution: None.
        Specified by:
        getUserListInView in class ZegoRangeScene
        Parameters:
        callback - The callback of get user list in view.
      • sendCustomCommand

        public void sendCustomCommand​(byte[] command,
                                      IZegoRangeSceneSendCustomCommandCallback callback)
        Description copied from class: ZegoRangeScene
        Send custom command. Available: since 3.0.0 Description: Developers can call this function to send custom command. When to call: After [LoginScene], before [LogoutScene]. Default value: NULL. Restrictions: None. Caution: None.
        Specified by:
        sendCustomCommand in class ZegoRangeScene
        Parameters:
        command - Custom command.
        callback - The callback of send custom command.
      • renewToken

        public int renewToken​(java.lang.String token)
        Description copied from class: ZegoRangeScene
        Renew token. Available since: 3.1.0 Description: After the developer receives [onSceneTokenWillExpire], they can use this API to update the token to ensure that the subsequent RTC functions are normal. Use cases: Used when the token is about to expire. When to call /Trigger: After the developer receives [onSceneTokenWillExpire]. Restrictions: None.
        Specified by:
        renewToken in class ZegoRangeScene
        Parameters:
        token - The token that needs to be renew.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • setStreamConfig

        public int setStreamConfig​(ZegoSceneStreamConfig config)
        Description copied from class: ZegoRangeScene
        Set range scene stream config. Available: since 3.2.0 Description: Developers can call this function to set range scene stream config. When to call: After [createRangeScene]. Default value: NULL. Restrictions: None. Caution: None.
        Specified by:
        setStreamConfig in class ZegoRangeScene
        Parameters:
        config - Range scene stream config.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.