快速集成SDK

通过集成SDK，可以快速实现实时音视频通话。

1. 直接运行Web端Demo源码

可以参考 angular、react、react Typescript、vue、纯JS Demo源码，Demo中集成了基础的音视频通话、桌面分享等功能，了解不通js框架的Demo接入示例。
可以参考 WEB Demo源码，Demo中集成了视频会议、开关摄像头、开关麦克风、开关扬声器、开关连麦、屏幕分享、录制、旁路推流、分享链接等功能，并对电脑、手机移动端UI做了适配。

由于浏览器的安全策略对除 127.0.0.1 以外的 HTTP 地址作了限制，Web SDK 仅支持 HTTPS 协议或者 http://localhost（http://127.0.0.1），请勿使用 HTTP 协议部署你的项目。

2. 引入SDK

选择如下任意一种方法引入URTC Web SDK：

2.1 使用`npm`引入SDK

将 sdk 使用 ES6 语法作为模块引入。使用该方法需要先安装 npm，详见 npm快速入门。

1）使用npm或 Yarn 集成 WEB SDK:

npm install --save urtc-sdk
或    
yarn add urtc-sdk

2）项目中引入SDK并创建 client

import UCloudRTC from 'urtc-sdk';

2.2 直接引入SDK

下载URTC Web SDK，将 sdk 中 lib 目录下的 index.js 使用 script 标签引入。

<script type="text/javascript" src="index.js"><script>

2. 开发语言以及系统要求

开发语言：C++
系统要求：Windows 7 及以上版本的 Windows 系统

3. 开发环境

Visual Studio 2015 及其它c++ 开发环境
Win32 Platform

4. 搭建开发环境

导入 SDK

1）将 sdk/include 目录添加到项目的 INCLUDE 目录下。
2）将 sdk/lib 目录放入项目的 LIB 目录下。
3）将 sdk/dll 下的 dll 文件复制到你的可执行文件所在的目录下。

2. 开发语言以及系统要求

开发语言：Java
系统要求：Android 4.1及以上版本的移动设备
Android SDK API：等级 16 或以上
ABI支持：armeabi-v7a、arm64-v8a、x86、x86_64

4. 搭建开发环境

下载urtc android SDK包，SDK包为aar格式，名称为ucloudrtclib开头加版本号，可以参考github上的接入demo。
将aar 文件拷贝到自己的lib 目录下，然后添加到lib 中，修改要使用sdk模块目录下build.gradle，确保已经添加了如下依赖，如下所示：

    dependencies {
    implementation (name: 'ucloudrtclib-1.0.1', ext: 'aar')

如果项目混淆，请在混淆中添加一下urtc 混淆规则。

-keep class com.ucloudrtclib.sdkengine.**{*;}
-keep class com.ucloudrtclib.sdkengine.define.*{*;}
-keep enum com.ucloudrtclib.sdkengine.define.*{*;}

-keepclassmembers class com.ucloudrtclib.sdkengine.UCloudRtcSdkEnv {
    public static <methods>;
}

-keepclassmembers interface com.ucloudrtclib.sdkengine.UCloudRtcSdkEngine {
    public <methods>;
    public static <methods>;
}
-keep class org.webrtc.** {
    *;
}

添加权限

在 Android 6.0 (API 23)开始，用户需要在应用运行时授予权限，而不是在应用安装时授予，并分为正常权限和危险权限两种类型。
在实时音视频SDK 中，用户需要在进入音视频通话房间前动态申请 CAMERA、RECORD\_AUDIO、WRITE\_EXTERNAL\_STORAGE权限，具体可以参考Android官方文档。

<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />
<uses-feature android:glEsVersion="0x00020000" android:required="true" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.FLASHLIGHT" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.BLUETOOTH" />

5. 初始化

5.1 引擎环境初始化

主要配置android context sdkmode以及AppID ，测试用的SEC\_KEY，日志等级。

public class UCloudRtcApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Log.d(TAG, "onCreate: " + this);
        if (TextUtils.equals(getCurrentProcessName(this), getPackageName())) {
            init();//判断成功后才执行初始化代码
        }
    }

    private void init(){
    sContext = this;
    //初始化sdk环境
    UCloudRtcSdkEnv.initEnv(getApplicationContext());
    //打印日志到logcat
    UCloudRtcSdkEnv.setWriteToLogCat(true);
    //开启log上报
    UCloudRtcSdkEnv.setLogReport(true);
    //设置log级别
    UCloudRtcSdkEnv.setLogLevel(UCloudRtcSdkLogLevel.UCLOUD_RTC_SDK_LogLevelInfo);
    //设置sdk模式（测试模式）
    UCloudRtcSdkEnv.setSdkMode(UCloudRtcSdkMode.UCLOUD_RTC_SDK_MODE_TRIVAL);
    //重连次数
    UCloudRtcSdkEnv.setReConnectTimes(60);
    //设置测试模式的用户私有秘钥
    UCloudRtcSdkEnv.setTokenSeckey(CommonUtils.APP_KEY);//替换成自己的token

    WindowManager windowManager = (WindowManager) getSystemService(Context.WINDOW_SERVICE);
    DisplayMetrics outMetrics = new DisplayMetrics();
    windowManager.getDefaultDisplay().getMetrics(outMetrics);
    CommonUtils.mItemWidth = (outMetrics.widthPixels - UiHelper.dipToPx(this, 15)) / 3;
    CommonUtils.mItemHeight = CommonUtils.mItemWidth;
    //初始化bugly日志
    CrashReport.initCrashReport(getApplicationContext(), "9a51ae062a", true);
    }
}

