GameRTCEngine

public abstract class com.ss.bytertc.engine.GameRTCEngine

GameRTC 引擎

静态函数

成员函数

函数说明

create

public static synchronized GameRTCEngine com.ss.bytertc.engine.GameRTCEngine.create(
    Context context,
    GameRTCEngineConfig config,
    IGameRTCEventHandler eventHandler,
    String params)

创建 GameRTCEngine 实例。
GameRTCEngine 实例成功创建后，你才可以使用 SDK 提供的其他能力。

传入参数

返回值

• 创建成功时，返回一个可用的 GameRTCEngineImpl 实例；
• 创建失败时，返回 null

注意

• 你应先创建 eventHandler，再调用本接口创建 GameRTCEngine 实例；并在销毁 GameRTCEngine 实例之后，销毁 eventHandler 实例。
• 如果已创建了 GameRTCEngine 实例且未销毁，后续再调用时，均返回这个实例。如果已创建的实例被销毁，后续再调用时，会重新创建新的实例。

destroy

public static synchronized void com.ss.bytertc.engine.GameRTCEngine.destroy()

销毁由 create 所创建引擎实例，并释放所有相关资源。

注意

• 请确保一定是在所有业务场景的最后阶段才调用该方法
• 该方法在调用之后，会销毁所有SDK相关的内存，并且停止与媒体服务器的任何交互
• 本方法为阻塞调用，会阻塞当前线程直到 SDK 彻底完成退出逻辑。因此，不可在回调线程中直接调用本方法；也不可在回调方法中等待主线程的执行而同时在主线程调用本方法，否则会造成死锁。

getSdkVersion

public static String com.ss.bytertc.engine.GameRTCEngine.getSdkVersion()

获取 SDK 当前的版本号。

返回值 SDK 当前的版本号。

setRtcNativeLibraryLoader

public static void com.ss.bytertc.engine.GameRTCEngine.setRtcNativeLibraryLoader(
    RTCNativeLibraryLoader rtcNativeLibraryLoader)

设置 native library 加载器，需要在其他所有静态方法调用之前被调用。

传入参数

joinRoom

public abstract int com.ss.bytertc.engine.GameRTCEngine.joinRoom(
    String roomId,
    String userId,
    String token,
    GameRTCRoomConfig config)

加入实时语音房间
在使用实时语音的通话功能时，必须先加入实时语音房间。
调用该方法后，会收到 onJoinRoomResult 回调通知。

传入参数

返回值 方法调用结果

• 0: 成功
• -1: roomId 为空，失败
• -2: userId 为空，失败
• -3: Engine 创建失败

注意

• 使用不同 App ID 的 App 是不能互通的。
• 请务必保证生成 Token 使用的 App ID 和创建引擎时使用的 App ID 相同，否则会导致加入房间失败。
• 用户加入房间成功后，在本端网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本端会收到 onJoinRoomResult 回调通知，其 isRejoined 参数为 true。
• 同一个 App ID 的同一个房间内，每个用户的用户ID 必须是唯一的。如果两个用户的用户ID 相同，则后加入房间的用户会将先加入房间的用户踢出房间，并且先加入房间的用户会收到 onRoomError 回调通知，错误类型为重复登录 ROOM_ERROR_DUPLICATE_LOGIN。

leaveRoom

public abstract int com.ss.bytertc.engine.GameRTCEngine.leaveRoom(
    String roomId)

离开房间。
用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。
调用 joinRoom 方法加入房间后，在通话结束时必须调用此方法结束通话，并收到 onLeaveRoom 回调确认结束通话，否则无法开始下一次通话。
无论当前是否在房间中，都可以调用此方法。重复调用此方法不会有负面影响。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空。

updateToken

public abstract int com.ss.bytertc.engine.GameRTCEngine.updateToken(
    String roomId,
    String token)

更新进房 token。
在进房时如果收到错误码为 JOIN_ROOM_INVALID_TOKEN 的 onJoinRoomResult 回调，表示 token 过期导致进房失败。
此时，你应调用本接口，以新 token 进房。

