RTCEngine.ag

继承关系

RTCEngine

简介

<# nil #>

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

构造方法

RTCEngine(number rtcType, number appId) 构造方法

API

joinChannel()

加入频道

leaveChannel()

离开频道

setChannelKey(string key)

更新动态key

changeRole(string role)

切换角色

handleForeground()

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

handleBackground()

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

muteLocalAudio(boolean mute)

是否发送静音数据

muteLocalMicRecording(boolean mute)

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

muteRemoteAudio(boolean mute, number uid)

设置指定用户是否静音

muteAllRemoteAudio(boolean mute)

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

adjustMicRecordingVolume( volume)

调节麦克风音量

audioVolumeReportInterval(number interval, number smooth)

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

audioProfile(number profile, number scenario)

设置音频编码配置

enableAudioEffect(boolean enable)

是否开启音效处理

setAudioEffect(number type, number index, number value)

设置音效

enableAudioLoopback(boolean enable)

是否开启耳返

enableEchoCancellation(boolean enable)

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

playAudioEffect(string audioID, string filePath, boolean loop, boolean publish)

播放音效

stopAudioEffect(string audioID)

停止播放音效

stopAllAudioEffect()

停止播放所有音效

setVolumeEffects(string id, number volume)

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

playBGM(string url, boolean publish, number repeat)

设置背景音乐播放

pauseBGM()

暂停背景音乐播放

resumeBGM()

恢复背景音乐播放

stopBGM()

停止背景音乐播放

getBGMPosition()

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

getBGMDuration()

获取背景音乐总时长

enableRecordAudioReport(boolean enable) ❌

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

muteLocalVideo(boolean mute)

是否禁止视频上行

muteRemoteVideo(boolean mute, number uid)

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

muteAllRemoteVideo(boolean mute)

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

setRemoteVideoStreamType(number uid, number type)

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

startAndPushVideo(string file, View surfaceView)

播放视频并推流

resumeVideo(View surfaceView)

恢复播放视频

pauseVideo()

暂停视频

stopVideo()

停止视频

pushVideoBuffer(DataBuffer buffer, number time)

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

pushExternalAudioBuffer(DataBuffer data)

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

changeVideoEncodeParam(Size resolution, number frameRate, number bitrate)

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

setRemoteVideoCanvas(View container, number uid)

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

createSendStreamMessage(string message)

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

rtcType()

获取服务商类型

appId(string appId)

设置APP标识

appId()

获取APP标识

channelKey(string key)

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

channelKey()

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

channelId(string cid)

设置频道ID

channelId()

获取频道ID

userId(number uid)

设置用户ID

userId()

获取用户ID

role(number type)

设置用户角色

role()

获取用户角色

musicVolume(number volume)

设置背景音乐音量

musicVolume()

获取背景音乐音量

enableVideo(boolean enable)

设置是否开启视频模式

enableVideo()

获取是否开启视频模式

videoBitRate(number bitrate)

设置视频码率

videoBitRate()

获取视频码率

videoFrameRate(number frameRate)

设置视频帧率

videoFrameRate()

获取视频帧率

videoResolution(Size resolution)

设置视频分辨率

videoResolution()

获取视频分辨率

audioSampleRate(number SamplingRate)

设置音频采样率

audioSampleRate()

获取音频采样率

audioChannels(number channels)

设置声道数

audioChannels()

获取声道数

enableReconnect(boolean enable)

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

enableReconnect()

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

audioRouteToSpeakerphone(boolean useSpeakerphone)

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

audioRouteToSpeakerphone()

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

enableV3Log(boolean enable)

设置是否启用V3日志

enableV3Log()

获取是否启用V3日志

rtcLogPath(string path)

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

rtcLogPath()

获取SDK日志路径

businessType(number type)

设置业务类型

businessType()

获取业务类型

videoInitBitRate(number bitrate)

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

videoInitBitRate()

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

hardwareDecode(boolean useHardware)

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

hardwareDecode()

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

preferFrameRate(boolean prefer)

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

preferFrameRate()

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

audioMixable(boolean mixable)

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

audioMixable()

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

disableIOAudioUnitBus1(boolean disable)

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

disableIOAudioUnitBus1()

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

IOAudioUnitMode(number mode)

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

IOAudioUnitMode()

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