5.2 继承实现`UCloudRtcSdkEventListener` 实现事件处理

UCloudRtcSdkEventListener eventListener = new UCloudRtcSdkEventListener() {
        @Override
        public void onServerDisconnect() {
            runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    ToastUtils.shortShow(RoomActivity.this, " 服务器已断开");
                    stopTimeShow();
                    onMediaServerDisconnect() ;
                }
            });
        }

        @Override
        public void onJoinRoomResult(int code, String msg, String roomid) {
            runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    if (code == 0) {
                        ToastUtils.shortShow(RoomActivity.this, " 加入房间成功");
                        startTimeShow();
                    }else {
                        ToastUtils.shortShow(RoomActivity.this, " 加入房间失败 "+
                                code +" errmsg "+ msg);
                        Intent intent = new Intent(RoomActivity.this, ConnectActivity.class);
                        onMediaServerDisconnect() ;
                        startActivity(intent) ;
                        finish();
                    }

                }
            });
        }

5.3 获取SDK 引擎并进行基础配置

// 设置纯音频模式
sdkEngine.setAudioOnlyMode(true) ; 
// 设置摄像头是否发布
sdkEngine.configLocalCameraPublish(false) ; 
// 设置音频是否发布，用于让sdk判断自动发布的媒体类型
sdkEngine.configLocalAudioPublish(true) ; 
// 设置桌面是否发布，作用同上
sdkEngine.configLocalScreenPublish(false) ; 
// 设置房间类型，有两种 实时会议（小班课） 和互动直播（大班课）类型可选 ，默认为实时会议（小班课）
sdkEngine.setClassType(UCloudRtcSdkRoomType.UCLOUD_RTC_SDK_ROOM_SMALL) ; 
// 如果是互动直播（大班课）模式，需要设置用户权限：仅上行发布、仅下行订阅、双向发布订阅权限；实时会议（小班课）会忽略这个配置
sdkEngine.setStreamRole(URTCSdkStreamRole.URTC_SDK_STREAM_ROLE_BOTH);
// 是否自动发布
sdkEngine.setAutoPublish(true) ; 
// 是否自动订阅
sdkEngine.setAutoSubscribe(true) ;
// 摄像头输出等级
sdkEngine.setVideoProfile(UCloudRtcSdkVideoProfile.matchValue(mVideoProfile)) ;

2. 开发语言以及系统要求

支持语言：objective-c、swift;
Apple设备：iPhone最低支持iPhone5；
系统版本：最低支持iOS 9.0；
CPU架构：支持arm64、armv7、x86架构，支持真机和模拟器运行；
其他：v1.5.8及以后版本支持bitcode。

4. 搭建开发环境

4.1 得到动态库

下载SDK,得到的UCloudRtcSdk_ios.framework为动态库；

4.2 创建新的工程

使用XCode创建一个新的工程UCloudRtcSdk-ios-demo；

创建新的工程.png

4.3 加入动态库带工程中

将已下载的动态库UCloudRtcSdk_ios.framework加入到UCloudRtcSdk-ios-demo工程中Embedded Binaries；

加入动态库到工程中

4.4 打开Xcode

打开Xcode，选择：项目TARGET ->General->Deployment Target，设置8.0或以上版本；

设置版本号.png

4.6 关闭Bitcode（目前SDK版本不支持Bitcode）

关闭bitcode.png

4.7 编辑info.plist，申请摄像头、麦克风权限

Privacy - Camera Usage Description
Privacy - Microphone Usage Description

编辑info.plist.png

4.8 打开后台音频权限

