Class ZegoRangeSceneStreamInternalImpl

    • Method Detail

      • setEventHandler

        public boolean setEventHandler​(IZegoRangeSceneStreamEventHandler handler)
        Description copied from class: ZegoRangeSceneStream
        set range scene stream event handler. Available since: 3.0.0 Description: Set the callback function of the range scene stream module. When to call: After getting range scene stream instance by [getRangeSceneStream].
        Specified by:
        setEventHandler in class ZegoRangeSceneStream
        Parameters:
        handler - The object used to receive range scene stream callbacks.
        Returns:
        The result of set range scene stream event handler, true: success, false: fail.
      • setReceiveRange

        public int setReceiveRange​(float range)
        Description copied from class: ZegoRangeSceneStream
        Set the receiving range of audio and video streams. Available: since 3.0.0 Description: This interface will set the receiving range of audio and video streams, and ZEGO SDK will actively playing the streams of users in this range. When to call: After [getRangeSceneStream]. Default value: The default value of receive range is 0.0 . Restrictions: None. Caution: None.
        Specified by:
        setReceiveRange in class ZegoRangeSceneStream
        Parameters:
        range - The range distance from the center point of the person.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • setReceiveRange

        public int setReceiveRange​(ZegoReceiveRangeParam param)
        Description copied from class: ZegoRangeSceneStream
        Set the receiving range of audio and video streams. Available: since 3.7.0 Description: This interface will set the receiving range of audio and video streams, and ZEGO SDK will actively playing the streams of users in this range. When to call: After [getRangeSceneStream]. Default value: The default value of receive range is 0.0 . Restrictions: None. Caution: None.
        Specified by:
        setReceiveRange in class ZegoRangeSceneStream
        Parameters:
        param - The configuration of audio receiving range.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • enableRangeSpatializer

        public int enableRangeSpatializer​(boolean enable)
        Description copied from class: ZegoRangeSceneStream
        Turn 3D spatial sound on or off. Available: since 3.0.0 Description: After it is turned on, the audio of non-team members in the world will change spatially with the distance and direction from the person. When to call: After [getRangeSceneStream]. Default value: Disable. Restrictions: Media volume is required to use 3D spatial sound. Caution: None.
        Specified by:
        enableRangeSpatializer in class ZegoRangeSceneStream
        Parameters:
        enable - Whether to turn 3D spatial sound on, true: enable, false: disable.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • mutePlayAudio

        public int mutePlayAudio​(java.lang.String userID,
                                 boolean mute)
        Description copied from class: ZegoRangeSceneStream
        Set whether to receive the audio data of the specified user. Available: since 3.0.0 Description: Set whether to receive the audio data of the specified user. When to call: After [LoginScene], before [LogoutScene]. Default value: Receive. Restrictions: None. Caution: None.
        Specified by:
        mutePlayAudio in class ZegoRangeSceneStream
        Parameters:
        userID - User ID.
        mute - true: do not receive the user's audio stream, false: receive the user's audio stream.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.
      • mutePlayVideo

        public int mutePlayVideo​(java.lang.String userID,
                                 boolean mute)
        Description copied from class: ZegoRangeSceneStream
        Set whether to receive the video data of the specified user. Available: since 3.0.0 Description: After it is turned on, the audio of non-team members in the world will change spatially with the distance and direction from the person. When to call: After [LoginScene], before [LogoutScene]. Default value: Receive. Restrictions: None. Caution: None.
        Specified by:
        mutePlayVideo in class ZegoRangeSceneStream
        Parameters:
        userID - User ID.
        mute - true: do not receive the user's video stream, false: receive the user's video stream.
        Returns:
        Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.