Interface RCRTCEngine

interface RCRTCEngine {
    room: RCRTCRoom;
    config: RCRTCConfig;
    reportListener: RCRTCReportListener;
    defaultAudioStream: RCRTCMicAudioOutputStream;
    defaultVideoStream: RCRTCCameraVideoOutputStream;
    addEngineListener(value: RCRTCEngineListener): void;
    removeEngineListener(value: RCRTCEngineListener): void;
    joinRoom(
        roomId: string,
        roomConfig: RCRTCRoomConfig,
    ): Promise<ICompletionResult>;
    leaveRoom(): Promise<ICompletionResult>;
    setMediaServerUrl(url: string): any;
    setCustomExtendInfo(extendInfo: string): any;
    getVersion(): string;
    install(): void;
    setCameraStatusCallback(
        callback: (cameraStatus: RCCameraStatusInfo) => void,
    ): void;
    getCameraList(): RCCameraDeviceInfo[];
}

Index

Properties

room config reportListener defaultAudioStream defaultVideoStream

Methods

addEngineListener removeEngineListener joinRoom leaveRoom setMediaServerUrl setCustomExtendInfo getVersion install setCameraStatusCallback getCameraList

Properties

`Readonly`room

room: RCRTCRoom

获取房间实例

config

config: RCRTCConfig

引擎配置

reportListener

reportListener: RCRTCReportListener

报表监听器

defaultAudioStream

defaultAudioStream: RCRTCMicAudioOutputStream

默认麦克风音频流

defaultVideoStream

defaultVideoStream: RCRTCCameraVideoOutputStream

默认摄像头视频流

Methods

addEngineListener

addEngineListener(value: RCRTCEngineListener): void
添加引擎监听器
Parameters
- value: RCRTCEngineListener
Returns void
- Defined in RCRTCEngine.ts:42

removeEngineListener

removeEngineListener(value: RCRTCEngineListener): void
移除引擎监听器
Parameters
- value: RCRTCEngineListener
Returns void
- Defined in RCRTCEngine.ts:48

joinRoom

joinRoom(
roomId: string,
roomConfig: RCRTCRoomConfig,
): Promise<ICompletionResult>
加入房间
Parameters
- roomId: string
  房间ID
- roomConfig: RCRTCRoomConfig
  房间配置
Returns Promise<ICompletionResult>
- Defined in RCRTCEngine.ts:55

leaveRoom

leaveRoom(): Promise<ICompletionResult>
离开房间

Returns Promise<ICompletionResult>
- Defined in RCRTCEngine.ts:60

setMediaServerUrl

setMediaServerUrl(url: string): any
业务侧调用接口设置特定mediaServer地址，SDK后续会只用此地址和mediaServer交互
Parameters
- url: string
Returns any
- Defined in RCRTCEngine.ts:66

setCustomExtendInfo

setCustomExtendInfo(extendInfo: string): any
业务侧调用接口设置自定义扩展信息
Parameters
- extendInfo: string
Returns any
- Defined in RCRTCEngine.ts:72

getVersion

getVersion(): string
获取版本号

Returns string
- Defined in RCRTCEngine.ts:77

install

install(): void
加载当前SDK，需要在初始化imlib之前调用

Returns void
- Defined in RCRTCEngine.ts:82

setCameraStatusCallback

setCameraStatusCallback(
callback: (cameraStatus: RCCameraStatusInfo) => void,
): void
设置监听相机状态事件包括新相机的出现、相机的移除、相机是否被占用、被释放
Parameters
- callback: (cameraStatus: RCCameraStatusInfo) => void
Returns void
- Defined in RCRTCEngine.ts:89

getCameraList

getCameraList(): RCCameraDeviceInfo[]
获取支持的摄像头列表首次应使用此方法获取全量摄像头列表，后续变动会在 setCameraStatusCallback 的回调里通知

Returns RCCameraDeviceInfo[]
摄像头信息数组，如果获取失败返回 undefined
- Defined in RCRTCEngine.ts:96