AVDEngine

cn.tee3.avd

## 类 AVDEngine

- java.lang.Object
- - cn.tee3.avd.AVDEngine

-     public class AVDEngine
      extends java.lang.Object

  AVD引擎接口类

  AVD引擎接口定义了引擎全局初始化操作和房间安排、查询、删除等操作。

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static interface` | `AVDEngine.GetUsersCountResult`
    `static interface` | `AVDEngine.Listener` AVD引擎回调接口类 AVD引擎回调接口定义了引擎接口操作的异步返回。
    `static class` | `AVDEngine.LoggingSeverity`
    `static interface` | `AVDEngine.NetworkGatewayAdapter`
    `static class` | `AVDEngine.Option` 引擎选项
    `static class` | `AVDEngine.PeerConnectionParameters` Peer connection parameters.
    `static class` | `AVDEngine.ProxyType`

  - ### 方法概要

    所有方法 静态方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `int` | `callOutgoingDevice(java.lang.String name, java.lang.String roomId, java.lang.String url, java.lang.String userId)` 呼叫外部设备
    `int` | `cancelRoom(java.lang.String roomId)` 取消删除房间
    `protected void` | `doafterinitok()`
    `static void` | `enableLog2SDK(boolean enable)`
    `int` | `findRooms(java.lang.String filter)` 查找房间信息
    `java.lang.String` | `getAndroidID(android.content.Context context)`
    `static java.lang.String` | `getAppName(android.content.Context context)` 获取应用程序名称
    `android.content.Context` | `getContext()`
    `java.lang.String` | `getDefaultLogfile()`
    `protected EglBase.Context` | `getEglBaseContext()`
    `static java.lang.String` | `getErrorMessage(int code)` 根据错误代码获取关联的错误信息描述
    `java.lang.String` | `getIMEI(android.content.Context context)`
    `java.lang.String` | `getMachineId()`
    `java.lang.String` | `getOption(AVDEngine.Option type)` 获取引擎选项
    `int` | `getRoomByAppRoomId(java.lang.String appRoomId)` 根据应用层房间Id获取房间信息
    `int` | `getRoomByRoomId(java.lang.String roomId)` 根据房间Id获取房间信息
    `java.lang.String` | `getSerialNumber()`
    `static java.lang.String` | `getTee3Dir()`
    `User` | `getUserInfo()` 获取全局用户信息
    `int` | `getUsersCount(java.lang.String roomId, AVDEngine.GetUsersCountResult result)`
    `java.lang.String` | `getVersion()` 获取引擎版本号
    `static java.lang.String` | `getVersionName(android.content.Context context)` [获取应用程序版本名称信息]
    `int` | `init(android.content.Context context, AVDEngine.Listener listener, java.lang.String severuri, java.lang.String token)` 初始化引擎
    `int` | `init(android.content.Context context, AVDEngine.Listener listener, java.lang.String severuri, java.lang.String appkey, java.lang.String secretkey)` 初始化引擎
    `int` | `init(android.content.Context context, AVDEngine.Listener listener, java.lang.String severuri, java.lang.String appkey, java.lang.String secretkey, boolean usedcamera)`
    `static int` | `initJavaForNoEngine(android.content.Context context, boolean usedcamera)`
    `int` | `initWithOEM(android.content.Context context, AVDEngine.Listener listener, java.lang.String severuri, java.lang.String oemName, boolean usedcamera)` 初始化引擎
    `static AVDEngine` | `instance()` 获取AVD引擎对象
    `boolean` | `isWorking()` 判断引擎是否正常工作
    `protected static void` | `reLoadCamerasIfNone()`
    `static void` | `runOnLoopThreadSync(java.lang.Runnable runnable)`
    `static void` | `runOnMainThreadAsync(java.lang.Runnable runnable)`
    `int` | `scheduleRoom(RoomInfo roomInfo)` 安排房间
    `void` | `setAudioFrameCallback(JavaAudioDeviceModule.SamplesReadyCallback callback)` 导出PCM音频数据
    `AVDEngine` | `setAudioSampleRate(int rate)`
    `java.lang.String` | `setDumpFile(java.lang.String dirOrFilename)` 设置引擎Dump文件
    `int` | `setLogParams(java.lang.String params, java.lang.String filename)`
    `void` | `setNetworkGatewayAdapter(AVDEngine.NetworkGatewayAdapter gateway)`
    `int` | `setOption(AVDEngine.Option type, java.lang.String svalue)` 设置引擎选项
    `void` | `setProxy(AVDEngine.ProxyType type, java.lang.String ip, int port, java.lang.String userName, java.lang.String password)` 设置代理信息
    `static void` | `setSOName(java.lang.String asoName)`
    `static boolean` | `setSupportedCapabilities(java.util.List<MVideo.CameraCapability> highs, java.util.List<MVideo.CameraCapability> normals, java.util.List<MVideo.CameraCapability> lows)` 全局设置本地视频预览和发布的分辨率可选项
    `static void` | `setSystemInfo(java.lang.String systemInfo)`
    `int` | `setUserInfo(User info)` 设置全局用户信息
    `void` | `switchToForeground()` 程序从后台切换回前台
    `int` | `uninit()` 反初始化引擎

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 方法详细资料

    - #### setSOName

          public static void setSOName(java.lang.String asoName)

    - #### runOnLoopThreadSync

          public static void runOnLoopThreadSync(java.lang.Runnable runnable)

    - #### runOnMainThreadAsync

          public static void runOnMainThreadAsync(java.lang.Runnable runnable)

    - #### instance

          public static AVDEngine instance()

      获取AVD引擎对象
      返回:
        返回AVD引擎。

    - #### getContext

          @Nullable
          public android.content.Context getContext()

    - #### init

          public int init(android.content.Context context,
                          AVDEngine.Listener listener,
                          java.lang.String severuri,
                          java.lang.String appkey,
                          java.lang.String secretkey)

      初始化引擎
      返回:
        返回错误代码。

    - #### init

          public int init(android.content.Context context,
                          AVDEngine.Listener listener,
                          java.lang.String severuri,
                          java.lang.String appkey,
                          java.lang.String secretkey,
                          boolean usedcamera)

    - #### init

          public int init(android.content.Context context,
                          AVDEngine.Listener listener,
                          java.lang.String severuri,
                          java.lang.String token)

      初始化引擎
      返回:
        返回错误代码。

    - #### initWithOEM

          public int initWithOEM(android.content.Context context,
                                 AVDEngine.Listener listener,
                                 java.lang.String severuri,
                                 java.lang.String oemName,
                                 boolean usedcamera)

      初始化引擎
      返回:
        返回错误代码。

    - #### switchToForeground

          public void switchToForeground()

      程序从后台切换回前台

    - #### doafterinitok

          protected void doafterinitok()

    - #### getEglBaseContext

          protected EglBase.Context getEglBaseContext()

    - #### setAudioSampleRate

          public AVDEngine setAudioSampleRate(int rate)

    - #### setAudioFrameCallback

          public void setAudioFrameCallback(JavaAudioDeviceModule.SamplesReadyCallback callback)

      导出PCM音频数据

    - #### uninit

          public int uninit()

      反初始化引擎
      返回:
        返回错误代码。

    - #### isWorking

          public boolean isWorking()

      判断引擎是否正常工作
      返回:
        返回引擎是否正常工作。

    - #### getRoomByRoomId

          public int getRoomByRoomId(java.lang.String roomId)

      根据房间Id获取房间信息
      返回:
        返回错误代码。

    - #### getRoomByAppRoomId

          public int getRoomByAppRoomId(java.lang.String appRoomId)

      根据应用层房间Id获取房间信息
      返回:
        返回错误代码。

    - #### findRooms

          public int findRooms(java.lang.String filter)

      查找房间信息
      返回:
        返回错误代码。

    - #### scheduleRoom

          public int scheduleRoom(RoomInfo roomInfo)

      安排房间
      返回:
        返回错误代码。

    - #### cancelRoom

          public int cancelRoom(java.lang.String roomId)

      取消删除房间
      返回:
        返回错误代码。

    - #### getUsersCount

          public int getUsersCount(java.lang.String roomId,
                                   AVDEngine.GetUsersCountResult result)

    - #### callOutgoingDevice

          public int callOutgoingDevice(java.lang.String name,
                                        java.lang.String roomId,
                                        java.lang.String url,
                                        java.lang.String userId)

      呼叫外部设备
      返回:
        返回错误代码。

    - #### setUserInfo

          public int setUserInfo(User info)

      设置全局用户信息
      返回:
        返回错误代码。

    - #### getUserInfo

          public User getUserInfo()

      获取全局用户信息
      返回:
        返回用户信息。

    - #### getAppName

          @Nullable
          public static java.lang.String getAppName(android.content.Context context)

      获取应用程序名称

    - #### getVersionName

          @Nullable
          public static java.lang.String getVersionName(android.content.Context context)

      [获取应用程序版本名称信息]
      参数:
        `context` -
      返回:
        当前应用的版本名称

    - #### getTee3Dir

          public static java.lang.String getTee3Dir()

    - #### getDefaultLogfile

          public java.lang.String getDefaultLogfile()

    - #### setLogParams

          public int setLogParams(java.lang.String params,
                                  java.lang.String filename)

    - #### enableLog2SDK

          public static void enableLog2SDK(boolean enable)

    - #### setDumpFile

          public java.lang.String setDumpFile(java.lang.String dirOrFilename)

      设置引擎Dump文件
      返回:
        成功返回有效Filepath，失败发回“”。

    - #### getVersion

          public java.lang.String getVersion()

      获取引擎版本号
      返回:
        返回引擎版本号。

    - #### getErrorMessage

          public static java.lang.String getErrorMessage(int code)

      根据错误代码获取关联的错误信息描述
      返回:
        返回错误信息描述。

    - #### initJavaForNoEngine

          public static int initJavaForNoEngine(android.content.Context context,
                                                boolean usedcamera)

    - #### setOption

          public int setOption(AVDEngine.Option type,
                               java.lang.String svalue)

      设置引擎选项
      返回:
        返回错误代码。

    - #### getOption

          public java.lang.String getOption(AVDEngine.Option type)

      获取引擎选项
      返回:
        返回引擎选项值。

    - #### setSupportedCapabilities

          public static boolean setSupportedCapabilities(java.util.List<MVideo.CameraCapability> highs,
                                                         java.util.List<MVideo.CameraCapability> normals,
                                                         java.util.List<MVideo.CameraCapability> lows)

      全局设置本地视频预览和发布的分辨率可选项
      返回:
        返回是否替换成功。

    - #### setNetworkGatewayAdapter

          public void setNetworkGatewayAdapter(AVDEngine.NetworkGatewayAdapter gateway)

    - #### setSystemInfo

          public static void setSystemInfo(java.lang.String systemInfo)

    - #### reLoadCamerasIfNone

          protected static void reLoadCamerasIfNone()

    - #### setProxy

          public void setProxy(AVDEngine.ProxyType type,
                               java.lang.String ip,
                               int port,
                               java.lang.String userName,
                               java.lang.String password)

      设置代理信息
      参数:
        `type` - 代理的类型. 目前支持Https代理(音视频数据以TCP发送),Socks5代理（音视频数据以UDP发送）
        `ip` - 代理的IP地址
        `port` - 代理的端口
        `userName` - 代理的认证账户(如果不认证,可传递空字符串)
        `password` - 代理的认证密码(如果不认证,可传递空字符串)

    - #### getMachineId

          @Nullable
          public java.lang.String getMachineId()

    - #### getIMEI

          @Nullable
          public java.lang.String getIMEI(android.content.Context context)

    - #### getSerialNumber

          @Nullable
          public java.lang.String getSerialNumber()

    - #### getAndroidID

          @Nullable
          public java.lang.String getAndroidID(android.content.Context context)