RTCEngine 类

Lua RTC,包含声网，微辣，腾讯

变量

_priveta_class_name : string

name : string

方法

joinChannel

加入频道

返回值

  • 返回0成功，否则失败 : number

leaveChannel

离开频道

返回值

  • 返回0成功，否则失败 : number

setChannelKey

更新动态key

参数

返回值

changeRole

切换角色

参数

  • role : String 主播 1 观众2 （上下麦场景）

返回值

handleForeground

App进入前台时需要做的处理

返回值

handleBackground

App退入后台时需要做的处理

返回值

muteLocalAudio

是否发送静音数据

参数

  • mute : boolean true 发送静音, false 不发送静音

返回值

muteLocalMicRecording

是否禁止麦克风录音 (只是mute麦克风声音, 而muteLocalAudio会mute本地所有声音)

参数

  • mute : boolean true 禁止, false 不禁止

返回值

muteRemoteAudio

设置指定用户是否静音

参数

  • mute : boolean true 静音, false 不静音
  • uid : number 指定用户ID

返回值

muteAllRemoteAudio

设置所有远端用户是否静音

参数

  • mute : boolean true 静音, false 不静音

返回值

adjustMicRecordingVolume

调节麦克风音量

参数

返回值

audioVolumeReportInterval

设置声音音量回调间隔（单位: ms）, 建议值 >=100ms, 如果<100ms很有可能不会回调, 如果禁止回调设为0即可

参数

  • interval : number 回调时间间隔
  • smooth : number 精度（仅Android有效）

返回值

audioProfile

设置音频编码配置

参数

  • profile : number 音频质量, 取值范围[0, 5]
  • scenario : number scenario：设置音频应用场景 (备注：仅声网支持此参数)

返回值

enableAudioEffect

是否开启音效处理

参数

  • enable : boolean true 开启, false 关闭

返回值

setAudioEffect

设置音效

参数

  • type : number 1 表示降噪, 2 表示混响, 3 表示均衡器
  • index : number 索引值
  • value : number 调节值

返回值

enableAudioLoopback

是否开启耳返

参数

  • enable : boolean true 开启, false 关闭

返回值

enableEchoCancellation

是否启用回声消除（仅iOS可用）

参数

  • enable : boolean true 开启, false 关闭

返回值

playAudioEffect

播放音效

参数

  • audioID : string 音效ID
  • filePath : string 音效文件路径
  • loop : boolean 是否循环播放
  • publish : boolean 是否推到远端

返回值

stopAudioEffect

停止播放音效

参数

  • audioID : string 音效ID

返回值

stopAllAudioEffect

停止播放所有音效

返回值

setVolumeEffects

实时调整播放音效文件音量

参数

  • id : string 指定音效的ID
  • volume : number 音量大小 取值范围为 [0.0, 1.0]

返回值

playBGM

设置背景音乐播放

参数

  • url : string 音乐文件路径
  • publish : boolean true 推流到远端, false 只是本地播放
  • repeat : number 循环播放次数, -1表示无限循环

返回值

pauseBGM

暂停背景音乐播放

返回值

resumeBGM

恢复背景音乐播放

返回值

stopBGM

停止背景音乐播放

返回值

getBGMPosition

获取背景音乐当前播放进度

返回值

  • 返回值单位：s : number

getBGMDuration

获取背景音乐总时长

返回值

  • 返回值单位：s : number

enableRecordAudioReport

是否开启原始声音回调（eg: 获取连线主播的声音）

参数

  • enable : boolean true 开启, false 关闭

返回值

muteLocalVideo

是否禁止视频上行

参数

  • mute : boolean true 禁止, false 允许

返回值

muteRemoteVideo

停止拉取指定用户的视频流

参数

  • mute : boolean true 停止拉取, false 继续拉取
  • uid : number 指定用户ID

返回值

muteAllRemoteVideo

停止拉取所有远端的视频流

参数

  • mute : boolean true 停止拉取, false 继续拉取

返回值

setRemoteVideoStreamType

设置指定用户视频流的大小

参数

  • uid : number 用户ID
  • type : number 0 大流, 1 小流

返回值

startAndPushVideo

播放视频并推流

参数

  • file : string 视频路径(本地)
  • surfaceView : View 用于渲染视频的View

返回值

resumeVideo

恢复播放视频

参数

  • surfaceView : View 用于渲染视频的View

返回值

pauseVideo

暂停视频

返回值

stopVideo

停止视频

返回值

pushVideoBuffer

将视频数据推到远端（仅iOS可用）

参数

  • buffer : DataBuffer 视频数据
  • time : number 当前视频帧对应的时间

返回值

pushExternalAudioBuffer

将外部音频数据混合到第三方SDK采集的数据中（仅iOS可用）

参数

返回值

changeVideoEncodeParam

修改推流视频数据的编码参数

参数

  • resolution : Size 视频分辨率
  • frameRate : number 视频帧率
  • bitrate : number 视频码率

返回值

setRemoteVideoCanvas

设置视频画布用于展示拉到的视频流

参数

  • container : View 用来承载视频画布
  • uid : number 用户ID

返回值

createSendStreamMessage

创建并发送数据流 (注: 这里包装了创建和发送方法。)

参数

  • message : string 要发送的数据流

返回值

rtcType

获取服务商类型

返回值

  • : number 1: 声网, 2: 微辣, 3: 腾讯

appId

设置APP标识

参数

  • appId : string App标识

返回值

appId

获取APP标识

返回值

  • APP标识 : string

channelKey

设置加入频道需要的动态key

参数

  • key : string 动态key

返回值

channelKey

