Window(窗口) | AIUI | Rokid

Window 表示当前 AIUI 智能体的窗口。通过全局 window 对象,可以读取窗口尺寸、打开已配置的 Widget 或请求关闭当前智能体。

Window(窗口)

Window 表示当前 AIUI 智能体的窗口。通过全局 window 对象,可以读取窗口尺寸、打开已配置的 Widget 或请求关闭当前智能体。

读取窗口尺寸

使用 innerWidth 和 innerHeight 获取当前窗口视口的像素尺寸:

const viewport = {
  width: window.innerWidth,
  height: window.innerHeight,
};

console.log(viewport);

这两个属性由运行时维护,智能体应将它们视为只读信息。

打开 Widget

调用 window.open() 打开当前智能体在 app.json 的 widgets 列表中声明的 Widget。传入 Widget 路径时省略 .ink 扩展名,可以附带查询参数:

window.open('widgets/weather/index?city=hangzhou');

target 可以省略,默认值为 _widget;也可以明确传入该值:

window.open('widgets/weather/index?city=hangzhou', '_widget');

AIUI 仅支持通过 window.open() 打开已声明的 Widget,不支持打开 Page、外部 URL 或任意未在 app.json.widgets 中配置的 Widget。调用会立即返回,不会返回 Widget 实例或打开结果。Widget 的声明方式请参阅 Widget,完整路由说明请参阅路由。

关闭当前智能体

调用 window.close() 向宿主发送关闭当前智能体实例的请求:

window.close();

该方法只发送关闭请求,实际关闭时机由宿主管理。

直接编码 ImageBitmap

const imageData = new ImageData(2, 2);
const bitmap = await createImageBitmap(imageData);
try {
  const blob = await createImageBlob(bitmap, { type: 'image/png' });
  await upload(blob);
} finally {
  bitmap.close();
}

createImageBlob() 是全局函数,用于将打开状态的 ImageBitmap 异步编码为 PNG 或 JPEG Blob。不需要 Canvas 合成时可直接使用。调用开始后再关闭 bitmap 不会取消编码;在调用时传入已关闭的 bitmap 会以 InvalidStateError reject。

全局访问

在普通 AIUI 窗口中,window、self、globalThis 和 global 指向同一个全局对象:

console.log(window === globalThis); // true
console.log(window === self); // true
console.log(window === global); // true

AIUI 会将部分 Web API 显式挂载到 window,但不要据此推断每个可直接使用的全局符号都存在对应的 window.xxx 属性。具体暴露方式与限制请查看对应的 API 页面。

Agent Worker 使用独立的全局作用域,不提供 Window。有关 Worker 全局对象和生命周期,请参阅 AgentWorker。

API Reference

window.innerWidth

  • 类型:只读 number。
  • 说明:返回当前窗口视口的宽度,单位为像素。

window.innerHeight

  • 类型:只读 number。
  • 说明:返回当前窗口视口的高度,单位为像素。

window.open(url, target?)

请求宿主打开当前智能体中已声明的 Widget。

参数类型必填说明
urlstring是app.json.widgets 中已声明的 Widget 路径,可附带查询参数;省略 .ink 扩展名。
target'_widget'否打开目标,默认值为 _widget,也是当前唯一支持的值。

返回值:undefined。

url 为空时抛出 TypeError。不要传入 _widget 以外的 target 值;AIUI 不支持通过该方法打开其他目标。

window.close()

请求宿主关闭当前智能体实例。

返回值:undefined。

window.atob(encodedData)

将 Base64 编码的字符串解码为二进制字符串。

  • 参数:encodedData,string,要解码的 Base64 字符串。
  • 返回值:解码后的 string。

window.btoa(stringToEncode)

将二进制字符串编码为 Base64 字符串。

  • 参数:stringToEncode,string,要编码的二进制字符串。
  • 返回值:Base64 编码后的 string。

createImageBlob(source, options?)

将 ImageBitmap 异步编码为 PNG 或 JPEG Blob。source 必须在调用时处于打开 状态;不支持稳定可读像素的 native external/GPU 图像会以 NotSupportedError reject,编码队列已满时会以 EncodingError reject。

参数类型必填说明
sourceImageBitmap是待读取并编码的位图。
options.typestring否输出 MIME type,默认为 image/png;image/jpeg 选择 JPEG,其他值回落为 PNG。
options.qualitynumber否JPEG 质量,取值 0 至 1;无效值使用编码器默认值,PNG 会忽略。

返回值:Promise<Blob>,其 type 表示实际输出格式。