Interface RCRTCEngineInterface

Engine 方法定义

interface: RCRTCEngineInterface

Hierarchy

RCRTCEngineInterface

Implemented by

default

Index

Methods Other

Methods 混音

Other Methods

addLiveCdn

addLiveCdn(url: string): number

- Defined in RCRTCEngine.ts:1292
设置 CDN 直播推流地址, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- url: string
  
  推流地址
Returns number
{number} 错误码

adjustAllAudioEffectsVolume

adjustAllAudioEffectsVolume(volume: number): number

- Defined in RCRTCEngine.ts:1498
设置全局音效文件播放音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- volume: number
  
  音量 0~100, 默认 100
Returns number
{number} 错误码

adjustAudioEffectVolume

adjustAudioEffectVolume(effectId: number, volume: number): number

- Defined in RCRTCEngine.ts:1480
设置音效文件播放音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- effectId: number
  
  自定义全局唯一音效Id
- volume: number
  
  音量 0~100, 默认 100
Returns number
{number} 错误码

adjustAudioMixingPlaybackVolume

adjustAudioMixingPlaybackVolume(volume: number): number

- Defined in RCRTCEngine.ts:1555
设置混音本地播放音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- volume: number
  
  音量 0~100, 默认 100
Returns number
{number} 错误码

adjustAudioMixingPublishVolume

adjustAudioMixingPublishVolume(volume: number): number

- Defined in RCRTCEngine.ts:1572
设置混音发送音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- volume: number
  
  音量 0~100, 默认 100
Returns number
{number}

adjustAudioMixingVolume

adjustAudioMixingVolume(volume: number): number

- Defined in RCRTCEngine.ts:1546
设置混音输入音量, 包含本地播放和发送音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- volume: number
  
  音量 0~100, 默认 100
Returns number
{number}

adjustLocalVolume

adjustLocalVolume(volume: number): number

- Defined in RCRTCEngine.ts:1138
设置麦克风的音量

memberof
RCRTCEngineInterface

Parameters
- volume: number
  
  0 ~ 100, 默认值: 100
Returns number
{number} 错误码

cancelJoinSubRoomRequest

cancelJoinSubRoomRequest(roomId: string, userId: string, extra?: string): number

- Defined in RCRTCEngine.ts:1762
取消正在进行中的跨房间连麦请求

memberof
RCRTCEngineInterface

Parameters
- roomId: string
  
  房间 roomId
- userId: string
  
  远端用户 userId
- Optional extra: string
  
  附加信息, 可随消息发送给被邀请人
Returns number
{number} 错误码

createAudioEffect

createAudioEffect(path: string, effectId: number): number

- Defined in RCRTCEngine.ts:1399
创建音效文件缓存, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- path: string
  
  本地文件地址
- effectId: number
  
  自定义全局唯一音效Id
Returns number
{number}

createCustomStreamFromFile

createCustomStreamFromFile(path: string, tag: string, replace: boolean, playback: boolean): number

- Defined in RCRTCEngine.ts:1626
从视频文件创建自定义流, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- path: string
  
  本地文件地址
- tag: string
  
  自定义流全局唯一标签
- replace: boolean
  
  是否替换音频流 true: 替换 false: 不替换
- playback: boolean
  
  是否本地回放音频流 true: 回放 false: 不回放
Returns number
{number} 错误码

destroy

destroy(): number

- Defined in RCRTCEngine.ts:996
销毁实例

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

enableCamera

enableCamera(enable: boolean, camera: RCRTCCamera): number

- Defined in RCRTCEngine.ts:1148
打开/关闭摄像头

memberof
RCRTCEngineInterface

Parameters
- enable: boolean
  
  true：打开， false：关闭
- camera: RCRTCCamera
  
  摄像头类型
Returns number
{number} 错误码

enableMicrophone

enableMicrophone(enable: boolean): number

- Defined in RCRTCEngine.ts:1120
打开/关闭麦克风

memberof
RCRTCEngineInterface

Parameters
- enable: boolean
  
  true 打开, false 关闭
Returns number
{number} 错误码

enableSpeaker

enableSpeaker(enable: boolean): number

- Defined in RCRTCEngine.ts:1129
打开/关闭外放

memberof
RCRTCEngineInterface

Parameters
- enable: boolean
  
  true 打开, false 关闭
Returns number
{number} 错误码

getAudioEffectVolume

getAudioEffectVolume(effectId: number): number