传入参数

返回值 方法调用结果

• 0：成功
• -1：引擎已经被销毁或者未创建，或者是房间 ID 为空

updateReceiveRange

public abstract int com.ss.bytertc.engine.GameRTCEngine.updateReceiveRange(
    String roomId,
    GameRTCReceiveRange range)

在世界房间中，使用范围语音功能时，设定语音的接收范围和衰减信息。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空

注意 你应在加入房间时，通过参数设置，加入世界房间，并开启范围语音: - 关于世界房间，参看 RoomType 中的 World。

• 关于范围语音，参看 enableRangeAudio。

updatePosition

public abstract int com.ss.bytertc.engine.GameRTCEngine.updatePosition(
    String roomId,
    GameRTCPositionInfo info)

使用范围语音功能时，设置玩家的坐标。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空。

updateOrientation

public abstract int com.ss.bytertc.engine.GameRTCEngine.updateOrientation(
    String roomId,
    GameRTCOrientationInfo info)

在使用空间语音功能时，必须通过此接口传入玩家的方位，sdk 内部会根据玩家坐标和方位实现空间效果

传入参数

返回值 方法调用结果

• 0：成功
• -1：引擎已经被销毁或者未创建，或者是房间 ID 为空

enableMicrophone

public abstract int com.ss.bytertc.engine.GameRTCEngine.enableMicrophone(
    String roomId,
    boolean enable)

控制本地音频采集和发布状态。
改变该状态后，房间内其他用户会收到 onMicrophoneEnabled 回调。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空。

enableAudioSend

public abstract int com.ss.bytertc.engine.GameRTCEngine.enableAudioSend(
    String roomId,
    boolean enable)

控制本地语音的发送状态：发送/不发送。
使用此方法后，房间中的其他用户会收到 onAudioSendEnabled 回调。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空

注意

• 初次调用本方法发送本地语音时，会开启本地音频采集功能。
• 之后再次调用本方法时，仅控制本地音频流的发送状态，不会影响本地音频采集状态。

enableSpeakerphone

public abstract int com.ss.bytertc.engine.GameRTCEngine.enableSpeakerphone(
    String roomId,
    boolean enable)

设置对来自远端的语音的接收状态。
使用此方法后，房间中的其他用户会收到 onSpeakerphoneEnabled 回调。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空

注意 本方法只控制本地是否接收远端音频流，并不影响本地音频播放设备的工作状态。

enableAudioReceive

public abstract int com.ss.bytertc.engine.GameRTCEngine.enableAudioReceive(
    String roomId,
    String userId,
    boolean enable)

设置对来自指定远端用户的语音的接收状态

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 或者用户 ID 为空。

注意 本方法只控制本地是否接收远端音频流，并不影响本地音频播放设备的工作状态。

setRecordingVolume

public abstract int com.ss.bytertc.engine.GameRTCEngine.setRecordingVolume(
    int volume)

调节音频采集音量。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空

注意 为保证更好的通话质量，建议将 volume 值设为 [0,100]。

setPlaybackVolume

public abstract int com.ss.bytertc.engine.GameRTCEngine.setPlaybackVolume(
    int volume)

调节本地播放的所有远端用户混音后的音量。

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，或者是房间 ID 为空。

注意 为保证更好的通话质量，建议将 volume 值设为 [0,100]。

setRemoteAudioPlaybackVolume

public abstract int com.ss.bytertc.engine.GameRTCEngine.setRemoteAudioPlaybackVolume(
    String roomId,
    String userId,
    int volume)

调节来自指定远端用户的音频播放音量

传入参数

返回值 方法调用结果

• 0：成功；
• -1：失败，引擎已经被销毁或者未创建，房间 ID 或者用户 ID 为空

注意 调用 enableRangeAudio 开启范围语音后，此接口不生效。

setAudioScenario

public abstract void com.ss.bytertc.engine.GameRTCEngine.setAudioScenario(
    AudioScenarioType audioScenario)

设置音频场景类型

传入参数