LiveStartService | 白板 SDK 开发文档

直播开播端服务

Hierarchy

LiveWatchService
- LiveStartService

Constructors

constructor

new LiveStartService(config: LiveStartServiceConfig): LiveStartService

Overrides LiveWatchService.constructor
Parameters
- config: LiveStartServiceConfig
Returns LiveStartService

Properties

Optional channelId

channelId?: string

频道号

Optional Readonly contentPropWhenWhiteBoard

contentPropWhenWhiteBoard?: number

当切换到白板时的内容层背景色

domainInfo

domainInfo: Required<DomainInfo>

域名信息

formatDocJson

formatDocJson: (docJson: PolyvDocJson) => Promise<PptJsonType> = ...

处理从接口获取的pptjson数据，转换为白板格式

Type declaration

- (docJson: PolyvDocJson): Promise<PptJsonType>
- 处理从接口获取的 docJson 数据，转换为白板格式
  
  api
  Parameters
  - docJson: PolyvDocJson
    
    保利威的 docJson
  Returns Promise<PptJsonType>

formatSocketData

formatSocketData: (data: string | SocketType) => SocketType | undefined = ...

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

Type declaration

- (data: string | SocketType): SocketType | undefined
- 格式化 socket 数据，格式失败时会返回 undefined
  
  api
  Parameters
  - data: string | SocketType
    
    json 字符串或 json 数据
  Returns SocketType | undefined

isRightEvent

isRightEvent: (data: string | Record<string, unknown>) => boolean = ...

判断 socket 中的事件是否为服务内部所需的事件

Type declaration

- (data: string | Record<string, unknown>): boolean
- 判断 socket 中的事件是否为服务内部所需的事件
  
  api
  Parameters
  - data: string | Record<string, unknown>
    
    json 字符串或 json 数据
  Returns boolean

Readonly needSessionId

needSessionId: boolean

是否需要 sessionId

Optional roomId

roomId?: PolyvRoomIdType

房间号

Optional Readonly sendSocketData

sendSocketData?: SendSocketDataFn

发送 socket 数据钩子函数

serviceName

serviceName: ServiceName = ...

服务名称

Optional sessionId

sessionId?: string

场次号

Readonly totalPageWhenWhiteBoard

totalPageWhenWhiteBoard: number

当切换到白板时的总页数

Optional whiteBoard

whiteBoard?: WhiteBoard

白板实例

Optional Readonly whiteBoardContentBg

whiteBoardContentBg?: string

当切换到白板时的内容层背景色

Static formatDocJson

formatDocJson: (docJson: PolyvDocJson) => Promise<PptJsonType> = ...

Type declaration

- (docJson: PolyvDocJson): Promise<PptJsonType>
- 处理从接口获取的 docJson 数据，转换为白板格式
  
  api
  Parameters
  - docJson: PolyvDocJson
    
    保利威的 docJson
  Returns Promise<PptJsonType>

Static formatSocketData

formatSocketData: (data: string | SocketType) => SocketType | undefined = ...

Type declaration

- (data: string | SocketType): SocketType | undefined
- 格式化 socket 数据，格式失败时会返回 undefined
  
  api
  Parameters
  - data: string | SocketType
    
    json 字符串或 json 数据
  Returns SocketType | undefined

Static getPolyvDocJson

getPolyvDocJson: (params: GetPolyvDocJsonParams) => Promise<PolyvDocJsonV1 | PolyvDocJsonV2> = ...

Type declaration

- (params: GetPolyvDocJsonParams): Promise<PolyvDocJsonV1 | PolyvDocJsonV2>
- 根据 docType 获取 docJson
  
  Parameters
  - params: GetPolyvDocJsonParams
  Returns Promise<PolyvDocJsonV1 | PolyvDocJsonV2>

Static getSinglePagePptData

getSinglePagePptData: (params: GetSinglePagePptDataParams) => Promise<SinglePageDataType[]> = ...

Type declaration

- (params: GetSinglePagePptDataParams): Promise<SinglePageDataType[]>
- 获取单页 ppt 画笔数据
  
  Parameters
  - params: GetSinglePagePptDataParams
  Returns Promise<SinglePageDataType[]>

