Class World

constructor

• new World(options): World

• Parameters

  • options: IWorldOptions

  Returns World

DefaultAvatarClass

camera

d_allowDropFrame

d_dropFrameCout

d_dropFrameTarget

d_isInDropFrame

decoder

joystick

Optional lastEnterTime

Optional preCreateScannerManager

preload

renderDropRate

serverless

textGroup

voiceGroup

actorsMap

• get actorsMap(): Map<string, IExtendedActor>

• 获取所有被创建的 Actors

  Returns Map<string, IExtendedActor>

avatars

• get avatars(): Avatar[]

• 主角 + 同步Avatar 列表

  Returns Avatar[]

disableClickNavigation

• get disableClickNavigation(): boolean

• Returns boolean

• set disableClickNavigation(disableClickNavigation): void

• Parameters

  • disableClickNavigation: boolean

  Returns void

enableMSAA

• get enableMSAA(): boolean

• 获取是否开启 MSAA

  Returns boolean
• set enableMSAA(val): void

• 设置是否开启 MSAA

  Parameters

  • val: boolean

  Returns void

movementTriggerMode

• get movementTriggerMode(): IMovementTriggerMode

• Returns IMovementTriggerMode

• set movementTriggerMode(movementTriggerMode): void

• Parameters

  • movementTriggerMode: IMovementTriggerMode

  Returns void

panoramaFov

• get panoramaFov(): number

• Returns number

• set panoramaFov(value): void

• Parameters

  • value: number

  Returns void

paused

• get paused(): boolean

• Returns boolean

useGDVId

• get useGDVId(): boolean

• Returns boolean

afterPanoramaActived

• afterPanoramaActived(): void

• 进入全景图的后处理

  Returns void

changePlayer

• changePlayer(player, AvatarClass?): Promise<void>

• 切换用户角色骨骼模型

  Parameters

  • player: IPlayerOptions

  • Optional AvatarClass: ConstructorType<Avatar>

  Returns Promise<void>

  Throws

checkSupport

• checkSupport(): Promise<void>

• 检测机型支持 可多次调用

  Returns Promise<void>

clearInterval

• clearInterval(timerHandle): void

• 取消定时任务 timeout和interval均可

  Parameters

  • timerHandle: number

    设置定时任务时返回的handle

  Returns void

clearTimeout

• clearTimeout(timerHandle): void

• 取消定时任务 timeout和interval均可

  Parameters

  • timerHandle: number

    设置定时任务时返回的handle

  Returns void

destroy

• destroy(): void

• 销毁世界

  Returns void

disposeEnvLight

• disposeEnvLight(): void

• 删除当前环境光

  Returns void

enqueue

• enqueue(): Promise<unknown>

• 排队接口

  Returns Promise<unknown>

getActorById

• getActorById<T>(id): null | T

• 根据 Actor id获取 Actor 实例

  Type Parameters

  • T extends IExtendedActor

  Parameters

  • id: string

  Returns null | T

getActorByUuid

• getActorByUuid<T>(uuid): null | T

• 根据 Actor uuId获取 Actor 实例

  Type Parameters

  • T extends IExtendedActor

  Parameters

  • uuid: string

  Returns null | T

getActorViewer

• getActorViewer(): ActorViewer

• 获取actorViewer

  Returns ActorViewer

getActorsByType

• getActorsByType<T>(ActorClass): T[]

• 根据 Actor 类型获取 Actor 实例集合。内部实现是使用的 instanceof

  Type Parameters

  • T extends IExtendedActor

  Parameters

  • ActorClass: ConstructorType<T>

  Returns T[]

getAssociatedHttpApi

• getAssociatedHttpApi(isPublic?): string

• 获取关联的 HTTP 接口

  Parameters

  • isPublic: boolean = false

    是否为公共接口，默认false

  Returns string

getAvatarDelayCreateManager

• getAvatarDelayCreateManager(): AvatarDelayCreateManager

• 获取AvatarDelayCreateManager

  Returns AvatarDelayCreateManager

getBlockOthersSyncInfo

• getBlockOthersSyncInfo(): boolean

• 获取是否接受云端同步信息

  Returns boolean

getCamera

• getCamera(): Camera

• 获取镜头实例

  Returns Camera

getClickingEvent

