RCRTCEngine (release 5.1.16)

java.lang.Object
- cn.rongcloud.rtc.api.RCRTCEngine

public abstract class RCRTCEngine
extends Object

构造器概要

构造器
构造器和说明

RCRTCEngine()

构造器
构造器和说明
`RCRTCEngine()`

方法概要

所有方法静态方法实例方法抽象方法具体方法已过时的方法
限定符和类型	方法和说明
`abstract RCRTCFileVideoOutputStream`	`createFileVideoOutputStream(String path, boolean replace, boolean playback, String tag, RCRTCVideoStreamConfig config)` 创建自定义文件视频流
`abstract RCRTCVideoOutputStream`	`createVideoStream(String tag, RCRTCVideoStreamConfig config)` 创建自定义视频流
`abstract void`	`enableSpeaker(boolean enable)` 设置是否切换听筒为扬声器
`abstract IAudioEffectManager`	`getAudioEffectManager()` 音效管理器，管理播放、暂停等
`abstract RCRTCMicOutputStream`	`getDefaultAudioStream()` 获取本地默认音频流
`abstract RCRTCCameraOutputStream`	`getDefaultVideoStream()` 获取本地默认视频流
`abstract EglBase.Context`	`getEglBaseContext()` 已过时。
`abstract EGLContext`	`getEglContext()` 返回 EGLContext Add from 5.1.6
`static RCRTCEngine`	`getInstance()` 音视频引擎单例
`abstract RCRTCRoom`	`getRoom()` 获取当前已加入的房间
`abstract RCRTCScreenShareOutputStream`	`getScreenShareVideoStream()` Added from 5.1.8 获取屏幕共享视屏流.
`static String`	`getVersion()` 获取 SDK 版本号
`abstract void`	`init(Context application, RCRTCConfig config)` 初始化 SDK
`abstract void`	`joinOtherRoom(String roomId, IRCRTCResultDataCallback<RCRTCOtherRoom> callBack)` 加入副房间前提必须已经通过 `joinRoom(String, RCRTCRoomType, IRCRTCResultDataCallback)` 或 `joinRoom(String, IRCRTCResultDataCallback)` 加入了主房间
`abstract void`	`joinRoom(String roomId, IRCRTCResultDataCallback<RCRTCRoom> callBack)` 加入房间
`abstract void`	`joinRoom(String roomId, RCRTCRoomConfig roomConfig, IRCRTCResultDataCallback<RCRTCRoom> callBack)` 加入指定类型房间 Added from 5.1.0
`abstract void`	`joinRoom(String roomId, RCRTCRoomType roomType, IRCRTCResultDataCallback<RCRTCRoom> callBack)` 已过时。
`abstract void`	`leaveOtherRoom(String roomId, boolean notifyFinished, IRCRTCResultCallback callBack)` 离开副房间
`abstract void`	`leaveRoom(IRCRTCResultCallback callBack)` 离开房间
`abstract void`	`queryJoinedRoom(IRCRTCResultDataCallback<RCRTCJoinedRoomInfo[]> callBack)` Added from 5.1.14 查询当前用户在其他端的房间状态
`abstract void`	`registerEventListener(IRCRTCEngineEventListener engineEventListener)` 设置全局事件通知方法一般情况下，开发者调用融云 SDK 接口，通过接口参数 callBack 可以获取成功或者失败的结果。
`abstract void`	`registerStatusReportListener(IRCRTCStatusReportListener statusReportListener)` 设置房间状态报告监听
`abstract void`	`setMediaServerUrl(String mediaServerUrl)` 设置媒体服务器地址
`abstract void`	`startEchoTest(int internalInSeconds)` 开始测试通话直播前检测
`abstract void`	`stopEchoTest()` 停止测试通话直播前检测
`abstract void`	`subscribeLiveStream(String liveUrl, RCRTCAVStreamType avStreamType, RCRTCLiveCallback callBack)` 已过时。
`abstract void`	`unInit()` 反初始化 SDK，释放资源
`abstract void`	`unregisterEventListener()` 取消全局事件通知方法
`abstract void`	`unregisterStatusReportListener()` 取消注册房间状态报告监听
`abstract void`	`unsubscribeLiveStream(String liveUrl, IRCRTCResultCallback callBack)` 已过时。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - RCRTCEngine
```
public RCRTCEngine()
```
- 方法详细资料
  - getInstance
```
public static RCRTCEngine getInstance()
```
    音视频引擎单例
  - init
```
public abstract void init(Context application,
                          RCRTCConfig config)
```
    初始化 SDK
    
    参数:
    
    application - 应用上下文
    
    config - 全局音视频配置信息
  - getDefaultVideoStream
```
public abstract RCRTCCameraOutputStream getDefaultVideoStream()
```
    获取本地默认视频流
    
    返回:
    
    默认视频流
  - getScreenShareVideoStream
```
public abstract RCRTCScreenShareOutputStream getScreenShareVideoStream()
```
    Added from 5.1.8 获取屏幕共享视屏流.
    
    返回:
  - createFileVideoOutputStream