Static isRightEvent

isRightEvent: (data: string | Record<string, unknown>) => boolean = ...

Type declaration

- (data: string | Record<string, unknown>): boolean
- 判断 socket 中的事件是否为服务内部所需的事件
  
  api
  Parameters
  - data: string | Record<string, unknown>
    
    json 字符串或 json 数据
  Returns boolean

Accessors

docType

get docType(): PolyvDocType

当前打开的文档类型，默认：1

Returns PolyvDocType

userInfo

get userInfo(): undefined | UserInfo

用户信息

Returns undefined | UserInfo

Methods

beforeDestroy

beforeDestroy(): void

Overrides LiveWatchService.beforeDestroy
Returns void

destroy

destroy(): void

Inherited from LiveWatchService.destroy

销毁当前插件

api
Returns void

getPolyvDocJson

getPolyvDocJson(params: GetPolyvDocJsonParams): Promise<PolyvDocJsonV1 | PolyvDocJsonV2>

Inherited from LiveWatchService.getPolyvDocJson

调用接口获取 docJson

Parameters
- params: GetPolyvDocJsonParams
Returns Promise<PolyvDocJsonV1 | PolyvDocJsonV2>

getSinglePagePptData

getSinglePagePptData(params: GetSinglePagePptDataParams): Promise<SinglePageDataType[]>

Inherited from LiveWatchService.getSinglePagePptData

获取单页 ppt 画笔数据

Parameters
- params: GetSinglePagePptDataParams
Returns Promise<SinglePageDataType[]>

inited

inited(): void

Overrides LiveWatchService.inited
Returns void

joinSocketData

joinSocketData(data: string | SocketType, params?: JoinSocketDataParams): void

Inherited from LiveWatchService.joinSocketData

插入 socket 消息

Parameters
- data: string | SocketType
  
  socket 消息数据
- params: JoinSocketDataParams = {}
Returns void

openDocument

openDocument(params: LiveStartOpenDocumentParams): Promise<void>

打开一份文档，autoId 不得为 0

api
Parameters
- params: LiveStartOpenDocumentParams
  
  打开参数
Returns Promise<void>

openWhiteBoard

openWhiteBoard(params: LiveStartOpenWhiteBoardParams): Promise<void>

打开白板

Parameters
- params: LiveStartOpenWhiteBoardParams
  
  打开参数
Returns Promise<void>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: LiveStartServiceConfig

Returns LiveStartService

Properties

Optional channelId

Optional Readonly contentPropWhenWhiteBoard

domainInfo

formatDocJson

Type declaration

Parameters

docJson: PolyvDocJson

Returns Promise<PptJsonType>

formatSocketData

Type declaration

Parameters

data: string | SocketType

Returns SocketType | undefined

isRightEvent

Type declaration

Parameters

data: string | Record<string, unknown>

Returns boolean

Readonly needSessionId

Optional roomId

Optional Readonly sendSocketData

serviceName

Optional sessionId

Readonly totalPageWhenWhiteBoard

Optional whiteBoard

Optional Readonly whiteBoardContentBg

Static formatDocJson

Type declaration

Parameters

docJson: PolyvDocJson

Returns Promise<PptJsonType>

Static formatSocketData

Type declaration

Parameters

data: string | SocketType

Returns SocketType | undefined

Static getPolyvDocJson

Type declaration

Parameters

params: GetPolyvDocJsonParams

Returns Promise<PolyvDocJsonV1 | PolyvDocJsonV2>

Static getSinglePagePptData

Type declaration

Parameters

params: GetSinglePagePptDataParams

Returns Promise<SinglePageDataType[]>

Static isRightEvent

Type declaration

Parameters

data: string | Record<string, unknown>

Returns boolean

Accessors

docType

Returns PolyvDocType

userInfo

Returns undefined | UserInfo

Methods

beforeDestroy

Returns void

destroy

Returns void

getPolyvDocJson

Parameters

params: GetPolyvDocJsonParams

Returns Promise<PolyvDocJsonV1 | PolyvDocJsonV2>

getSinglePagePptData

Parameters

params: GetSinglePagePptDataParams