• getClickingEvent(): ClickingEvent

• Returns ClickingEvent

getCurrentRoom

• getCurrentRoom(): Room

• 获取当前房间

  Returns Room

getFpsDetector

• getFpsDetector(): FPSDetector

• 获取FPS检测器

  Returns FPSDetector

getGuideNpc

• getGuideNpc<T>(instance?): T

• 获取 npc 的引用，传入的 AvatarClass 必须是 Avatar 的子类 TODO: 若新建了多个npc如何管理

  Type Parameters

  • T extends Avatar

  Parameters

  • Optional instance: Avatar | ConstructorType<T>

  Returns T

getGyroscope

• getGyroscope(): Gyroscope

• Returns Gyroscope

getJoystick

• getJoystick(): JoyStick

• Returns JoyStick

getKeyboard

• getKeyboard(): Keyboards

• Returns Keyboards

getMediaManager

• getMediaManager(props?): MediaManager

• 获取Media管理器

  Parameters

  • Optional props: IMediaManagerProps

  Returns MediaManager

getNetworkDetector

• getNetworkDetector(networkDetectorType?): NetworkDetector

• 使用的网络质量检测基准，默认值是基于 xrtc 模块的网络探测逻辑

  Parameters

  • Optional networkDetectorType: default | rtt

    ENetworkDetectorType

  Returns NetworkDetector

getNpc

• getNpc(npcId, npcOptions, ActorClass?): undefined | Avatar

• Parameters

  • npcId: string

    建议使用NPC出生点的bomId作为npcID

  • npcOptions: {
        avatarId?: string;
        birthPoint: IOrientedObject;
        fromPrecreate?: boolean;
        npcConfig: IAavatarAniAndCompConfig;
        npcName?: string;
        priority?: number;
        roomId?: string;
        scale?: {
            x: number;
            y: number;
            z: number;
        };
    }

    npc配置信息，默认优先级为1

    • Optional avatarId?: string

    • birthPoint: IOrientedObject

    • Optional fromPrecreate?: boolean

    • npcConfig: IAavatarAniAndCompConfig

    • Optional npcName?: string

    • Optional priority?: number

    • Optional roomId?: string

    • Optional scale?: {
          x: number;
          y: number;
          z: number;
      }

      • x: number

      • y: number

      • z: number

  • Optional ActorClass: ConstructorType<Avatar>

  Returns undefined | Avatar

getPlayer

• getPlayer<T>(AvatarClass?): T

• 获取玩家 Avatar 的引用，传入的 AvatarClass 必须是 Avatar 的子类

  Type Parameters

  • T extends Avatar

  Parameters

  • Optional AvatarClass: ConstructorType<T>

  Returns T

getPreload

• getPreload(): Preload

• 获取预加载实例

  Returns Preload

getRoomConfigs

• getRoomConfigs(): IRoomConfig[]

• Returns IRoomConfig[]

getRoomInstance

• getRoomInstance<T>(roomId, RoomClass?, options?): null | T

• 获取 Room 实例 TODO: 传入错误 roomId 是否返回空还是 throw error

  Type Parameters

  • T extends Room

  Parameters

  • roomId: string

  • Optional RoomClass: ConstructorType<T>

  • Optional options: IRoomOptions

  Returns null | T

getRoomInstances

• getRoomInstances(): Room[]

• 获取已经加载过的 Room

  Returns Room[]

getRotationEvent

• getRotationEvent(): RotationEvent

• Returns RotationEvent

getSeverTime

• getSeverTime(): Promise<string[]>

• 获取后台提供的当前时间

  Returns Promise<string[]>

  返回[UNIX秒级时间戳,格式化后的时间]

getSpatialAudio

• getSpatialAudio(): SpatialAudio

• 获取空间音频

  Returns SpatialAudio

getStats

• getStats(): Stats

• 获取 Stats 实例

  Returns Stats

getTextGroup

• getTextGroup(): TextGroup

• 获取 TextGroup

  Returns TextGroup

getVoiceGroup

• getVoiceGroup(): VoiceGroup

• 获取语音组实例

  Returns VoiceGroup

getVoiceGroupV2

• getVoiceGroupV2(): VoiceGroupV2

• 获取语音组V2实例

  Returns VoiceGroupV2

getWaterMaker

