更新记录

1.3.0(2021-07-23)

升级iOS sdk至3.4.6

1.2.9(2021-07-12)

更新sdk至官网最新

查看更多

平台兼容性

Android Android CPU类型 iOS
适用版本区间:4.4 - 11.0 armeabi-v7a:未测试,arm64-v8a:未测试,x86:未测试 适用版本区间:9 - 14

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


tx-agora

声网agora sdk方法集锦

TX-AgoraEngineKit

函数名 参数 说明
enableAudio 开启音频
enableVideo 开启视频
disableAudio 禁用音频
disableVideo 禁用视频
setAudioProfile profile scenario 参考agora文档 设置声音的profile
enableInEarMonitoring true or false 开启耳返
setInEarMonitoringVolume 1-100的数值 设置耳返音量
setChannelProfile 0:聊天 1:直播 2:游戏 设置模式
setClientRole 1主播 2观众 设置用户角色
playEffect { id:101, filePath:"", loopCount:0, pitch:1, pan:0, gain:50, publish:true } id:soundId filePath:url路径或者本地音效文件路径 loopCount:循环次数:0播放1次。 1 播放2次 -1循环播放 pitch:设置音频效果的音调。该值的范围在0.5到2之间。默认值为1(音高不变)。值越低,音调越低。 pan:设置音频效果的空间位置。值的范围在-1.0和1.0之间。 gain:设置音频效果的音量。该值的范围为0.0到100.0(默认值)。值越低,音频效果的音量越小。 publish:设置是否将指定的音频效果发布到远程流:
stopAllEffects 停止播放所有音频效果
stopEffect 参数,声音的id 音频效果的声音ID。每个音频效果都有一个唯一的ID。
adjustAudioMixingVolume 整形 音频混合音量。该值的范围为0到100(默认值)。
startAudioMixing {. filePath:"", loopBack:false, replace:false, cycle:-1 } filePath:url路径或者本地音效文件路径. loopBack:设置哪些用户可以听到音频混合:true:只有本地用户可以听到混音。false:两个用户都能听到混音。 replace:true:只发布指定的音频文件;不发布麦克风接收到的音频流。
false:本地音频文件与来自麦克风的音频流混合。 cycle:正整数:播放循环数。*-1:无限播放循环。
stopAudioMixing 停止audioMixing
setLocalVoiceReverbPreset 整形 AgoraAudioReverbPresetOff = 0, AgoraAudioReverbPresetPopular = 1,AgoraAudioReverbPresetRnB = 2,AgoraAudioReverbPresetRock = 3,AgoraAudioReverbPresetHipHop = 4, AgoraAudioReverbPresetVocalConcert = 5,AgoraAudioReverbPresetKTV = 6,AgoraAudioReverbPresetStudio = 7
leaveChannel 离开频道
destroyRtc 释放AgoraRtcEngineKit对象资源
switchCamera 切换摄像头
setDefaultAudioRouteToSpeakerphone Bool 设置默认音频路由
setEnableSpeakerphone Bool 设置是否将音频路由到扬声器或听筒
isSpeakerphoneEnabled 无,返回值Bool 检查扬声器是否已启用
enableAudioVolumeIndication 参数1 int 参数2 int,参数3 bool 是否开启音频检测,具体传值参考agora文档
adjustRecordingSignalVolume 参数int 录音音量。值的范围在0到400之间
adjustUserPlaybackSignalVolume 参数1 int 参数2 int 指定的远程用户的播放音量。值的范围为0到100
adjustPlaybackSignalVolume 参数int 所有远程用户的播放音量。值的范围为0到400
enableLocalAudio 参数bool 启用本地音频模块,即启动本地音频捕获和处理
enableLocalVideo 参数bool 启用设置是否启用/禁用本地视频,包括捕获器、渲染器和发送器
muteLocalAudioStream 参数bool 发送或停止本地音频流
muteLocalVideoStream 参数bool 发送或停止本地视频流
muteRemoteAudioStream 参数1 int 参数2 bool 接收或停止接收指定的远程用户的音频流
muteRemoteVideoStream 参数1 int 参数2 bool 设置是否接收/停止接收指定远程用户的视频流
muteAllRemoteAudioStreams 参数 bool 是否接收/停止接收所有远程音频流
muteAllRemoteVideoStreams 参数 bool 是否接收/停止接收所有远程视频流
setDefaultMuteAllRemoteAudioStreams 参数 bool 设置默认情况下是否接收/停止接收所有远程音频流
setDefaultMuteAllRemoteVideoStreams 参数 bool 设置默认情况下是否接收/停止接收所有远程视频流
setCameraTorchOn 参数 bool 是否开启闪光灯
isCameraTorchSupported 是否支持闪光灯
startAudioMixing {path:"",loopback:true,replace:true,cycle:0} 开始混音
stopAudioMixing 停止混音
pauseAudioMixing 暂停混音
adjustAudioMixingVolume 整数 调整混音大小
adjustAudioMixingPlayoutVolume 整数 调整本地播放的音频混音音量
adjustAudioMixingPublishVolume 整数 调整要发布的音频混音音量(发送给其他用户)
getAudioMixingPlayoutVolume 获取用于本地播放的音频混合音量
getAudioMixingPublishVolume 获取要发布的音频混音音
getAudioMixingDuration 检索音频混合的持续时间(毫秒)
setRemoteRenderMode 参数1(agora的uid 整数)参数二(rednerModel整数)参数三(mirrorMode整数)
setLocalRenderMode 设置显示的状态(整数)
setAudioMixingPosition 整数

