Interface IWorldOptions

World 初始化的参数

interface IWorldOptions {
    appId: string;
    canvas: string;
    consoleEnv?: "sit" | "uat" | "prod";
    env?: "sit" | "uat" | "prod";
    forbiddenWatermark?: boolean;
    fps?: number;
    globalDataVersionId?: string;
    ignoreSchedule?: boolean;
    moveSpeed?: number;
    obstacleThroughEnable?: boolean;
    pageSession?: string;
    releaseId?: string;
    scheduleUrl?: string;
    serverless?: boolean;
    signalUrl?: string;
    token: string;
    userId: string;
    webgl1?: boolean;
    worldId: string;
}

Properties

appId canvas consoleEnv? env? forbiddenWatermark? fps? globalDataVersionId? ignoreSchedule? moveSpeed? obstacleThroughEnable? pageSession? releaseId? scheduleUrl? serverless? signalUrl? token userId webgl1? worldId

Properties

appId

appId: string

AppId，业务 App ID

canvas

canvas: string

canvas 画布 css 选择器

Optional consoleEnv

consoleEnv?: "sit" | "uat" | "prod"

资产环境参数，选填

Optional env

env?: "sit" | "uat" | "prod"

环境参数，选填

Optional forbiddenWatermark

forbiddenWatermark?: boolean

禁用uid水印

Optional fps

fps?: number

FPS ibr默认30 vbr默认25

Deprecated

sdk自动决定，不再支持设置 只能通过url指定custom_fps=xx来指定

Optional globalDataVersionId

globalDataVersionId?: string

global data version ID

Optional ignoreSchedule

ignoreSchedule?: boolean

ignoreSchedule: 忽略调度，选填。默认false。为true时，不会请求调度地址，直接使用传入的信令地址，此时signalUrl必须同时传入。 scheduleUrl: 请求调度地址，选填。默认不传，使用默认调度地址。

Optional moveSpeed

moveSpeed?: number

云摇杆移动速度,一般不需要设置

Optional obstacleThroughEnable

obstacleThroughEnable?: boolean

是否开启软解 deprecated 2.3.6版本开始根据分辨率自动判定 2.3.17 版本恢复使用该字段 2.3.20 版本废弃此字段，不再支持设置硬解

Optional pageSession

pageSession?: string

pageSession

Optional releaseId

releaseId?: string

发布 ID

Optional scheduleUrl

scheduleUrl?: string

Optional serverless

serverless?: boolean

serverless 模式不需要后端服务，但是需要 preload 完整资源 只支持以本地全景图进房，进房后不允许再切path true: 开启无网模式； false: 关闭无网模式

Optional signalUrl

signalUrl?: string

请求信令地址，选填

token

token: string

用户 Token

userId

userId: string

用户进入世界的唯一标识

Optional webgl1

webgl1?: boolean

true: 允许webgl1设备进入； false: 不允许 默认不允许

worldId

worldId: string

后端分配的世界 ID

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc