IRangeAudio class

Inheritance
  • Object
  • PackClass
  • IRangeAudio
Implementers

Constructors

IRangeAudio()

Properties

$instance → dynamic
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

$createInstance(List args) → dynamic
Factory method for creating instances
override
$destroy() → void
inherited
$init(List args) → void
inherited
enableRangeAudio(bool enable) Future
@detail api @author chuzhongtao @brief Enable/disable 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 #IRangeAudio#updateReceiveRange} to set audio receiving range. @param enable Whether to enable audio range function:
- true: Enable - false: 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 #IRangeAudio#updatePosition} before this API to set your own position coordinates, and then enable the range audio function.
findOverrideIndices(List args, List<List<int>> indicesList) List<int>
查找重载参数下标列表 @desc android 构造函数存在重载 此方法通过实际传入参数与构造函数参数列表集合的比对,来获取当前实际的需要使用的参数列表
inherited
fn2AndroidClass(Function callback, dynamic nativeClass(), String methodName) → dynamic
与 ts runtime 中的 fn2AndroidClass 功能一致 将 Dart 函数转换为 Android 回调类实例供 Android 侧使用
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setAttenuationModel(AttenuationType type, float coefficient) Future<int?>
@detail api @author huangshouqin @brief Set the volume roll-off mode that a 3D sound has in an audio source when using the Range Audio feature. @param type Volume roll-off mode. It is linear roll-off mode by default. Refer to AttenuationType{@link #AttenuationType} 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 #IRangeAudio#enableRangeAudio}. @note Call updateReceiveRange{@link #IRangeAudio#updateReceiveRange} to set the range outside which the volume of the sound does not attenuate.
setNoAttenuationFlags(List<String> flags) Future
@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.
toString() String
A string representation of this object.
inherited
transformToPlatformConstructorArgs(List args, List<int> indices, Map<String, dynamic> typeMap, Map<String, dynamic> enumMap, Map<String, dynamic> classMap, String platformVar) List
实例化参数处理 将 pack 过后的 enum / class 转成 android / ios 平台侧的 enum / class
inherited
updateInstance(dynamic instance) → void
inherited
updatePosition(Position pos) Future<int?>
@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 Position{@link #Position}. @return API call result:
- 0: Success - !0: Failure @note - After calling this API, you should call enableRangeAudio{@link #IRangeAudio#enableRangeAudio} to enable range audio function to actually enjoy the range audio effect.
updateReceiveRange(ReceiveRange range) Future<int?>
@detail api @author chuzhongtao @brief Updates the audio receiving range for the local user. @param range Audio receiving range, see ReceiveRange{@link #ReceiveRange}. @return API call result:
- 0: Success - !0: Failure

Operators

operator ==(Object other) bool
The equality operator.
inherited