• getWaterMaker(): undefined | HTMLElement

• Returns undefined | HTMLElement

getWorldCopyId

• getWorldCopyId(userNumLimit?): Promise<string>

• 获取一个 World 副本 TODO:

  Parameters

  • userNumLimit: number = 30

  Returns Promise<string>

init

• init(): Promise<void>

• 世界和网络初始化，建议在预加载完成之后调用

  Returns Promise<void>

judgeChannelType

• judgeChannelType(): Promise<void>

• 根据分辨率自动决定使用软解/硬解 如果开启[强制设置解码类型]选项，则跳过 目前只有playground里使用该方法

  Returns Promise<void>

keepingAlive

• keepingAlive(): void

• 保持与后台的心跳，不会被剔出房间

  Returns void

obstacleThroughDisable

• obstacleThroughDisable(): void

• Returns void

onCollectActorSuccess

• onCollectActorSuccess(event): any

• 收集actor成功

  Parameters

  • event: ICollectEvent

  Returns any

onDisconnected

• onDisconnected(event): any

• SDK与元象服务器断开时触发

  Parameters

  • event: Event

  Returns any

onEnqueuing

• onEnqueuing(event): any

• 排队信息

  Parameters

  • event: Event

  Returns any

onEnteringForReconnect

• onEnteringForReconnect(event): any

• 重连进房

  Parameters

  • event: Event

  Returns any

onFatalError

• onFatalError(event): any

• 致命错误，需reload页面

  Parameters

  • event: Event

  Returns any

onFirstEnteringRoom

• onFirstEnteringRoom(event): any

• 初次进房

  Parameters

  • event: Event

  Returns any

onPathChanged

• onPathChanged(event): any

• 任意房间内 Path 切换时触发

  Parameters

  • event: IPathChangedEvent

  Returns any

onPause

• onPause(event): any

• 世界暂停

  Parameters

  • event: Event

  Returns any

onQueueVerifyFailed

• onQueueVerifyFailed(event): any

• 排队信息

  Parameters

  • event: Event

  Returns any

onReconnected

• onReconnected(event): any

• SDK与元象服务器重新连接成功触发

  Parameters

  • event: Event

  Returns any

onReconnecting

• onReconnecting(event): any

• SDK尝试与元象服务器重新连接时触发

  Parameters

  • event: Event

  Returns any

onRenderError

• onRenderError(event): any

• 渲染出错触发，改用fatalError

  Parameters

  • event: Event

  Returns any

  Deprecated

onRepeatLogin

• onRepeatLogin(event): any

• 元象服务器将 userId 踢下线时触发

  Parameters

  • event: Event

  Returns any

onResume

• onResume(event): any

• 世界恢复

  Parameters

  • event: Event

  Returns any

onRoomSwitched

• onRoomSwitched(event): any

• 房间切换时触发

  Parameters

  • event: IRoomSwitchedEvent

  Returns any

onSkinChanged

• onSkinChanged(event): any

• 任意房间内 Skin 切换时触发

  Parameters

  • event: ISkinSwitchedEvent

  Returns any

onUserKicked

• onUserKicked(event): any

• 使用同一个 userId 重复进入 World 时触发，旧的 world 会触发该事件

  Parameters

  • event: Event

  Returns any

pause

• pause(completely?): void

• 暂停世界更新、渲染

  Parameters

  • completely: boolean = false

  Returns void

postProcess

• postProcess(targetPathConfig, traceId?): void

• 进房/切流完成的统一后处理

  Parameters

  • targetPathConfig: IPathConfig

  • Optional traceId: string

  Returns void

preCheck

• preCheck(): Promise<void>

• Returns Promise<void>

  Deprecated

  使用checkSupport + preInit

preInit

• preInit(ve?): Promise<void>

• 获取调度、配置、初始化引擎等逻辑 只应调用一次，也做了多次调用的阻挡，多次调用只生效一次

  Parameters

  • Optional ve: HTMLVideoElement

  Returns Promise<void>

prepareForReEnterWorld

• prepareForReEnterWorld(targetRoom, worldId, birthPoint): void

• 主动重新进入世界

  Parameters

  • targetRoom: Room

  • worldId: string

  • birthPoint: IBirthPoint

  Returns void

reconnect

• reconnect(): Promise<void>