为保障APP退入手机后台之后，通话可以保持不中断，建议开启后台音频权限，SDK默认进入后台之后继续推送音频流。

打开后台音频权限.png

4.9 集成成功

按照上述步骤完成UCloudRtcSdk-ios-demo的前期SDK集成准备之后，请使用Xcode连接iPhone真机，在真机调试环境下，执行编译Commond + B，提示Build Success，表示SDK集成成功。

5. 初始化

建议在初始化 App 的同时，初始化 SDK。

5.1 导入 SDK 头文件

<UCloudRtcSdk_ios/UCloudRtcSdk_ios.h>

import UCloudRtcSdk_ios

5.2 设置 userId 和 roomId，获取AppID;

UCloudRtcEngine *engine = [[UCloudRtcEngine alloc] initWithUserId:userId  appId:appId roomId:roomId appKey:appKey token:token]];

UCloudRtcEngine *engine = UCloudRtcEngine.init(userId:userId, appId: appId, roomId:roomId , appKey: appKey, token:token)

务必要设置代理对象，并实现代理回调方法，设置代理对象失败，会导致 App 收不到相关回调。

engine.delegate = self;

self.engine?.delegate = self

5.3 配置参数

使用之前需要对SDK进行相关设置，如果不设置，系统将会采用默认值。
初始化完成后，即可调用 SDK 相关接口，实现对应功能。

    self.engine.isAutoPublish = YES;//加入房间后将自动发布本地音视频 默认为YES
    self.engine.isAutoSubscribe = YES;//加入房间后将自动订阅远端音视频 默认为YES
    self.engine.isOnlyAudio = NO;//将启用纯音频模式 默认为NO
    self.engine.isDebug = NO;//是否开启日志
    self.engine.videoProfile = UCloudRtcEngine_VideoProfile_360P_1;//设置视频分辨率
    self.engine.streamProfile = UCloudRtcEngine_StreamProfileAll;//设置流权限

    self.engine?.isAutoPublish = ture;//加入房间后将自动发布本地音视频 默认为ture
    self.engine?.isAutoSubscribe = ture;//加入房间后将自动订阅远端音视频 默认为ture
    self.engine?.isOnlyAudio = false;//将启用纯音频模式 默认为false
    self.engine?.isDebug = false;//是否开启日志
    self.engine?.videoProfile = ._VideoProfile_360P_1;//设置视频分辨率
    self.engine?.streamProfile = .streamProfileAll;//设置流权限

4. 搭建开发环境

4.1 得到动态库

下载SDK,得到的UCloudRtcSdk_mac.framework为动态库；

4.3 加入动态库到工程中

将已下载的动态库UCloudRtcSdk_mac.framework加入到UCloudRtcSdk-mac-demo工程中Embedded Binaries；

4.4 打开Xcode

将TARGETS>GENERAL>Deployment Target 设置为10.10及以上；

4.5 编辑info.plist，申请摄像头、麦克风权限

Privacy - Camera Usage Description
Privacy - Microphone Usage Description

4.7 集成成功

按照上述步骤完成UCloudRtcSdk-mac-demo的前期SDK集成准备之后，执行编译 Commond + B，提示Build Success，表示SDK集成成功。

5. 初始化

建议在初始化 App 的同时，初始化 SDK。

5.1 导入 SDK 头文件

<UCloudRtcSdk_mac/UCloudRtcSdk_mac.h>

5.2 设置 userId 和 roomId，获取AppID

UCloudRtcEngine *engine = [[UCloudRtcEngine alloc]
initWithUserId:userId appId:appId roomId:roomId token:@""]];

务必要设置代理对象，并实现代理回调方法，设置代理对象失败，会导致 App 收不到相关回调。

engine.delegate = self;

5.3 调用接口初始化

使用之前需要对SDK进行相关设置，如果不设置，系统将会采用默认值。

self.engineMode = UCloudRtcEngineModeTrival; 默认为测试模式
self.engine.isAutoPublish = YES;//加入房间后将自动发布本地音视频 默认为YES
self.engine.isAutoSubscribe = YES;//加入房间后将自动订阅远端音视频 默认为YES
self.engine.isDesktop = NO;//发布桌面或者摄像头 默认为NO:摄像头 YES:桌面

2. 开发语言以及系统要求

开发语言：C++ + javascript
系统要求：Windows 7 及以上版本的 Windows 系统

3. 开发环境

3.2 Javascript 开发

拷贝工程中UCloudRtcElectronEngine.js(java script 接口封装实现)，拷贝pulgin到自己的目录下。

