cve-connector/types/utils/web-component.d.ts

UE Web 开发套件

import type { UIDescriptor } from './matchmaker'

export interface EventDetail {
  command: UIDescriptor
  error: unknown
  featurehover: UIDescriptor
  featureselect: UIDescriptor
  message: UIDescriptor
  mouseclick: UIDescriptor
  roam: string
  sequencepause: string
  sequenceplay: string
  sequencestop: string
  start: number
  stop: string
  timechange: string
  yaw: number
}

export type EventType =
  | 'command'
  | 'error'
  | 'featurehover'
  | 'featureselect'
  | 'message'
  | 'mouseclick'
  | 'roam'
  | 'sequencepause'
  | 'sequenceplay'
  | 'sequencestop'
  | 'start'
  | 'stop'
  | 'timechange'
  | 'yaw'

export interface Player extends HTMLElement {
  /**
   * UE 应用名称
   * - 可选
   * - 无默认值
   */
  applicationName: string
  /**
   * 云渲染视口纵横比例
   * - 可选
   * - 示例: 'auto', '16 / 9', '4 / 3'
   * - 默认值: 'auto'
   */
  aspectRatio: string
  height: number
  /**
   * 云渲染源地址
   * - 协议://主机:端口/路径
   * - 可选
   * - 无默认值
   */
  matchMakerURL: string
  /** Web 发送指令到 UE */
  set oncommand(handler: (evt: CustomEvent<UIDescriptor>) => void)
  /** 鼠标悬浮/离开在点、线、面之上 */
  set onfeaturehover(handler: (evt: CustomEvent<UIDescriptor>) => void)
  /** 点、线、面被选中/取消选中 */
  set onfeatureselect(handler: (evt: CustomEvent<UIDescriptor>) => void)
  /** UE 传递消息到 Web */
  set onmessage(handler: (evt: CustomEvent<UIDescriptor>) => void)
  /** UE 鼠标点击事件 */
  set onmouseclick(handler: (evt: CustomEvent<UIDescriptor>) => void)
  /** 路径漫游时 */
  set onroam(handler: (evt: CustomEvent<string>) => void)
  /** 过场动画暂停播放 */
  set onsequencepause(handler: (evt: CustomEvent<string>) => void)
  /** 过场动画开始播放 */
  set onsequenceplay(handler: (evt: CustomEvent<string>) => void)
  /** 过场动画停止播放 */
  set onsequencestop(handler: (evt: CustomEvent<string>) => void)
  /** 云渲染开始 */
  set onstart(handler: (evt: CustomEvent<number>) => void)
  /** 云渲染结束 */
  set onstop(handler: (evt: CustomEvent<string>) => void)
  /** 时间变化，若不需要时间变化，可禁用实时功能 */
  set ontimechange(handler: (evt: CustomEvent<string>) => void)
  /** 绕垂直轴的旋转运动，即横摇运动，以正北方为起点的方位角旋转 */
  set onyaw(handler: (evt: CustomEvent<number>) => void)
  /**
   * 像素流准是否准备好
   * - 标记为 true 时 Controller 的方法才可以使用
   * - start 开始后为 true, 断开连接后为 false
   */
  ready: boolean
  /**
   * 信令服务地址
   * - 协议://主机:端口/路径
   * - 可选
   * - 无默认值
   */
  signalingURL: string
  /**
   * UE 音量
   * - 可选
   * - 默认值: 0.3
   */
  volume: number
  width: number
}