• 与元象后端连接断开后，重连

  Returns Promise<void>

requeue

• requeue(): Promise<void>

• 重新排队

  Returns Promise<void>

resize

• resize(): void

• 渲染画面重新适应画布大小

  Returns void

resume

• resume(): void

• 继续世界更新、渲染

  Returns void

setAvatarVisibilityCullingDistance

• setAvatarVisibilityCullingDistance(dis): void

• Parameters

  • dis: number

  Returns void

setBackgroundImage

• setBackgroundImage(url): Promise<void>

• 设置背景图片

  Parameters

  • url: string | false

  Returns Promise<void>

setBlockOthersSyncInfo

• setBlockOthersSyncInfo(state): void

• 设置是否阻塞接受云端同步信息

  Parameters

  • state: boolean

    false 不阻塞云端同步信息, true 阻塞云端同步信息

  Returns void

setEnvLight

• setEnvLight(envFilePath): void

• 设置环境光（包含加载）

  Parameters

  • envFilePath: string | string[]

    环境光路径

  Returns void

setEnvLightIntensity

• setEnvLightIntensity(intensity): void

• 设置环境光强度

  Parameters

  • intensity: number

    环境光强度，引擎默认为1.5

  Returns void

setInterval

• setInterval(fn, time): number

• 添加持续执行的定时任务 如果时间间隔小于1000/World.FPS(正常为40ms),则变为每Tick执行一次

  Parameters

  • fn: (() => void)

    定时任务

    • • (): void

      • Returns void

  • time: number

    时间间隔,单位毫秒,建议大于40ms

  Returns number

  0 失败; >0 任务handle，可用于取消任务

setLightConfig

• setLightConfig(url): void

• 设置灯光包配置,包含环境光,点光源等

  Parameters

  • url: string

  Returns void

setLod

• setLod(lodSettings): void

• 设置同屏人数

  Parameters

  • lodSettings: ILodSettings[]

  Returns void

setObjectFit

• setObjectFit(type): void

• Parameters

  • type: "contain" | "cover"

  Returns void

setPictureQualityLevel

• setPictureQualityLevel(level): void

• 设置 画质

  Parameters

  • level: IPictureQualityLevel

  Returns void

setServerless

• setServerless(isServerless): void

• 设置无网模式

  Parameters

  • isServerless: boolean

  Returns void

setSize

• setSize(height, width): void

• 设置渲染分辨率

  Parameters

  • height: number

  • width: number

  Returns void

setTimeout

• setTimeout(fn, time): number

• 添加定时任务

  Parameters

  • fn: (() => void)

    定时任务

    • • (): void

      • Returns void

  • time: number

    时间间隔,单位毫秒

  Returns number

  0 失败; >0 任务handle，可用于取消任务

setVisibilityCullingDistance

• setVisibilityCullingDistance(min, max): void

• 设置场景可渲染物件（Richsurface、Subsequence）的可视距离，降低渲染开销 Avatar的可视距离不受此控制，使用AvatarManager.setLodSettings控制

  Parameters

  • min: number

    最近距离

  • max: number

    最远距离

  Returns void

setWaterMarker

• setWaterMarker(): void

• 绘制水印

  Returns void

shouldAppEnqueue

• shouldAppEnqueue(): boolean

• 当前用户是否需要排队 以下情况不用排队

  1. 当前用户前面没有排队用户
  2. 当前App未接入排队系统

  Returns boolean

spawn

• spawn<T>(ActorClass, disposeOnRoomLeave?, params?, preCreateOpts?): T

• Type Parameters

  • T extends IExtendedActor

  Parameters

  • ActorClass: ConstructorType<T>

    Actor类型

  • disposeOnRoomLeave: boolean = true

    Room Leave 时是否 dispose 该 Actor，默认 true

  • Optional params: ISpawnParameters

  • Optional preCreateOpts: IPreCreateOptions

  Returns T

stopKeepingAlive

• stopKeepingAlive(): void

• 停止与后台保活

  Returns void

updateReporterHeader

• updateReporterHeader(header): void

• 用于更新上报信息header

  Parameters

  • header: Partial<IReportHeader>

  Returns void

Static SetLoggerLevels

• SetLoggerLevels(level): void

• Parameters

  • level: ELoggerLevels

  Returns void