@detail api
@author chuzhongtao
@brief Enables/disables the range audio function.
Range audio means that within a certain range in a same RTC room, the audio volume of the remote user received by the local user will be amplified/attenuated as the remote user moves closer/away. The audio coming from out of the range cannot be heard. See updateReceiveRange:{@link #ByteRTCRangeAudio#updateReceiveRange} to set audio receiving range.
@param enable Whether to enable audio range function:
- YES: Enable
- NO: Disable(Defaulting setting)
@note You can call this API anytime before or after entering a room. To ensure a smooth switch to the range audio mode after entering the room, you need to call updatePosition:{@link #ByteRTCRangeAudio#updatePosition} before this API to set your own position coordinates, and then enable the range audio function.
@detail api
@author huangshouqin
@brief Set the volume attenuation mode of the range audio.
@param type Volume roll-off mode. It is linear roll-off mode by default. Refer to ByteRTCAttenuationType{@link #ByteRTCAttenuationType} for more details.
@param coefficient Coefficient for the exponential roll-off mode. The default value is 1. It ranges 0.1,100. We recommended to set it to 50. The volume roll-off speed gets faster as this value increases.
@return Result of the call
- 0: Success
- -1: Failure because of calling this API before the user has joined a room or before enabling the Range Audio feature by calling enableRangeAudio:{@link #ByteRTCRangeAudio#enableRangeAudio}.
@note Call updateReceiveRange:{@link #ByteRTCRangeAudio#updateReceiveRange} to set the range outside which the volume of the sound does not attenuate.
@detail api
@author chuzhongtao
@brief Set the flags to mark the user groups, within which the users talk without attenuation.
In the RTC room, if the flags of the users intersects with each other, the users talk without attenuation.
For example, the user is a member of multiple teams, and teammates of the same team talks without attentuation. You can set the flag for each team, and includes the flags of the user's teams in the user's flags.
@param flags Array of flags.
@detail api
@author chuzhongtao
@brief Updates the coordinate of the local user's position in the rectangular coordinate system in the current room.
@param pos 3D coordinate values, the default value is 0, 0, 0, see ByteRTCPosition{@link #ByteRTCPosition}.
@return API call result:
- 0: Success
- !0: Failure
@note After calling this API, you should call enableRangeAudio:{@link #ByteRTCRangeAudio#enableRangeAudio} to enable range audio function to actually enjoy the range audio effect.
@detail api
@author chuzhongtao
@brief Updates the audio receiving range for the local user.
@param range Audio receiving range, see ByteRTCReceiveRange{@link #ByteRTCReceiveRange}.
@return API call result:
- 0: Success
- !0: Failure