推流组件:TX-AgoraView

函数名 参数 说明
startPreview 开启预览
stopPreview 停止预览
joinChannel 加入频道
leaveChannel 离开频道
switchCamera 切换摄像头
joinChannelWithInfo {channelProfile:xxx,role:xxx,configWidth:xxx,configHeight:xxx,frameRate:xxx,bitrate:xxx,model:xxx,token:xxx,channelId:xxx,uid:xxx,appId:xxx} 支持的值见左边

推流组件 TX-ScreenView

函数名 参数 说明
joinChannel audio, video 开启本地声音或者视频预览

TX-AgoraView常见属性

属性名 说明
uid 推流的uid
enableAudio 开启音频
enableVideo 开启视频
token 加密token
channelId 频道id
audioProfile AgoraAudioProfile
clientRole 用户角色
scenario AgoraAudioScenario
inEarMonitoring 是否开启耳返
earMonitoringVolume 耳返音量
remoteUid 远程用户uid
contrastLevel 美颜属性
lighteningLevel 美颜属性
smoothneesLevel 美颜属性
rednessLevel 美颜属性
statechange 状态回调
configWidth 视频的宽度
configHeight 视频的高度
frameRate 帧速率
bitrate 码率
model AgoraVideoOutputOrientationModeFixedLandscape = 1. AgoraVideoOutputOrientationModeFixedPortrait = 2
publishStreamUrl 将流同步到自己的服务器地址
localUid 本地拉流因为不走agora的userJoin的回调,需要通过这个开启本地预览

跑通代码需要自定义基座,并且使用ios和安卓真机运行

agora全球实时音视频开创者,每月免费赠送1万分钟实时音频,配合agora的rtm轻松实现直播逻辑,欢迎体验

快速集成

1.前往https://www.agora.io/cn/注册账号

2.按照官网要求实名认证

3.创建应用

4.查找应用的App ID。如图所示

5.下载插件示例工程,配置appid

6.制作自定义基座,主要步骤如图

7.运行例子程序开始体验

隐私、权限声明

1. 本插件需要申请的系统权限列表:

NSMicrophoneUsageDescription NSCameraUsageDescription

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

agora采集音视频信息,有关文档见https://www.agora.io/cn

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问