GameRTCEngineConfig

public struct GameRTC.GameRTCEngineConfig

引擎相关配置信息

Defined in : IGameRTCService.cs

成员变量

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

GameRTCEngineParams

public struct GameRTC.GameRTCEngineParams

GameRTC 引擎初始化参数

Defined in : IGameRTCService.cs

成员变量

类型	名称
AreaCode	区域码，对于有海外合规要求的游戏，需要设置为 1；对于没有合规要求的游戏，设置为 0。
AppID	应用 ID。只有使用相同 appId 创建的 Engine 实例之间才能进行实时音视频通话。

UserLeaveReasonType

public enum GameRTC.UserLeaveReasonType

用户离开房间的原因

Defined in : IGameRTCService.cs

枚举值

类型	值	说明
Quit	0	用户主动离开，即调用 LeaveRoom 方法退出房间。
Dropped	1	用户掉线。远端用户因为网络等原因掉线。

RoomType

public enum GameRTC.RoomType

房间类型

Defined in : IGameRTCService.cs

枚举值

类型	值	说明
Team	0	小队房间。进入同一小队房间的成员是队友关系。进入小队房间后，打开麦克风可以向房间内所有队友讲话；打开扬声器可以收听房间内所有队友讲话。
World	1	世界房间。你需要判断进入同一房间的成员是否为队友关系，进而决定收听逻辑。

ConnectionState

public enum GameRTC.ConnectionState

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

Defined in : IGameRTCService.cs

枚举值

类型	值	说明
Disconnected	0	连接断开
Connecting	1	首次连接，正在连接中
Connected	2	首次连接成功
Reconnecting	3	连接断开后，重新连接中
Reconnected	4	连接断开后，重连成功
Lost	5	网络连接断开超过 10 秒，仍然会继续重连。

GameRTCRoomConfig

public struct GameRTC.GameRTCRoomConfig

房间配置信息

Defined in : IGameRTCService.cs

成员变量

类型	名称
EnableRangeAudio	是否开启范围语音 + true: 开启 + false: 关闭 + 开启范围语音时，非同一小队玩家的声音会根据距离衰减，对于不需要这种衰减效果的应用，设置为 false。
AudioVolumeIndicationInterval	开启后会收到 OnAudioVolumeIndicationEventHandler 音量提示回调的时间间隔： + ≤ 0: 禁用音量提示功能。 + >0: 启用音量提示功能，并设置收到音量提示回调的时间间隔，单位为毫秒。
RoomType	房间类型，参看 RoomType。对于普通组队语音设置为 Team 即可。

GameRTCAudioVolumeInfo

public struct GameRTC.GameRTCAudioVolumeInfo

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

Defined in : IGameRTCService.cs

成员变量

类型	名称
Volume	说话者的音量，范围为 0（最低）- 255（最高）
UserID	说话者的用户 ID

GameRTCReceiveRange

public struct GameRTC.GameRTCReceiveRange

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

Defined in : IGameRTCService.cs

成员变量

类型	名称
Min	收听声音无衰减的范围最小值。当收听者和声源距离小于 min 的时候，收听到的声音完全无衰减。
Max	能够收听到声音的范围最大值。当收听者和声源距离大于 max 的时候，无法收听到声音。当收听者和声源距离介于 [min, max) 之间时，收听到的音量根据距离有衰减。

GameRTCPositionInfo

public struct GameRTC.GameRTCPositionInfo

玩家的位置信息

Defined in : IGameRTCService.cs

成员变量

类型	名称
X	x 坐标
Y	y 坐标
Z	z 坐标

NetworkQuality

public enum GameRTC.NetworkQuality

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

Defined in : IGameRTCService.cs

枚举值

类型	值	说明
Unknown	0	质量未知
Excellent	1	质量极好
Good	2	用户主观感觉近似“极好”，但码率可能略低于“极好”
Poor	3	用户主观感受有瑕疵但不影响沟通
Bad	4	勉强能够沟通但不顺畅
Vbad	5	网络质量非常差，基本不能沟通

AudioDeviceInfo

public struct GameRTC.AudioDeviceInfo

音频设备信息

Defined in : IGameRTCService.cs

成员变量

类型	名称
DeviceID	音频设备 ID
DeviceName	音频设备名字

AudioScenarioType

public enum GameRTC.AudioScenarioType

音频场景类型

Defined in : IGameRTCService.cs

枚举值

类型

值

说明

kAudioScenarioTypeMusic

音乐场景。默认为此场景。
此场景适用于对音乐表现力有要求的场景。如音乐直播等。
音频路由和发布订阅状态，到音量类型的映射如下：

	仅发布音视频流	仅订阅音视频流	发布并订阅音视频流	备注
设备自带麦克风和扬声器/听筒	媒体音量	媒体音量	通话音量	/
有线耳机	媒体音量	媒体音量	媒体音量	/
蓝牙耳机	媒体音量	媒体音量	媒体音量	即使蓝牙耳机有麦克风，也只能使用设备自带麦克风进行本地音频采集。

kAudioScenarioTypeHighQualityCommunication

高质量通话场景。

此场景适用于对音乐表现力有要求的场景。但又希望能够使用蓝牙耳机上自带的麦克风进行音频采集的场景。
此场景可以兼顾外放/使用蓝牙耳机时的音频体验；并尽可能避免使用蓝牙耳机时音量类型切换导致的听感突变。

音频路由和发布订阅状态，到音量类型的映射如下：

	仅发布音视频流	仅订阅音视频流	发布并订阅音视频流	备注
设备自带麦克风和扬声器/听筒	媒体音量	媒体音量	通话音量	/
有线耳机	媒体音量	媒体音量	媒体音量	/
蓝牙耳机	通话音量	通话音量	通话音量	能够使用蓝牙耳机上自带的麦克风进行音频采集。

kAudioScenarioTypeCommunication

纯通话音量场景。

此场景下，无论客户端音频路由情况和发布订阅状态，全程使用通话音量。
适用于需要频繁上下麦的通话或会议场景。

此场景可以保持统一的音频模式，不会有音量突变的听感；
最大程度上的消除回声，使通话清晰度达到最优；
使用蓝牙耳机时，能够使用蓝牙耳机上自带的麦克风进行音频采集。

但是，使用媒体音量进行播放的其他音频的音量会被压低，且音质会变差。

kAudioScenarioTypeMedia

纯媒体场景。一般不建议使用。

此场景下，无论客户端音频路由情况和发布订阅状态，全程使用媒体音量。
外放通话时，极易出现回声和啸叫。