- Defined in RCRTCEngine.ts:1489
获取音效文件播放音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- effectId: number
  
  自定义全局唯一音效Id
Returns number
{number} 音量，如果小于 0，则是错误码，错误码对应 number

getAudioMixingDuration

getAudioMixingDuration(): number

- Defined in RCRTCEngine.ts:1605
获取音频文件时长, 单位:秒, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 音频文件时长, 如果小于 0，则是错误码，错误码对应 number

getAudioMixingPlaybackVolume

getAudioMixingPlaybackVolume(): number

- Defined in RCRTCEngine.ts:1563
获取混音本地播放音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 音量，如果小于 0，则是错误码，错误码对应 number

getAudioMixingPosition

getAudioMixingPosition(): number

- Defined in RCRTCEngine.ts:1597
获取音频文件合流进度, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 合流进度 0~1

getAudioMixingPublishVolume

getAudioMixingPublishVolume(): number

- Defined in RCRTCEngine.ts:1580
获取混音发送音量, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 音量，如果小于 0，则是错误码，错误码对应 number

getSessionId

getSessionId(): string

- Defined in RCRTCEngine.ts:1614
获取当前房间的 SessionId, 仅在加入房间成功后可获取每次加入房间所得到的 SessionId 均不同

memberof
RCRTCEngineInterface

Returns string
{string} 获取到的 sessionId

isCameraExposurePositionSupported

isCameraExposurePositionSupported(): boolean

- Defined in RCRTCEngine.ts:1180
获取摄像头是否支持区域测光

memberof
RCRTCEngineInterface

Returns boolean
{boolean} true: 支持 false: 不支持

isCameraFocusSupported

isCameraFocusSupported(): boolean

- Defined in RCRTCEngine.ts:1172
获取摄像头是否支持区域对焦

memberof
RCRTCEngineInterface

Returns boolean
{boolean} true: 支持 false: 不支持

joinRoom

joinRoom(roomId: string, setup: RCRTCRoomSetup): number

- Defined in RCRTCEngine.ts:1006
加入房间

memberof
RCRTCEngineInterface

Parameters
- roomId: string
  
  房间id
- setup: RCRTCRoomSetup
  
  房间配置
Returns number
{number} 错误码

joinSubRoom

joinSubRoom(roomId: string): number

- Defined in RCRTCEngine.ts:1790
连麦邀请后加入副房间

memberof
RCRTCEngineInterface

Parameters
- roomId: string
  
  房间 roomId
Returns number
{number} 错误码

leaveRoom

leaveRoom(): number

- Defined in RCRTCEngine.ts:1014
离开房间

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

leaveSubRoom

leaveSubRoom(roomId: string, disband: boolean): number

- Defined in RCRTCEngine.ts:1800
离开副房间，此方法仅供连麦离开副房间使用

memberof
RCRTCEngineInterface

Parameters
- roomId: string
  
  房间 roomId
- disband: boolean
  
  是否通知所有连麦用户结束, true:通知 false:不通知
Returns number
{number} 错误码

muteLocalCustomStream

muteLocalCustomStream(tag: string, mute: boolean): number

- Defined in RCRTCEngine.ts:1646
停止自定义流发送, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- tag: string
  
  自定义流全局唯一标签
- mute: boolean
  
  true: 不发送 false: 发送
Returns number
{number} 错误码

muteLocalStream

muteLocalStream(type: RCRTCMediaType, mute: boolean): number

- Defined in RCRTCEngine.ts:1272
停止本地音视频数据发送

memberof
RCRTCEngineInterface

Parameters
- type: RCRTCMediaType
  
  媒体类型
- mute: boolean
  
  true: 不发送 false: 发送
Returns number
{number} 错误码

muteRemoteCustomStream

muteRemoteCustomStream(userId: string, tag: string, type: RCRTCMediaType, mute: boolean): number

- Defined in RCRTCEngine.ts:1695
停止远端用户自定义流数据的接收

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- tag: string
  
  自定义流全局唯一标签
- type: RCRTCMediaType
  
  远端自定义流类型
- mute: boolean
  
  true: 不接收 false: 接收
Returns number
{number} 错误码

muteRemoteStream

muteRemoteStream(userId: string, type: RCRTCMediaType, mute: boolean): number

- Defined in RCRTCEngine.ts:1283
停止远端用户音视频数据的接收

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- type: RCRTCMediaType
  
  媒体类型
