Package im.zego.zegoexpress
Class ZegoRangeSceneStream
- java.lang.Object
-
- im.zego.zegoexpress.ZegoRangeSceneStream
-
- Direct Known Subclasses:
ZegoRangeSceneStreamInternalImpl
public abstract class ZegoRangeSceneStream extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description ZegoRangeSceneStream()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract int
enableRangeSpatializer(boolean enable)
Turn 3D spatial sound on or off.abstract int
mutePlayAudio(java.lang.String userID, boolean mute)
Set whether to receive the audio data of the specified user.abstract int
mutePlayVideo(java.lang.String userID, boolean mute)
Set whether to receive the video data of the specified user.abstract boolean
setEventHandler(IZegoRangeSceneStreamEventHandler handler)
set range scene stream event handler.abstract int
setReceiveRange(float range)
Set the receiving range of audio and video streams.abstract int
setReceiveRange(ZegoReceiveRangeParam param)
Set the receiving range of audio and video streams.
-
-
-
Method Detail
-
setEventHandler
public abstract boolean setEventHandler(IZegoRangeSceneStreamEventHandler handler)
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].- 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 abstract int setReceiveRange(float range)
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.- 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 abstract int setReceiveRange(ZegoReceiveRangeParam param)
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.- 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 abstract int enableRangeSpatializer(boolean enable)
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.- 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 abstract int mutePlayAudio(java.lang.String userID, boolean mute)
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.- 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 abstract int mutePlayVideo(java.lang.String userID, boolean mute)
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.- 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.
-
-