GameRTCEngineConfig

public class com.ss.video.rtc.engine.game.GameRTCEngineConfig

引擎配置信息

成员变量

类型 名称
String appId
String deviceId
RTCEnv rtcEnv
AudioPerfProfile audioPerfProfile

变量说明

appId

public String com.ss.video.rtc.engine.game.GameRTCEngineConfig.appId;

应用 ID。只有使用相同 appId 创建的 Engine 实例之间才能进行实时音视频通话

deviceId

public String com.ss.video.rtc.engine.game.GameRTCEngineConfig.deviceId;

设备 ID，用来唯一区分使用实时语音的设备

rtcEnv

public  RTCEnv com.ss.video.rtc.engine.game.GameRTCEngineConfig.rtcEnv;

指定服务的环境类型，参看 RTCEnv。

audioPerfProfile

public AudioPerfProfile com.ss.video.rtc.engine.game.GameRTCEngineConfig.audioPerfProfile;

音频处理策略等级，参看 AudioPerfProfile。

RTCEnv

public enum com.ss.video.rtc.engine.game.GameRTCEngineConfig.RTCEnv

RTC 服务环境类型

枚举值

类型 说明
PRODUCT(0) 生产环境，默认值。
BOE(1) 预发环境
TEST(2) 测试环境

AudioPerfProfile

public enum com.ss.video.rtc.engine.game.GameRTCEngineConfig.AudioPerfProfile

音频处理策略等级

枚举值

类型 说明
AUDIO_PERF_PROFILE_AUTO(0) 自动策略。默认值。根据应用所在机型等级，自动适配音频处理策略。
AUDIO_PERF_PROFILE_LOW(1) 低配策略。关闭 AEC、ANS、AGC 算法，音频采样率设置为 16000。
AUDIO_PERF_PROFILE_MID(2) 中配策略。开启 AEC、ANS、AGC 算法，音频采样率设置为 16000。
AUDIO_PERF_PROFILE_HIGH(3) 高配策略。开启 AEC、ANS、AGC 算法，音频采样率设置为 48000。

GameRTCPositionInfo

public class com.ss.video.rtc.engine.game.GameRTCPositionInfo

玩家位置信息

成员变量

类型 名称
int x
int y
int z

变量说明

x

public int com.ss.video.rtc.engine.game.GameRTCPositionInfo.x;

x 坐标

y

public int com.ss.video.rtc.engine.game.GameRTCPositionInfo.y;

y 坐标

z

public int com.ss.video.rtc.engine.game.GameRTCPositionInfo.z;

z 坐标

GameRTCReceiveRange

public class com.ss.video.rtc.engine.game.GameRTCReceiveRange

使用范围语音功能时，语音的接收范围

成员变量

类型 名称
int min
int max

变量说明

min

public int com.ss.video.rtc.engine.game.GameRTCReceiveRange.min;

收听声音无衰减的最小范围值。
当收听者和声源距离小于 min 的时候，收听到的声音完全无衰减。

max

public int com.ss.video.rtc.engine.game.GameRTCReceiveRange.max;

能够收听到声音的最大范围。
当收听者和声源距离大于 max 的时候，无法收听到声音。
当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离有衰减。

GameRTCRoomConfig

public class com.ss.video.rtc.engine.game.GameRTCRoomConfig

房间配置信息

成员变量

类型 名称
boolean enableRangeAudio
int audioVolumeIndicationInterval
RoomType roomType

变量说明

enableRangeAudio

public boolean com.ss.video.rtc.engine.game.GameRTCRoomConfig.enableRangeAudio;

设置是否开启范围语音

audioVolumeIndicationInterval

public int com.ss.video.rtc.engine.game.GameRTCRoomConfig.audioVolumeIndicationInterval;