- mute: boolean
  
  true: 不发送 false: 发送
Returns number
{number} 错误码

pauseAllAudioEffects

pauseAllAudioEffects(): number

- Defined in RCRTCEngine.ts:1436
暂停全部音效文件播放, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

pauseAudioEffect

pauseAudioEffect(effectId: number): number

- Defined in RCRTCEngine.ts:1428
暂停音效文件播放, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- effectId: number
  
  自定义全局唯一音效Id
Returns number
{number} 错误码

playAudioEffect

playAudioEffect(effectId: number, volume: number, loop: number): number

- Defined in RCRTCEngine.ts:1419
播放音效文件, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- effectId: number
  
  自定义全局唯一音效Id
- volume: number
  
  音效文件播放音量
- loop: number
  
  循环播放次数默认：1次
Returns number
{number}

publish

publish(type: RCRTCMediaType): number

- Defined in RCRTCEngine.ts:1023
加入房间后, 发布本地资源

memberof
RCRTCEngineInterface

Parameters
- type: RCRTCMediaType
  
  媒体资源类型
Returns number
{number} 错误码

publishCustomStream

publishCustomStream(tag: string): number

- Defined in RCRTCEngine.ts:1674
发布自定义流, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- tag: string
  
  自定义流全局唯一标签
Returns number
{number} 错误码

releaseAudioEffect

releaseAudioEffect(effectId: number): number

- Defined in RCRTCEngine.ts:1408
释放音效文件缓存, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- effectId: number
  
  自定义全局唯一音效Id
Returns number
{number}

removeLiveCdn

removeLiveCdn(url: string): number

- Defined in RCRTCEngine.ts:1301
移除 CDN 直播推流地址, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- url: string
  
  推流地址
Returns number
{number} 错误码

removeLiveMixView