注意：请保持路径正确，或者更改为自己的目录地址。UCloudRtcElectronEngine.js 中node文件引用路径为 ./plugin/lib/release/UCloudRtcElectronEngine.node。

在文件中引：import {urtcSdk} from '../ UCloudRtcElectronEngine'。

4. 初始化

4.1 实现eventcallback funtion实现回调处理

var eventMap={
    5000:function(){
        com.addLog('success',"ok");
    },
    5001:function () {
        com.addLog('error','服务器连接断开');
    },
    5002:function (resp,com) {
        //加入房间
    },
    5003:function (resp,com) {
        //离开房间
    },
    5004:function (resp,com) {
        //重连中
    },
    5005:function (resp,com) {
        //重连成功
    },
    5006:function (resp,com) {
        //视频发布成功
    },
    5007:function (resp,com) {
        //取消媒体 {code:0 msg:msg, data:{}}
    },
    5008:function (resp,com) {
       // 用户加入房间
    },
    5009:function (resp,com) {
       // 用户离开房间
    },
    5010:function (resp,com) {
       // 房间内新媒体发布
    },
    5011:function (resp,com) {
         //房间内有媒体流移除
    },
    5012:function (resp,com) {
        //订阅媒体流响应
   },
   5013:function (resp,com) {
        // 取消订阅媒体流响应
    },
    5014:function (resp,com) {
        // mute  本地媒体流响应
    },
    5015:function (resp,com) {
       // mute 远端媒体流响应
    },
    5016:function (resp,com) {
        // 远端媒体流变化
    },
    5019:function (resp,com) {
        //开始录制请求响应
    },
    5020:function (resp,com) {
        //停止请求录制响应
    }
}
initEngine = (eventId,objectStr)=>{
    if(!objectStr){
        objectStr = "{}";
    }
    var fun = enentMap[eventId];
    // console.log(eventId,objectStr);
    this.addLog('info',`SDK返回 ${eventId}:${objectStr}`);
    if(fun){
         fun(JSON.parse(objectStr),this);
    }
 }

4.2 调用接口初始化

urtcSdk.InitRtcEngine(initEngine);
urtcSdk.SetSdkMode(1) ; 
urtcSdk.SetStreamRole(2) ;
urtcSdk.SetAudioOnlyMode(false) ;
urtcSdk.SetAutoPubSub(false, false) ;
urtcSdk.SetVideoProfile(1) ;
urtcSdk.SetScreenOutProfile(2) ;
urtcSdk.SetTokenSeckey("xxxxxxxxxxxxx") ;// appkey

URTC 以动态链接库的方式提供SDK，包括头文件和动态链接库文件：
urtclib/interface/UCloudRtcComDefine.h urtclib/interface/UCloudRtcEngine.h urtclib/interface/UCloudRtcErrorCode.h urtclib/interface/UCloudRtcMediaDevice.h urtclib/lib/libliburtcmediaengine.so urtclib/lib/liburtcnetengine.so

cd build
//生成Makefile等
cmake ../.
//编译成功后，在../bin中生成可执行文件
make
//执行
cd ..
bin/enginedemo rtsp://path/to/rtspstream

5.2 交叉编译

如果使用交叉编译，需要修改CMakeList.txt，这样交叉编译速度会有所提高。

//打开文件CMakeList.txt中下面的注释
SET(CROSS_COMPILE 1)

IF(CROSS_COMPILE)
SET(TOOLCHAIN_DIR "/path/to/compile-toolchain/gcc-linaro-7.3.1-2018.05-x86_64_aarch64-linux-gnu")
set(CMAKE_CXX_COMPILER ${TOOLCHAIN_DIR}/bin/aarch64-linux-gnu-g++)
set(CMAKE_C_COMPILER   ${TOOLCHAIN_DIR}/bin/aarch64-linux-gnu-gcc)

SET(CMAKE_FIND_ROOT_PATH  ${TOOLCHAIN_DIR}
 ${TOOLCHAIN_DIR}/include
 ${TOOLCHAIN_DIR}/lib )
ENDIF(CROSS_COMPILE)

5.3 运行demo

编译完毕后，加入房间并推RTSP视频流。

./enginedemo roomid userid rtsp://xxx

// roomid：自定义的房间号，同一个房间的用户可以通讯。    
// userid：自定义的用户号，每个客户端id需要唯一。    
// rtsp://xxx：通过RTSP拉流设备的网络地址。

推流成功，用户可以处理回调函数URTCEventHandler.cpp中的onLocalPublish处理，如果code==0，则推流成功。
推流成功后，即可直播观看RTSP视频。

最近更新时间：2022-12-22 06:52:11

Web SDK兼容性

互动连麦