收到音量提示回调的时间间隔：

  • ≤ 0：禁用音量提示功能。
  • > 0：启用音量提示功能，并设置收到音量提示回调的时间间隔。单位为毫秒。

    • 建议设置为大于等于 2000 毫秒；小于 10 毫秒时，行为未定义。

    roomType

    public RoomType  com.ss.video.rtc.engine.game.GameRTCRoomConfig.roomType;

    房间类型

    RoomType

    public enum com.ss.video.rtc.engine.game.GameRTCRoomConfig.RoomType

    房间类型

    枚举值

    类型 说明
    RTC_ROOM_TEAM(0) 小队房间。默认值。

    进入同一小队房间的成员是队友关系。
    进入小队房间后，打开麦克风可以向房间内所有队友讲话；打开扬声器就可以收听房间内所有队友讲话。
    RTC_ROOM_WORLD(1) 世界房间。

    你需要判断进入同一房间的成员是否为队友关系，进而决定收听逻辑。

    成员函数

    返回 名称
    int value

    函数说明

    value

    public int com.ss.video.rtc.engine.game.GameRTCRoomConfig.RoomType.value()

    获取当前值

    返回值 当前值

    AudioVolumeInfo

    public static class com.ss.video.rtc.engine.handler.IGameRTCEventHandler.AudioVolumeInfo

    声音音量信息。包含每个说话者的用户 id 和音量信息

    成员变量

    类型 名称
    String userId
    int volume

    变量说明

    userId

    public String com.ss.video.rtc.engine.handler.IGameRTCEventHandler.AudioVolumeInfo.userId;

    说话者的用户 id

    volume

    public int com.ss.video.rtc.engine.handler.IGameRTCEventHandler.AudioVolumeInfo.volume;

    说话者的音量，范围为 0（最低）- 255（最高）

    AudioVolumeInfoArray

    public static class com.ss.video.rtc.engine.handler.IGameRTCEventHandler.AudioVolumeInfoArray

    音频流来源的用户 ID, 及对应的音量。

    成员变量

    类型 名称
    String[] userNames
    int[] volumes

    变量说明

    userNames

    public String[] com.ss.video.rtc.engine.handler.IGameRTCEventHandler.AudioVolumeInfoArray.userNames;

    音频流来源的用户 ID

    volumes

    public int[] com.ss.video.rtc.engine.handler.IGameRTCEventHandler.AudioVolumeInfoArray.volumes;

    音量，取值范围是：[0,255]

    ConnectionState

    public enum com.ss.video.rtc.engine.handler.IGameRTCEventHandler.ConnectionState

    用户与 RTC 服务器的连接状态

    枚举值

    类型 说明
    INVALID(-1) 未知状态。
    DISCONNECTED(0) 连接断开。
    CONNECTING(1) 首次连接，正在连接中。
    CONNECTED(2) 首次连接成功。
    RECONNECTING(3) 连接断开后，重新连接中。
    RECONNECTED(4) 连接断开后，重连成功。

    UserLeaveReasonType

    public enum com.ss.video.rtc.engine.handler.IGameRTCEventHandler.UserLeaveReasonType

    用户离开房间的原因

    枚举值

    类型 说明
    INVALID(-1) 无效值
    QUIT(0) 用户主动离开，即调用 leaveRoom 方法退出房间
    DROPPED(1) 用户掉线。用户因为网络等原因掉线

    NetworkQuality

    public enum com.ss.video.rtc.engine.handler.IGameRTCEventHandler.NetworkQuality

    用户的媒体流网络上下行质量

    枚举值

    类型 说明
    QUALITY_INVALID(-1) 质量未知。
    QUALITY_UNKNOWN(0) 质量未知。
    QUALITY_EXCELLENT(1) 质量极好。
    QUALITY_GOOD(2) 用户主观感觉和极好差不多，但码率可能略低于极好。
    QUALITY_POOR(3) 用户主观感受有瑕疵但不影响沟通。
    QUALITY_BAD(4) 勉强能沟通但不顺畅。
    QUALITY_VBAD(5) 网络质量非常差，基本不能沟通。