展播虚拟形象（小展）协议文档

文档创建时间:2023/12/08

需注意:初始化unity的context必须是activity类型的context.

一.集成说明:

1.build.gradle配置

• 引用unityLibrary-vpa.aar到项目里的build.gradle中在android {里添加：

 
`aaptOptions {
   noCompress = ['.unity3d', '.ress', '.resource', '.obb', '.bundle', '.unityexp'] + unityStreamingAssets.tokenize(', ')
   ignoreAssetsPattern = "!.svn:!.git:!.ds_store:!*.scc:.*:!CVS:!thumbs.db:!picasa.ini:!*~"`
}

 
xxxxxxxxxx
packagingOptions {
    doNotStrip '*/armeabi-v7a/*.so'
    doNotStrip '*/arm64-v8a/*.so'
}

defaultConfig {中添加

 
xxxxxxxxxx
ndk {
    abiFilters 'armeabi-v7a', 'arm64-v8a'
}

2.AndroidManifest.xml 配置

application添加 tools:replace="android:theme"

3.Local.properties配置

 
xxxxxxxxxx
ndk.dir=ndk路径

4.gradle.properties配置

 
xxxxxxxxxx
org.gradle.parallel=true
unityStreamingAssets=
unityTemplateVersion=3
android.useAndroidX=true
org.gradle.jvmargs=--add-opens java.base/java.io=ALL-UNNAMED

二:使用说明:

• unitysdk中自带一像素的透明activity.此方式不要求context一定要继承Activity.
• 接口调用入口为UnityLibrary.getInstance()；
• 使用SurfaceView承载形象

初始化方法init()

 
xxxxxxxxxx
UnityLibrary.getInstance().init(this);

初始化回调

 
xxxxxxxxxx
UnityLibrary.getInstance().setOnInitListener(new OnInitListener() {
            @Override
            public void success() {
                LogUtil.e(TAG,"success ++++++");
            }
            //预留
            @Override
            public void onRestart() {}
            @Override
            public void onResume() {}
            @Override
            public void onPause() {}
            @Override
            public void onStop() {}
            @Override
            public void onDestroy() {}
            @Override
            public void fail() {}
        });

SurfaceView监听(示例使用TextTureView,为实现透明背景)，添加Surface

 
​x
TextTureView layout = findViewById(R.id.ff1);
​
private Surface mSurface;
​
layout.setOpaque(false);
​
layout.setSurfaceTextureListener(new TextureView.SurfaceTextureListener() {
    @Override
    public void onSurfaceTextureAvailable(@NonNull SurfaceTexture surfaceTexture, int i, int i1) {
        LogUtil.e(TAG,"onSurfaceTextureAvailable");
        mSurface = new Surface(surfaceTexture);
        //添加Surface
        UnityLibrary.getInstance().setSurface(mSurface,"init");
        
        //初始化必须传入形象大小，具体参数解释在文档末尾
        UnityLibrary.getInstance().sendAction(new UnityConstants(UnityConstants.SELECT_CHARACTER,UnityConstants.S_MODEL));
​
    }
​
    @Override
    public void onSurfaceTextureSizeChanged(@NonNull SurfaceTexture surfaceTexture, int i, int i1) {
​
    }
​
    @Override
    public boolean onSurfaceTextureDestroyed(@NonNull SurfaceTexture surfaceTexture) {
        LogUtil.e(TAG,"onSurfaceTextureDestroyed");
        UnityLibrary.getInstance().setSurface(null, "自定义");
        mSurface.release();
        mSurface = null;
        return false;
    }
​
    @Override
    public void onSurfaceTextureUpdated(@NonNull SurfaceTexture surfaceTexture) {
​
    }
});

调用对应的生命周期如下

 
xxxxxxxxxx
​
    //必须实现
    @Override
    protected void onPause() {
        super.onPause();
        LogUtil.e(TAG,"--------------------onPause");
        UnityLibrary.getInstance().setSurface(null, "自定义");
    }
    
    @Override
    protected void onResume() {
        super.onResume();
        LogUtil.e(TAG,"--------------------onResume");
        UnityLibrary.getInstance().setSurface(mSurface, "自定义");
    }
​
    @Override
    protected void onDestroy() {
        super.onDestroy();
        LogUtil.e(TAG,"--------------------onDestroy");
        UnityLibrary.getInstance().onDestroy();
    }
    
    //可选部分
    @Override
    public boolean onTouchEvent(MotionEvent event) {
        return UnityLibrary.getInstance().onTouchEvent(event);
    }
​
    @Override
    public boolean onKeyDown(int keyCode, KeyEvent event) {
        return UnityLibrary.getInstance().onKeyDown(keyCode,event);
    }
​
    @Override
    public boolean onGenericMotionEvent(MotionEvent event) {
        return UnityLibrary.getInstance().onGenericMotionEvent(event);
    }
​
    @Override
    public boolean dispatchKeyEvent(KeyEvent event) {
        return UnityLibrary.getInstance().dispatchKeyEvent(event);
    }
​
    @Override
    public boolean onKeyUp(int keyCode, KeyEvent event) {
        return UnityLibrary.getInstance().onKeyUp(keyCode, event);
    }

三.接⼝⽅法

动作显示示例

 
xxxxxxxxxx
    UnityConstants unityConstants = new UnityConstants();
    unityConstants.setService(UnityConstants.SELECT_CHARACTER);
    unityConstants.setValue(UnityConstants.S_MODEL);
    UnityLibrary.getInstance().sendAction(unityConstants);

• Android调用UnityLibrary.getInstance().sendAction()向unity传值.

 
xxxxxxxxxx
UnityLibrary.getInstance().sendAction(unityConstants);

• VpaProtocol类说明:

service开放方法说明:

value开放方法说明: