Android SDK 参考

本文档介绍 GNA Android SDK 的参考信息。

Package: org.chromium.gsdk.engine.GameSdkAbsAdapter

GameSdkAbsAdapter 抽象类

描述

SDK 初始化所需的参数。您需要在返回值中传入参数。

定义

public abstract class GameSdkAbsAdapter {
    private final Context mContext;

    public GameSdkAbsAdapter(Context context) {
        this.mContext = context;
    }

    public Context getContext() {
        return this.mContext;
    }

    public boolean enableVerboseLog() {
        return false;
    }

    public int getLogLevel() {
        return -1;
    }

    public abstract String getDeviceId();

    public abstract String getAppId();

    public abstract String getSecret();

    public void sendAppMonitorEvent(String event, String log) {
    }
}

成员方法

IDiagnosisCallback 接口

描述

网络分析的结果。

定义

public interface IDiagnosisCallback {
    void onDiagnosisComplete(String report);
}

成员方法

tryInitGameSdk 方法

描述

初始化 GNA SDK。该方法是异步的。目前 Android SDK 暂未提供初始化成功的回调。建议您尽早开始初始化。例如，您可以在 App 冷启动时开始初始化。

定义

public class GameSdkClient {
   public static boolean tryInitGameSdk(GameSdkAbsAdapter adapter);
}

参数

Package:

• com.bytedance.gsdk.ttnet.diagnosis.IDiagnosisCallback
• com.bytedance.gsdk.ttnet.diagnosis.IDiagnosisRequest
• com.bytedance.gsdk.ttnet.diagnosis.TTNetDiagnosisService

createRequest 方法 [1/2]

描述

创建玩家自助网络分析请求。

定义

public static IDiagnosisRequest createRequest(int reqType, String target, int netDetectType, int multiNetAction, int timeout);

参数

返回值

IDiagnosisRequest 对象。
如果参数不合法，该方法会抛出异常。

createRequest 方法 [2/2]

描述

创建玩家自助网络分析请求。

定义

public static IDiagnosisRequest createRequest(TTNetDiagnosisService.RequestParams params);

参数

返回值

IDiagnosisRequest 对象。
如果参数不合法，该方法会抛出异常。

RequestParams 类

描述

自助网络分析请求的请求参数。

定义

public static class RequestParams {
    public int requestType;
    public List<String> targets;
    public String dispatchFeature;
    public int detectType;
    public int multiNetAction;
    public int timeoutMs;

    public RequestParams() {
    }
}

参数

start 方法

描述

开始玩家自助网络分析。自助网络分析完成后，会触发 onDiagnosisComplete 回调。

定义

public void start(IDiagnosisCallback callback);

参数

setUserExtraInfo 方法

描述

辅助描述信息，会记录在分析报告里的 user_extra_info 字段。

定义

void setUserExtraInfo(String extraInfo);

参数

cancel 方法

描述

取消玩家自助网络分析。调用该方法会触发 onDiagnosisComplete 回调。

定义

public void cancel();

Package:com.bytedance.gsdk.ttnet.diagnosis.TTGameDiagnosisService

monitorBegin 方法 [1/2]

描述

开始游戏对局网络分析。当玩家网络发生跳变时，SDK 会对从玩家客户端到您设置的目标地址之间的网络进行分析。

定义

public void monitorBegin(String target, String extraInfo) throws Exception

参数

monitorBegin 方法 [2/2]

描述

开始游戏对局网络分析。当玩家网络发生跳变时，SDK 会对从玩家客户端到您设置的目标地址之间的网络进行分析。

定义

public void monitorBegin(TTGameDiagnosisService.MonitorBeginParams beginParams)

参数

MonitorBeginParams 类

描述

游戏对局网络分析的参数。

定义

public static class MonitorBeginParams {
    public String target;
    public String dispatchFeature;
    public String extraInfo;
    public IDiagnosisCallback reportCallback;
}

参数

doDiagnosisDuringGaming 方法

描述

在游戏对局中，手动对从玩家客户端到您在 monitorBegin 方法中设置的目标地址之间的网络进行分析。

定义

public void doDiagnosisDuringGaming(String extraMessage)

参数

monitorEnd 方法

描述

结束游戏对局网络分析。

定义

public void monitorEnd(String extraInfo)

Package:

• com.bytedance.gsdk.ttnet.mpa.TTNetMpaService
• com.bytedance.gsdk.frameworks.baselib.network.http.cronet.mpa.IMpaService

registerCallbacks 方法

描述

注册网络加速所需的回调。

定义

public void registerCallbacks(IMpaService.ICallback initCallback,
                              IMpaService.ISetAddressCallback setAddressCallback,
                              IMpaService.ICallback stopCallback);

参数

ICallback 接口

描述

该接口可用于实现以下回调：

• 调用 init 方法后触发的回调，用于报告初始化是否成功。该回调需要传入 registerCallbacks 方法的 initCallback 参数。
• 调用 stop 方法后触发的回调，用于报告加速是否成功。该回调需要传入 registerCallbacks 方法的 stopCallback 参数。

定义

public interface IMpaService {
    interface ICallback {
        void onFinish(boolean isSuccess, String extraMsg);
    }
}

参数

调用 init 方法后触发的回调，参数如下：

对于调用 stop 方法后触发的回调，参数如下：

setAddressCallback 接口

描述

调用 stop 方法后触发的回调，用于报告加速是否成功。该回调需要传入 registerCallbacks 方法的 stopCallback 参数。

定义

public interface IMpaService {
    interface ISetAddressCallback {
        void onFinish(boolean isSuccess, String extraMsg, String context);
    }
}

参数

init 方法

描述

初始化网络加速功能。调用该方法会触发 registerCallbacks 方法的 initCallback 参数中设置的回调。

定义

public void init();

enableWiseMultiPath 方法

描述

开启或关闭智能双通道加速。如果您不调用该方法，SDK 默认关闭智能加速。

定义

public void enableWiseMultiPath(boolean enable);

参数

start 方法

描述

开始网络加速。

定义

public void start(String userLog);

参数

setAccAddress 方法 [1/2]

描述

设置需要加速的目标地址列表。调用该方法会触发 registerCallbacks 方法的 setAddressCallback 参数中设置的回调。

定义

void setAccAddress(List<String> address, String context, boolean append);

参数

setAccAddress 方法 [2/2]

描述

设置需要加速的目标地址列表。调用该方法会触发 registerCallbacks 方法的 setAddressCallback 参数中设置的回调。

定义

void setAccAddress(TTNetMpaService.AcceleratedPointsParams params)

参数

AcceleratedPointsParams 类

描述

目标地址列表参数。

定义

public static class AcceleratedPointsParams {
    public List<String> addressList;
    public TTNetMpaService.SocketType socketType;
    public boolean append;
    public String context;
}

参数

reportUserLog 方法

描述

上报用户日志。

定义

void reportUserLog(String userLog);

参数

Stop 方法

描述

停止网络加速。调用该方法会触发 registerCallbacks 方法的 stopCallback 参数中设置的回调。

定义

void stop(String endLog);

参数