该 SDK 基于 APICloud 平台开发 为实时互动通信及直播类应用量身打造而成的SDK,包括了实时音频、视频、.zip

/* Title: ARtcKit Description: ARtcKit SDK for APICloud */ <p style="color: #ccc; margin-bottom: 30px;">来自于：ar云平台</p> <ul id="tab" class="clearfix"> <li class="active"><a href="#method-content">Method</a></li> </ul> <div id="method-content"> <div class="outline"> [init](#1) [destroy](#2) [getSdkVersion](#3) [setParameters](#4) [setLogFile](#5) [setLogFilter](#6) [joinChannel](#7) [leaveChannel](#8) [setChannelProfile](#9) [setClientRole](#10) [renewToken](#11) [enableVideo](#12) [disableVideo](#13) [enableLocalVideo](#14) [setVideoProfile](#15) [switchCamera](#16) [startPreview](#17) [stopPreview](#18) [setupLocalVideo](#19) [setupRemoteVideo](#20) [muteLocalVideoStream](#21) [muteAllRemoteVideoStreams](#22) [muteRemoteVideoStream](#23) [enableAudio](#24) [disableAudio](#25) [muteLocalAudioStream](#26) [muteAllRemoteAudioStreams](#27) [muteRemoteAudioStream](#28) [joinChannelSuccessListener](#29) [leaveChannelListener](#30) [firstLocalVideoFrameListener](#31) [remoteUserJoinedListener](#32) [remoteUserOfflineListener](#33) [firstRemoteVideoDecodedListener](#34) [requestTokenListener](#35) [errorListener](#36) [warningListener](#37) </div> # **概述** anyRTC SDK 是anyRTC 为实时互动通信及直播类应用量身打造而成的SDK,包括了实时音频、视频、混音、屏幕共享等功能，适用于娱乐、游戏、教育等场景。支持公有云、混合云、私有云等部署方式。 使用前请前往anyRTC 网站（https://www.anyrtc.io）注册账号，并创建应用。 前端调用 arRtc 模块方法，初始化和加入频道。 **建议使用此模块之前先配置 config.xml 文件的 Feature，方法如下** 名称：arRtc 参数：appId 描述：配置 arRtc 应用信息 ```js <feature name="arRtc"> <param name="appId" value="123456789" /> </feature> ``` # **init**<div id="1"></div> 初始化RTC服务 init({params}) ## params appId： - 类型：字符串 - 默认值：无 - 描述：（可选项）appid 为应用程序开发者签发的 App ID, 不设置时使用 config.xml 中的配置 ## 示例代码 ```js var arRtc = api.require('arRtc'); arRtc.init({appId:'appId'}); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 # **destroy**<div id="2"></div> 该方法释放 ARtcKit SDK 使用的所有资源。有些应用程序只在用户需要时才进行语音通话，不需要时则将资源释放出来用于其他操作，该方法对这类程序可能比较有用。 只要调用了 destroy(), 用户将无法再使用和回调该 SDK 内的其它方法。如需再次使用通信功能，必须重新初始化。 destroy() ## 示例代码 ```js var arRtc = api.require('arRtc'); arRtc.destroy(); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 # **getSdkVersion**<div id="3"></div> 该方法返回 SDK 版本号字符串 getSdkVersion(callback(ret)) ## callback(ret) ret： - 类型：字符串 - 描述：ARtcKit SDK 版本号 ## 示例代码 ```js var arRtc = api.require('arRtc'); arRtc.getSdkVersion(function(ret){ api.alert({msg:'ARtcKit RTC SDK Version: ' + ret}); }); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 # **setParameters**<div id="4"></div> 设置特有参数 setParameters({params}, callback(ret)) ## params params： - 类型：字符串 - 默认值：无 - 描述：将特有参数组装为 JSON 字符串 ## callback(ret) ret： - 类型：JSON 对象 内部字段： ```js { code: 0 // 返回的状态码，0为调用成功，否则为调用失败 } ``` ## 示例代码 ```js var arRtc = api.require('arRtc'); arRtc.setParameters({ params:'' }, function(ret) { if (ret.code == 0) { // success } }); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 # **setLogFile**<div id="5"></div> 设置 SDK 的输出 log 文件。SDK 运行时产生的所有 log 将写入该文件。应用程序必须保证指定的目录存在而且可写。 setLogFile({params}, callback(ret)) ## params path： - 类型：字符串 - 默认值：无 - 描述：将特有参数组装为 JSON 字符串 ## callback(ret) ret： - 类型：JSON 对象 内部字段： ```js { code: 0 // 返回的状态码，0为调用成功，否则为调用失败 } ``` ##示例代码 ```js var arRtc = api.require('arRtc'); arRtc.setLogFile({ path:'cache://arRtc.log' }, function(ret) { if (ret.code == 0) { // success } }); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 #**setLogFilter**<div id="6"></div> 设置 SDK 的输出日志过滤器。不同的过滤器可以用或组合。 setLogFilter({params}, callback(ret)) ## params filter： - 类型：数字 - 默认值：0x000f，INFO | WARNING | ERROR | FATAL - 取值范围： * 1: INFO * 2: WARNING * 4: ERROR * 8: FATAL * 0x800: DEBUG ## callback(ret) ret： - 类型：JSON 对象 内部字段： ```js { code: 0 // 返回的状态码，0为调用成功，否则为调用失败 } ``` ## 示例代码 ```js var arRtc = api.require('arRtc'); arRtc.setLogFilter({ filter:0x080f }, function(ret) { if (ret.code == 0) { // success } }); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 # **joinChannel**<div id="7"></div> 该方法让用户加入通话频道，在同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊。 使用不同 App ID 的应用程序是不能互通的。如果已在通话中，用户必须调用 leaveChannel() 退出当前通话，才能进入下一个频道。 joinChannel({params}, callback(ret)) ## params token： - 类型：字符串 - 默认值：空 - 描述：（可选项） * 安全要求不高: 将值设为 null * 安全要求高: 将值设置为 Token 值。 如果你已经启用了 App Certificate, 请务必使用 Token。 channel： - 类型：字符串 - 默认值：无 - 描述：标识通话的频道名，长度在64字节以内的字符串。以下为支持的字符集范围（共89个字符）: a-z,A-Z,0-9,space,! #$%&,()+, -,:;<=.#$%&,()+,-,:;<=.,>?@[],^_,{|},~ uid： - 类型：字符串 - 默认值：无 - 描述：（可选项）uid 用户 ID，建议设置长度1~48，确保uid符合规则，并保证唯一性。如果不填或设置为nil，SDK 会自动分配一个，并在 joinChannelSuccessListener 回调方法中返回。 ## callback(ret) ret： - 类型：JSON 对象 内部字段： ```js { code: 0 // 返回的状态码，0为调用成功，否则为调用失败 } ``` ## 示例代码 ```js var arRtc = api.require('arRtc'); arRtc.joinChannel({ channel:'test' }, function(ret) { if (ret.code == 0) { // success } }); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 # **leaveChannel**<div id="8"></div> 离开频道，即挂断或退出通话。当调用 joinChannel() API 方法后，必须调用 leaveChannel() 结束通话，否则无法开始下一次通话。不管当前是否在通话中，都可以调用 leaveChannel()，没有副作用。该方法会把会话相关的所有资源释放掉。该方法是异步操作，调用返回时并没有真正退出频道。在真正退出频道后，SDK 会触发 leaveChannelListener 回调。 leaveChannel(callback(ret)) ## callback(ret) ret： - 类型：JSON 对象 内部字段： ```js { code: 0 // 返回的状态码，0为调用成功，否则为调用失败 } ``` ## 示例代码 ```js var arRtc = api.require('arRtc'); arRtc.leaveChannel(function(ret) { if (ret.code == 0) { // success } }); ``` ## 可用性 iOS 系统，Android 系统 可提供的 4.0.0 及更高版本 # **setChannelProfile**<div id="9"></div> 该方法用于设置频道模式(Profile)。RtcEngine 需知道应用程序的使用场景(例如通信模式或直播