Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

HiClassSliceControlDataType

互动学堂操作类型汇总

InitServiceStatusParams

OldDrawType

OldDrawType: "freeline" | "line" | "circ" | "ellipse" | "rect" | "straightLine" | "arrowLine" | "text"

旧版的绘制类型

compatible
freeline

自由曲线

line

自由曲线,与 freeLine 一致

rect

矩形

circ

椭圆

ellipse

椭圆,与 circ 一致

straightline

直线

arrowline

箭头

text

文本

OnSliceControlDataType

操作数据类型汇总类型

PolyvAutoIdType

PolyvAutoIdType: number | string

保利威 Socket 数据中 autoId 类型

PolyvChannelIdType

PolyvChannelIdType: string

频道号类型

PolyvDocJson

docJson 类型

PolyvDocType

PolyvDocType: 0 | "0" | "old" | 1 | "1" | "new"

保利威文档 docType 类型,服务层所有 docType 均默认为 1

PolyvRoomIdType

PolyvRoomIdType: number | string

保利威房间号类型

PolyvSessionIdType

PolyvSessionIdType: string

保利威场次号类型

PolyvStepType

PolyvStepType: number | string

保利威 Socket 数据中 step 类型

PptVideoPosition

PptVideoPosition: 0 | 1

文档与视频位置,0-文档在主区域,1-文档在视频区

ServiceDocVersion

ServiceDocVersion: "v1" | "v2"

服务层文档类型。 v1 - 使用旧接口获取 docJson。 v2 - 使用新接口获取 docJson。

SocketType

所有 Socket 数据类型汇总的类型

TaskStoreMapVal

TaskStoreMapVal: Promise<void>

任务的类型

Variables

defaultDomainInfo

defaultDomainInfo: Required<DomainInfo> = ...

域名信息

historyTaskStoreMap

historyTaskStoreMap: Map<TaskStoreMapKey, TaskStoreMapVal> = ...

请求画笔数据任务存储器

Functions

filterToServiceDocVision

  • 转换 docType,使其转换成服务层的 docVersion,'0'0old 时返回 v1,其他值则返回 v2,不传返回 v2

    api

    Parameters

    Returns ServiceDocVersion

formatDocJson

  • 处理从接口获取的 docJson 数据,转换为白板格式

    api

    Parameters

    Returns Promise<PptJsonType>

formatDocJsonV1

  • 将 v1 docJson 数据,转换为白板格式

    api

    Parameters

    Returns Promise<PptJsonType>

formatDocJsonV2

  • 将 v2 docJson 数据,转换为白板格式

    api

    Parameters

    Returns Promise<PptJsonType>

formatDomainInfo

  • 格式化域名信息

    Parameters

    Returns Required<DomainInfo>

formatPolyvAutoId

  • 格式化 autoId,将其转换成 string 类型

    Parameters

    Returns string

formatSocketData

  • 格式化 socket 数据,格式失败时会返回 undefined

    api

    Parameters

    • data: string | SocketType

      json 字符串或 json 数据

    Returns SocketType | undefined

formatStep

  • 格式化 Socket 中的 step 字段,使其转换成 number 类型,如果传入的是一个 undefined 则返回 0。

    Parameters

    Returns number

getDocTypeByCache

getHistoryTask

getPolyvDocJson

getPolyvDocJsonV1

getPolyvDocJsonV2

getSinglePagePptData

isDocJsonV1

isDocJsonV2

isEqualAutoId

isRightEvent

  • isRightEvent(data: string | Record<string, unknown>): boolean
  • 判断 socket 中的事件是否为服务内部所需的事件

    api

    Parameters

    • data: string | Record<string, unknown>

      json 字符串或 json 数据

    Returns boolean

removeHistoryTask

  • 移除请求对象

    Parameters

    Returns void

setHistoryTask