removeLiveMixView(callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1262
移除合流视频窗口

memberof
RCRTCEngineInterface

Parameters
- callback: ((code: number) => {})
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeLocalCustomStreamView

removeLocalCustomStreamView(tag: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1665
移除自定义流预览窗口, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- tag: string
  
  自定义流全局唯一标签
- callback: ((code: number) => {})
  
  调用完成的回调
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeLocalView

removeLocalView(callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1226
移除本地视频渲染窗口

memberof
RCRTCEngineInterface

Parameters
- callback: ((code: number) => {})
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeRemoteCustomStreamView

removeRemoteCustomStreamView(userId: string, tag: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1716
移除远端自定义流View

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- tag: string
  
  自定义流全局唯一标签
- callback: ((code: number) => {})
  
  调用完成的回调
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeRemoteView

removeRemoteView(userId: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1245
移除远端视频窗口

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- callback: ((code: number) => {})
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

requestJoinSubRoom

requestJoinSubRoom(roomId: string, userId: string, autoLayout: boolean, extra?: string): number

- Defined in RCRTCEngine.ts:1751
向指定用户发送跨房间连麦请求

memberof
RCRTCEngineInterface

Parameters
- roomId: string
  
  房间 roomId
- userId: string
  
  远端用户 userId
- autoLayout: boolean
  
  是否将邀请人音视频资源发送到被邀请人房间中合流
- Optional extra: string
  
  附加信息, 可随消息发送给被邀请人
Returns number
{number} 错误码

responseJoinSubRoomRequest

responseJoinSubRoomRequest(roomId: string, userId: string, agree: boolean, autoLayout: boolean, extra?: string): number

- Defined in RCRTCEngine.ts:1775
响应跨房间连麦请求

memberof
RCRTCEngineInterface

Parameters
- roomId: string
  
  房间 roomId
- userId: string
  
  远端用户 userId
- agree: boolean
  
  是否同意加入副房间
- autoLayout: boolean
  
  是否将邀请人音视频资源发送到被邀请人房间中合流
- Optional extra: string
  
  附加信息, 可随消息发送给被邀请人
Returns number
{number} 错误码

resumeAllAudioEffects

resumeAllAudioEffects(): number

- Defined in RCRTCEngine.ts:1453
恢复全部音效文件播放, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

resumeAudioEffect

resumeAudioEffect(effectId: number): number

- Defined in RCRTCEngine.ts:1445
恢复音效文件播放, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- effectId: number
  
  自定义全局唯一音效Id
Returns number
{number} 错误码

resumeAudioMixing

resumeAudioMixing(): number

- Defined in RCRTCEngine.ts:1537
恢复混音, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

setAudioConfig

setAudioConfig(config: RCRTCAudioConfig): number

- Defined in RCRTCEngine.ts:1101
设置默认音频参数, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- config: RCRTCAudioConfig
  
  音频配置
Returns number
{number} 错误码

setAudioMixingPosition

setAudioMixingPosition(position: number): number

- Defined in RCRTCEngine.ts:1589
设置混音文件合流进度, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- position: number
  
  进度 0~1
Returns number
{number}

setCameraCaptureOrientation

setCameraCaptureOrientation(orientation: RCRTCCameraCaptureOrientation): number

- Defined in RCRTCEngine.ts:1209
设置摄像头采集方向

memberof
RCRTCEngineInterface

Parameters
- orientation: RCRTCCameraCaptureOrientation
  
  默认以 Portrait 角度进行采集
Returns number
{number}

setCameraExposurePositionInPreview

setCameraExposurePositionInPreview(x: number, y: number): number

- Defined in RCRTCEngine.ts:1200
设置在指定点区域测光

memberof
RCRTCEngineInterface

Parameters
- x: number
  
  曝光点，视图上的 x 轴坐标
- y: number
  
  曝光点，视图上的 y 轴坐标
Returns number
{number}

setCameraFocusPositionInPreview

setCameraFocusPositionInPreview(x: number, y: number): number

- Defined in RCRTCEngine.ts:1190
设置在指定点区域对焦

memberof
RCRTCEngineInterface

Parameters
- x: number
  
  对焦点，视图上的 x 轴坐标
- y: number
  
  对焦点，视图上的 y 轴坐标
Returns number
{number}

setCustomStreamVideoConfig

setCustomStreamVideoConfig(tag: string, config: RCRTCVideoConfig): number

- Defined in RCRTCEngine.ts:1636
设置自定义流参数, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- tag: string
  
  自定义流全局唯一标签
- config: RCRTCVideoConfig
  
  视频参数
Returns number
{number} 错误码

setLiveMixAudioBitrate

setLiveMixAudioBitrate(bitrate: number): number

- Defined in RCRTCEngine.ts:1358
设置直播合流音频码率, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- bitrate: number
  
  音频码率单位：kbps
Returns number
{number}

setLiveMixBackgroundColor

setLiveMixBackgroundColor(red: number, green: number, blue: number): number

- Defined in RCRTCEngine.ts:1331
设置直播合流布局背景颜色仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- red: number
  
  取值范围: 0 ~ 255
- green: number
  
  取值范围: 0 ~ 255
- blue: number
  
  0 ~ 255
Returns number
{number} 错误码

setLiveMixCustomAudios

setLiveMixCustomAudios(userIds: string[]): number

- Defined in RCRTCEngine.ts:1349
设置直播自定义音频流列表, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- userIds: string[]
  
  音频流列表
Returns number
{number} 错误码

setLiveMixCustomLayouts

setLiveMixCustomLayouts(layouts: RCRTCCustomLayout[]): number

- Defined in RCRTCEngine.ts:1340
设置直播混流布局配置, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- layouts: RCRTCCustomLayout[]
  
  混流布局列表
Returns number
{number}

setLiveMixInnerCdnStreamView

setLiveMixInnerCdnStreamView(ref: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1809
设置直播内置 cdn 流预览窗口

Parameters
- ref: string
  
  视频预览组件的 ref 值
- callback: ((code: number) => {})
  
  调用完成的回调
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void
0: 成功, 非0: 失败

setLiveMixLayoutMode

setLiveMixLayoutMode(mode: RCRTCLiveMixLayoutMode): number

- Defined in RCRTCEngine.ts:1310
设置直播合流布局类型, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- mode: RCRTCLiveMixLayoutMode
  
  布局类型
Returns number
{number} 错误码

setLiveMixRenderMode

setLiveMixRenderMode(mode: RCRTCLiveMixRenderMode): number

- Defined in RCRTCEngine.ts:1320
设置直播合流布局填充类型, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

memberof
RCRTCEngineInterface

Parameters
- mode: RCRTCLiveMixRenderMode
  
  填充类型
Returns number
{number} 错误码

setLiveMixVideoBitrate

setLiveMixVideoBitrate(bitrate: number, tiny: boolean): number

- Defined in RCRTCEngine.ts:1368
设置直播合流视频码率, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- bitrate: number
  
  音频码率单位：kbps
- tiny: boolean
Returns number
{number}

setLiveMixVideoFps

setLiveMixVideoFps(fps: RCRTCVideoFps, tiny: boolean): number

- Defined in RCRTCEngine.ts:1389
设置直播合流视频帧率, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- fps: RCRTCVideoFps
  
  帧率
- tiny: boolean
  
  是否小流 true:视频小流 false:视频大流，默认值 false
Returns number
{number}

setLiveMixVideoResolution

setLiveMixVideoResolution(width: number, height: number, tiny: boolean): number

- Defined in RCRTCEngine.ts:1379
设置直播合流视频分辨率, 仅供直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- width: number
  
  视频宽度
- height: number
  
  视频高度
- tiny: boolean
  
  是否小流 true:视频小流 false:视频大流，默认值 false
Returns number
{number}

setLiveMixView

setLiveMixView(ref: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1254
设置合流视频窗口

memberof
RCRTCEngineInterface

Parameters
- ref: string
  
  视频预览组件的 ref 值
- callback: ((code: number) => {})
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setLocalCustomStreamView

setLocalCustomStreamView(tag: string, ref: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1656
设置自定义流预览窗口, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- tag: string
  
  自定义流全局唯一标签
- ref: string
  
  视频预览组件的 ref 值
- callback: ((code: number) => {})
  
  调用完成的回调
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setLocalView

setLocalView(ref: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1218
设置本地视频渲染窗口

memberof
RCRTCEngineInterface

Parameters
- ref: string
  
  视频预览组件的 ref 值
- callback: ((code: number) => {})
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setRemoteCustomStreamView

setRemoteCustomStreamView(userId: string, tag: string, ref: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1706
设置远端自定义流View

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- tag: string
  
  自定义流全局唯一标签
- ref: string
  
  视频预览组件的 ref 值
- callback: ((code: number) => {})
  
  调用完成的回调
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setRemoteView

setRemoteView(userId: string, ref: string, callback: ((code: number) => {})): void

- Defined in RCRTCEngine.ts:1236
设置远端视频窗口

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- ref: string
  
  视频预览组件的 ref 值
- callback: ((code: number) => {})
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setVideoConfig

setVideoConfig(config: RCRTCVideoConfig, tiny: boolean): number

- Defined in RCRTCEngine.ts:1111
设置默认视频参数, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- config: RCRTCVideoConfig
  
  视频配置
- tiny: boolean
Returns number
{number} 错误码

setWatermark

setWatermark(path: string, positionX: number, positionY: number, zoom: number): number

- Defined in RCRTCEngine.ts:1820
设置水印

Parameters
- path: string
  
  水印图片
- positionX: number
  
  水印的位置,x坐标,参数取值范围 0 ~ 1，浮点型
- positionY: number
  
  水印的位置,y坐标,参数取值范围 0 ~ 1，浮点型
- zoom: number
  
  图片缩放系数,参数取值范围 0 ~ 1 SDK 内部会根据视频分辨率计算水印实际的像素位置和尺寸。
Returns number
接口调用状态码 0: 成功, 非0: 失败

startNetworkProbe

startNetworkProbe(): number

- Defined in RCRTCEngine.ts:1826
开始网络探测

Returns number
接口调用状态码 0: 成功, 非0: 失败

stopAllAudioEffects

stopAllAudioEffects(): number

- Defined in RCRTCEngine.ts:1470
停止全部音效文件播放, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

stopAudioEffect

stopAudioEffect(effectId: number): number

- Defined in RCRTCEngine.ts:1462
停止音效文件播放, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- effectId: number
  
  自定义全局唯一音效Id
Returns number
{number} 错误码

subscribe

subscribe(userId: string, type: RCRTCMediaType, tiny: boolean): number

- Defined in RCRTCEngine.ts:1042
memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- type: RCRTCMediaType
  
  媒体资源类型
- tiny: boolean
  
  视频小流, true:订阅视频小流 false:订阅视频大流
Returns number
number 错误码

subscribeCustomStream

subscribeCustomStream(userId: string, tag: string, type: RCRTCMediaType, tiny: boolean): number

- Defined in RCRTCEngine.ts:1728
加入房间后, 订阅远端用户发布的自定义流

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- tag: string
  
  自定义流全局唯一标签
- type: RCRTCMediaType
  
  远端自定义流类型
- tiny: boolean
  
  true: 小流 false: 大流
Returns number
{number} 错误码

subscribeLiveMix

subscribeLiveMix(type: RCRTCMediaType, tiny: boolean): number

- Defined in RCRTCEngine.ts:1083
订阅主播合流资源, 仅供直播观众用户使用

memberof
RCRTCEngineInterface

Parameters
- type: RCRTCMediaType
  
  媒体资源类型
- tiny: boolean
  
  是否视频小流 true:订阅视频小流 false:订阅视频大流
Returns number
{number} 错误码

subscribes

subscribes(userIds: string[], type: RCRTCMediaType, tiny: boolean): number

- Defined in RCRTCEngine.ts:1053
加入房间后, 订阅远端多个用户发布的资源

memberof
RCRTCEngineInterface

Parameters
- userIds: string[]
  
  远端用户 userId 数组
- type: RCRTCMediaType
  
  媒体资源类型
- tiny: boolean
  
  是否视频小流 true:订阅视频小流 false:订阅视频大流
Returns number
{number} 错误码

switchCamera

switchCamera(): number

- Defined in RCRTCEngine.ts:1156
切换前后摄像头

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

unpublish

unpublish(type: RCRTCMediaType): number

- Defined in RCRTCEngine.ts:1032
加入房间后, 取消发布已经发布的本地资源

memberof
RCRTCEngineInterface

Parameters
- type: RCRTCMediaType
  
  媒体资源类型
Returns number
{number} 错误码

unpublishCustomStream

unpublishCustomStream(tag: string): number

- Defined in RCRTCEngine.ts:1683
取消发布自定义流, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- tag: string
  
  自定义流全局唯一标签
Returns number
{number} 错误码

unsubscribe

unsubscribe(userId: string, type: RCRTCMediaType): number

- Defined in RCRTCEngine.ts:1063
加入房间后, 取消订阅远端单个用户发布的资源

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- type: RCRTCMediaType
  
  媒体资源类型
Returns number
{number} 错误码

unsubscribeCustomStream

unsubscribeCustomStream(userId: string, tag: string, type: RCRTCMediaType): number

- Defined in RCRTCEngine.ts:1739
加入房间后, 取消订阅远端用户发布的自定义流

memberof
RCRTCEngineInterface

Parameters
- userId: string
  
  远端用户 userId
- tag: string
  
  自定义流全局唯一标签
- type: RCRTCMediaType
  
  远端自定义流类型
Returns number
{number} 错误码

unsubscribeLiveMix

unsubscribeLiveMix(type: RCRTCMediaType): number

- Defined in RCRTCEngine.ts:1092
取消订阅主播合流资源, 仅供直播观众用户使用

memberof
RCRTCEngineInterface

Parameters
- type: RCRTCMediaType
  
  媒体资源类型
Returns number
{number} 错误码

unsubscribes

unsubscribes(userIds: string[], type: RCRTCMediaType): number

- Defined in RCRTCEngine.ts:1073
加入房间后, 取消订阅远端多个用户发布的资源

memberof
RCRTCEngineInterface

Parameters
- userIds: string[]
  
  远端用户 userId 数组
- type: RCRTCMediaType
  
  媒体资源类型
Returns number
{number} 错误码

whichCamera

whichCamera(): RCRTCCamera

- Defined in RCRTCEngine.ts:1164
获取当前使用摄像头位置

memberof
RCRTCEngineInterface

Returns RCRTCCamera
{RCRTCCamera} 摄像头类型

混音 Methods

pauseAudioMixing

pauseAudioMixing(): number

- Defined in RCRTCEngine.ts:1529
暂停混音, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

startAudioMixing

startAudioMixing(path: string, mode: RCRTCAudioMixingMode, playback: boolean, loop: number): number

- Defined in RCRTCEngine.ts:1511
开始混音, 仅支持混合本地音频文件数据, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Parameters
- path: string
  
  仅支持本地音频文件
- mode: RCRTCAudioMixingMode
  
  混音行为模式
- playback: boolean
  
  是否本地播放，默认 true
- loop: number
  
  循环混音或者播放次数，默认播放 1 次
Returns number
{number} 错误码

stopAudioMixing

stopAudioMixing(): number

- Defined in RCRTCEngine.ts:1520
停止混音, 仅供会议用户或直播主播用户使用

memberof
RCRTCEngineInterface

Returns number
{number} 错误码

Generated using TypeDoc