目录

实现游戏伴随

从API版本26.0.0开始,新增游戏伴随服务。游戏伴随服务为游戏陪玩类的应用提供游戏应用状态感知、游戏应用截图等基础能力。

约束与限制

  1. 从API版本26.0.0开始,仅支持Phone设备。
  2. 截图频率当前为1s截一张图。

业务流程

  1. 用户启动游戏陪玩类应用。

  2. 用户启动游戏。

  3. 游戏进程创建。

  4. 游戏陪伴类应用调用onGameApplicationStatus接口注册游戏应用状态监听,监听游戏前后台状态变化。

  5. 游戏陪伴类应用调用onGameSnapshot接口注册游戏应用截图监听,用于接收游戏画面截图。

  6. 游戏状态发生变化时(切换到前台、后台或终止时)。

  7. 游戏伴随服务通过onGameApplicationStatus回调通知已注册的游戏陪伴类应用。

  8. 游戏伴随服务通过onGameSnapshot回调向游戏陪伴类应用发送游戏截图数据(文件描述符方式)。

  9. 用户退出所有游戏,游戏伴随服务通过onGameApplicationStatus回调通知游戏陪伴类应用BUDDY_TERMINATED状态,表示游戏伴随服务已终止。

接口说明

具体API说明请详见游戏伴随服务接口文档。

接口名 描述
onGameApplicationStatus(callback: Callback<GameApplicationStatusInfo>): void 注册游戏应用状态变化的事件监听。
offGameApplicationStatus(callback?: Callback<GameApplicationStatusInfo>): void 取消游戏应用状态变化的事件监听。
onGameSnapshot(callback: Callback<number>): void 注册游戏应用截图的事件监听。
offGameSnapshot(callback?: Callback<number>): void 取消游戏应用截图的事件监听。

开发步骤

  1. 导入模块。
     import { gameBuddyService } from '@kit.GraphicsAccelerateKit';
     import { hilog } from '@kit.PerformanceAnalysisKit';
  2. 注册回调函数
    private statusCallback: (statusInfo: gameBuddyService.GameApplicationStatusInfo) => void = (statusInfo) => {
      hilog.info(0x0000, 'gameBuddyService', `Game application status changed: ` + statusInfo.status);
    };
    private snapshotCallback: (fd: number) => void = (fd) => {
      hilog.info(0x0000, 'gameBuddyService', `Game snapshot fd: ${fd}`);
    };
  3. 调用onGameApplicationStatus接口,注册游戏应用状态监听。
    try {
      gameBuddyService.onGameApplicationStatus(this.statusCallback);
    } catch (err) {
      hilog.error(0x0000, 'gameBuddyService',
        `failed to register listener, errorCode: ${err.code}, errorMessage: ${err.message}`);
    }
  4. 调用onGameSnapshot接口,注册游戏应用截图监听。
    try {
      gameBuddyService.onGameSnapshot(this.snapshotCallback);
    } catch (err) {
      hilog.error(0x0000, 'gameBuddyService',
        `failed to register listener, errorCode: ${err.code}, errorMessage: ${err.message}`);
    }
  5. 调用offGameApplicationStatus接口,取消游戏应用状态监听。
    try {
      gameBuddyService.offGameApplicationStatus(this.statusCallback);
    } catch (err) {
      hilog.error(0x0000, 'gameBuddyService',
        `failed to cancel register listener, errorCode: ${err.code}, errorMessage: ${err.message}`);
    }
  6. 调用offGameSnapshot接口,取消游戏应用截图监听。
    try {
      gameBuddyService.offGameSnapshot(this.snapshotCallback);
    } catch (err) {
      hilog.error(0x0000, 'gameBuddyService', `failed to cancel register listener, errorCode: ${err.code}, errorMessage: ${err.message}`);
    }