获取加入频道需要的动态key

返回值

  • 动态key : string

channelId

设置频道ID

参数

  • cid : string 频道ID

返回值

channelId

获取频道ID

返回值

  • 返回频道ID : string

userId

设置用户ID

参数

  • uid : number 用户ID

返回值

userId

获取用户ID

返回值

  • 返回用户ID : number

role

设置用户角色

参数

  • type : number 1: 主播, 2: 观众。（一般加入通道前，初始化的时候设置）

返回值

role

获取用户角色

返回值

  • : number 1: 主播, 2: 观众。

musicVolume

设置背景音乐音量

参数

  • volume : number 背景音乐音量, 范围: 0 ~ 1

返回值

musicVolume

获取背景音乐音量

返回值

  • 背景音乐音量 : number 0 ~ 1

enableVideo

设置是否开启视频模式

是否开启视频模式, 如果关闭则既不能推流也不能拉流，默认为true

参数

  • enable : boolean 是否开启视频模式

返回值

enableVideo

获取是否开启视频模式

返回值

  • 返回是否开启视频模式 : boolean

videoBitRate

设置视频码率

参数

  • bitrate : number 视频码率

返回值

videoBitRate

获取视频码率

返回值

  • 视频码率 : number

videoFrameRate

设置视频帧率

参数

  • frameRate : number 视频帧率

返回值

videoFrameRate

获取视频帧率

返回值

  • 视频帧率 : number

videoResolution

设置视频分辨率

参数

  • resolution : Size 视频分辨率

返回值

videoResolution

获取视频分辨率

返回值

  • 视频分辨率 : Size

audioSampleRate

设置音频采样率

参数

  • SamplingRate : number 音频采样率

返回值

audioSampleRate

获取音频采样率

返回值

  • 返回音频采样率 : number

audioChannels

设置声道数

参数

  • channels : number 声道数

返回值

audioChannels

获取声道数

返回值

  • 返回声道数 : number

enableReconnect

设置与服务器断开连接时是否允许重连

参数

  • enable : boolean 设置是否允许重连

返回值

enableReconnect

获取与服务器断开连接时是否允许重连

返回值

  • 返回是否允许重连 : boolean

audioRouteToSpeakerphone

设置声音是否从扬声器输出, 默认true, 即从扬声器输出

参数

  • useSpeakerphone : boolean 是否从扬声器输出

返回值

audioRouteToSpeakerphone

获取声音是否从扬声器输出

返回值

  • 返回是否从扬声器输入 : boolean

enableV3Log

设置是否启用V3日志

参数

  • enable : boolean 设置是否启用V3日志

返回值

enableV3Log

获取是否启用V3日志

返回值

  • 返回是否启用V3日志 : boolean

rtcLogPath

设置SDK日志路径（含日志文件名）

参数

  • path : string SDK日志路径（含日志文件名）

返回值

rtcLogPath

获取SDK日志路径

返回值

  • SDK日志路径（含日志文件名） : string

businessType

设置业务类型

参数

  • type : number 0: None, 1: 好友快聊, 2: 随机快聊, 3: 广场视频快聊, 4: 派对,5: 群视频, 6: 广场音频快聊, 7: 抓娃娃, 8: 聊天室, 9: 才艺房间,13: 快聊房间 (安卓本地预留了两个业务, 故从13开始)

返回值

businessType

获取业务类型

返回值

  • 返回业务类型 : number

videoInitBitRate

声网属性，设置视频初始码率（iOS）

参数

  • bitrate : number 视频初始码率

返回值

videoInitBitRate

声网属性，获取视频初始码率（iOS）

返回值

  • 视频初始码率 : number

hardwareDecode

声网属性，设置是否使用硬解码

参数

  • useHardware : boolean 是否使用硬解码

返回值

hardwareDecode

声网属性，获取是否使用硬解码

返回值

  • 是否使用硬解码 : boolean

preferFrameRate

声网属性，设置是否降低图像质量来优先保证视频流畅度

参数

  • prefer : boolean 设置是否降低图片质量提高流畅度

返回值

preferFrameRate

声网属性，获取是否降低图像质量来优先保证视频流畅度

返回值

  • 返回是否降低图像质量来优先保证视频流畅度 : boolean

audioMixable

声网属性，设置音频可否混合, 默认true

参数

  • mixable : boolean 音频可否混合, 默认true

返回值

audioMixable

声网属性，获取音频可否混合, 默认true

返回值

  • 获取音频是否可混合 : boolean

disableIOAudioUnitBus1

微辣属性，设置是否禁止 I/O AudioUnit 声音采集, 默认为false

参数

  • disable : boolean 是否禁止I/O AudioUnit

返回值

disableIOAudioUnitBus1

微辣属性，设置是否禁止 I/O AudioUnit 声音采集, 默认为false（仅iOS可用）

返回值

  • 返回是否禁止I : boolean O AudioUnit

IOAudioUnitMode

微辣属性，设置主播和观众的 I/O AudioUnit 模式配置（仅iOS可用

参数

  • mode : number 0: 主播 vpIO 观众remoteIO, 1: 主播和观众均remoteIO, 2: 主播和观众均vpIO

返回值

IOAudioUnitMode

微辣属性，获取主播和观众的 I/O AudioUnit 模式配置（仅iOS可用）

返回值

  • : number 0: 主播 vpIO 观众remoteIO, 1: 主播和观众均remoteIO, 2: 主播和观众均vpIO

userSign

腾讯属性，设置腾讯进房key

参数

  • key : string 进房key

返回值

userSign

腾讯属性，获取腾讯进房key

返回值

  • 进房key : string