```
public abstract RCRTCFileVideoOutputStream createFileVideoOutputStream(String path,
                                                                       boolean replace,
                                                                       boolean playback,
                                                                       String tag,
                                                                       RCRTCVideoStreamConfig config)
```
    创建自定义文件视频流
    
    参数:
    
    path - 文件路径
    
    replace - 文件中音频是否替换麦克风数据，true 替换麦克风数据，false 与麦克风数据混音
    
    playback - 文件中的音频是否在本端播放
    
    tag - 自定义视频文件流标识
    
    config - 自定视频文件流的配置信息
    
    返回:
    
    自定义视频文件流
  - getDefaultAudioStream
```
public abstract RCRTCMicOutputStream getDefaultAudioStream()
```
    获取本地默认音频流
    
    返回:
    
    默认音频流
  - createVideoStream
```
public abstract RCRTCVideoOutputStream createVideoStream(String tag,
                                                         RCRTCVideoStreamConfig config)
```
    创建自定义视频流
    
    参数:
    
    tag - 自定义视频流标识
    
    config - 自定义视频的配置信息
    
    返回:
  - subscribeLiveStream
```
@Deprecated
public abstract void subscribeLiveStream(String liveUrl,
                                                     RCRTCAVStreamType avStreamType,
                                                     RCRTCLiveCallback callBack)
```
    已过时。
    
    观众订阅主播资源 Deprecated from 5.1.0
    该方法仅直播模式中观众观看(订阅)主播的直播流使用，观众无需加入房间。【不能用作主播订阅主播】如果已订阅主播音频+视频。再次仅订阅(切换到)视频流(无论大小流)，将取消订阅音频，回调(RCRTCLiveCallback)只返回视频流对象(onVideoStreamReceived(RCRTCVideoInputStream stream))。如果已订阅主播音频+视频。再次仅订阅(切换到)音频流，将取消订阅视频，回调(RCRTCLiveCallback)只返回音频流对象(onAudioStreamReceived(RCRTCAudioInputStream stream))。避免视频大小流切换时，视图重复添加导致的屏幕闪烁：如果设置的 RCRTCAVStreamType 参数在{ RCRTCAVStreamType.VIDEO; RCRTCAVStreamType.VIDEO_TINY; RCRTCAVStreamType.AUDIO_VIDEO; RCRTCAVStreamType.AUDIO_VIDEO_TINY; } 之间切换订阅(均包含视频流,不分大小流)，可以在回调RCRTCLiveCallback.onVideoStreamReceived(RCRTCVideoInputStream)中不再创建视频渲染视图，也不需要将视图重复设置给RCRTCVideoInputStream。
    
    参数:
    
    liveUrl - 直播地址
    
    avStreamType - 订阅流类型
    
    callBack - 订阅结果回调
    
    从以下版本开始:
    
    4.0.2
  - unsubscribeLiveStream
```
@Deprecated
public abstract void unsubscribeLiveStream(String liveUrl,
                                                       IRCRTCResultCallback callBack)
```
    已过时。
    
    观众取消订阅主播资源 Deprecated from 5.1.0
    
    参数:
    
    liveUrl - 直播地址
    
    callBack - 取消订阅回调
  - getRoom
```
public abstract RCRTCRoom getRoom()
```
    获取当前已加入的房间
    
    返回:
    
    房间对象
  - enableSpeaker
```
public abstract void enableSpeaker(boolean enable)
```
    设置是否切换听筒为扬声器
    
    参数:
    
    enable - 是否打开扬声器。默认为false。
  - joinRoom
```
public abstract void joinRoom(String roomId,
                              IRCRTCResultDataCallback<RCRTCRoom> callBack)
```
    加入房间
    
    参数:
    
    roomId - 房间 ID ，长度 64 个字符，可包含：`A-Z`、`a-z`、`0-9`、`+`、`=`、`-`、`_`
    
    callBack - 加入房间回调，不允许为 null
  - joinRoom
```
@Deprecated
public abstract void joinRoom(String roomId,
                                          RCRTCRoomType roomType,
                                          IRCRTCResultDataCallback<RCRTCRoom> callBack)
```
    已过时。
    
    加入指定类型房间 Deprecated from 5.1.0
    
    参数:
    
    roomId - 房间 ID ，长度 64 个字符，可包含：`A-Z`、`a-z`、`0-9`、`+`、`=`、`-`、`_`
    
    roomType - 房间类型，用于区分普通房间还是直播房间
    
    callBack - 加入房间回调
  - joinRoom
```
public abstract void joinRoom(String roomId,
                              RCRTCRoomConfig roomConfig,
                              IRCRTCResultDataCallback<RCRTCRoom> callBack)
```
    加入指定类型房间 Added from 5.1.0
    
    参数:
    
    roomId - 房间 ID ，长度 64 个字符，可包含：`A-Z`、`a-z`、`0-9`、`+`、`=`、`-`、`_`
    
    roomConfig - 房间配置参数，用于区分普通房间还是直播房间以及在直播间中扮演的角色
    
    callBack - 加入房间回调
  - leaveRoom
```
public abstract void leaveRoom(IRCRTCResultCallback callBack)
```
    离开房间
    
    参数:
    
    callBack - 离开房间回调
  - unInit
```
public abstract void unInit()
```
    反初始化 SDK，释放资源
  - registerStatusReportListener
```
public abstract void registerStatusReportListener(IRCRTCStatusReportListener statusReportListener)
```
    设置房间状态报告监听
    
    参数:
    
    statusReportListener - IRCRTCStatusReportListener
  - unregisterStatusReportListener
```
public abstract void unregisterStatusReportListener()
```
    取消注册房间状态报告监听
  - registerEventListener
```
public abstract void registerEventListener(IRCRTCEngineEventListener engineEventListener)
```
    设置全局事件通知方法一般情况下，开发者调用融云 SDK 接口，通过接口参数 callBack 可以获取成功或者失败的结果。目前仅有一个特殊错误通知的方法，对于特殊需求的开发者可以注册此监听，大部分场景下开发者无需关心。例如，SDK 内部在使用硬件编码出现错误时会切换到软件编码，一些 OEM 硬件厂商不期望使用软编，收到这个通知可以提示用户并调用leaveRoom(IRCRTCResultCallback) 退出房间。
    
    参数:
    
    engineEventListener - IRCRTCEngineEventListener
  - unregisterEventListener
```
public abstract void unregisterEventListener()
```
    取消全局事件通知方法
  - setMediaServerUrl
```
public abstract void setMediaServerUrl(String mediaServerUrl)
```
    设置媒体服务器地址
  - getAudioEffectManager
```
public abstract IAudioEffectManager getAudioEffectManager()
```
    音效管理器，管理播放、暂停等
  - getEglBaseContext
```
@Deprecated
public abstract EglBase.Context getEglBaseContext()
```
    已过时。
    
    返回 EGL context。已废弃，推荐使用 getEglContext() Deprecated from 5.1.6
  - getEglContext
```
public abstract EGLContext getEglContext()
```
    返回 EGLContext Add from 5.1.6
    
    返回:
    
    目前只支持 EGLContext
  - joinOtherRoom
```
public abstract void joinOtherRoom(String roomId,
                                   IRCRTCResultDataCallback<RCRTCOtherRoom> callBack)
```
    加入副房间前提必须已经通过 joinRoom(String, RCRTCRoomType, IRCRTCResultDataCallback) 或 joinRoom(String, IRCRTCResultDataCallback) 加入了主房间
    
    参数:
    
    roomId - 房间 ID ，长度 64 个字符，可包含：`A-Z`、`a-z`、`0-9`、`+`、`=`、`-`、`_`
    
    callBack - 加入房间回调
  - leaveOtherRoom
```
public abstract void leaveOtherRoom(String roomId,
                                    boolean notifyFinished,
                                    IRCRTCResultCallback callBack)
```
    离开副房间
    
    参数:
    
    roomId - 需要离开的其他房间号码
    
    callBack - 离开房间回调
    
    notifyFinished - 离开副房间时是否结束连麦。如果房间中其他用户收到是(true)结束连麦，会清空所有关于连麦的缓存信息。 1. 为true或false，本端将会退出该副房间。连麦中的其他用户将收到回调通知 IRCRTCRoomEventsListener.onFinishOtherRoom(String, String) 2. 融云期望本次连麦的某个管理角色传true去结束连麦，而且仅允许本次连麦只有一个用户调用结束连麦
  - getVersion
```
public static String getVersion()
```
    获取 SDK 版本号
    
    返回:
    
    版本号
  - startEchoTest
```
public abstract void startEchoTest(int internalInSeconds)
```
    开始测试通话直播前检测
    
    参数:
    
    internalInSeconds - 录制音频秒数
  - stopEchoTest
```
public abstract void stopEchoTest()
```
    停止测试通话直播前检测
  - queryJoinedRoom
```
public abstract void queryJoinedRoom(IRCRTCResultDataCallback<RCRTCJoinedRoomInfo[]> callBack)
```
    Added from 5.1.14 查询当前用户在其他端的房间状态
    
    参数:
    
    callBack - 结果回调

类 RCRTCEngine

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

RCRTCEngine

方法详细资料

getInstance

init

getDefaultVideoStream

getScreenShareVideoStream

createFileVideoOutputStream

getDefaultAudioStream

createVideoStream

subscribeLiveStream

unsubscribeLiveStream

getRoom

enableSpeaker

joinRoom

joinRoom

joinRoom

leaveRoom

unInit

registerStatusReportListener

unregisterStatusReportListener

registerEventListener

unregisterEventListener

setMediaServerUrl

getAudioEffectManager

getEglBaseContext

getEglContext

joinOtherRoom

leaveOtherRoom

getVersion

startEchoTest

stopEchoTest

queryJoinedRoom