Player

Whiteboard Web SDK 2.16.59 公开 interface。

JavaScript

export declare interface Player extends Displayer  

Properties

roomUUID

readonly roomUUID: string;

录像所属的房间 UUID

slice

readonly slice: string;

当前录像所属的分片唯一识别符

isPlayable

readonly isPlayable: boolean;

当前是否能立即播放（可能会缓冲）

phase

readonly phase: PlayerPhase;

回放播放器连接的阶段

state

readonly state: PlayerState;

业务状态 阅读 《房间与回放的业务状态管理》 、《房间业务状态管理》 以了解更多。

progressTime

readonly progressTime: number;

播放进度（毫秒），录像开始时为 0

timeDuration

readonly timeDuration: number;

录像时长（毫秒）

framesCount

readonly framesCount: number;

录像总帧数

beginTimestamp

readonly beginTimestamp: number;

录像开始的绝对时间戳（unix 时间，毫秒）

playbackSpeed

playbackSpeed: number;

播放速度倍率，取 1.0 表明正常速度播放

callbacks

readonly callbacks: Callbacks<CALLBACKS>;

observerId

readonly observerId: number;

region

readonly region: string;

version

readonly version: string;

deviceType

readonly deviceType: DeviceType;

screenType

readonly screenType: ScreenType;

enableWriteNow

readonly enableWriteNow: boolean;

handToolKey

readonly handToolKey: string | undefined;

views

readonly views: Views;

useMobXState

readonly useMobXState: boolean;

useMultiViews

readonly useMultiViews: boolean;

handToolActive

handToolActive: boolean;

disableOthersSelectingBox

disableOthersSelectingBox: boolean;

disableCameraTransform

disableCameraTransform: boolean;

commandWheelToZoom

commandWheelToZoom: boolean;

Methods

play

play(): void;

播放

返回值

void

pause

pause(): void;

暂停

返回值

void

stop

stop(): void;

停止

返回值

void

seekToProgressTime

seekToProgressTime(progressTime: number): Promise<PlayerSeekingResult>;

跳转到特定进度

返回值

Promise<PlayerSeekingResult>

setObserverMode

setObserverMode(observerMode: ObserverMode): void;

修改观察模式

返回值

void

refreshViewSize

refreshViewSize(): void;

返回值

void

setCameraBound

setCameraBound(cameraBound: CameraBound): void;

返回值

void

createScenesCallback

createScenesCallback(path: string, callbacks?: Partial<ScenesCallbacks>): ScenesCallbacksNode | null;

返回值

ScenesCallbacksNode | null

memberState

memberState(memberId: number): MemberState;

返回值

MemberState

moveCamera

moveCamera(camera: Partial<Camera> & Readonly<{ animationMode?: AnimationMode; }>): void;

返回值

void

moveCameraToContain

moveCameraToContain(rectangle: Rectangle & Readonly<{ animationMode?: AnimationMode; }>): void;

返回值

void

bindHtmlElement

bindHtmlElement(element: HTMLDivElement | null): void;

返回值

void

getInvisiblePlugin

getInvisiblePlugin<A extends Object, MA extends Object>(kind: string): InvisiblePlugin<A, MA> | null;

返回值

InvisiblePlugin<A, MA> | null

convertToPointInWorld

convertToPointInWorld(point: { x: number; y: number; }): { x: number; y: number; };

返回值

{ x: number; y: number; }

scenePreview

scenePreview(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;

返回值

void

generateScreenshot

generateScreenshot(scenePath?: string, width?: number, height?: number): Promise<string>;

返回值

Promise<string>

fillSceneSnapshot

fillSceneSnapshot(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;

返回值

void

screenshotToCanvas

screenshotToCanvas(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number): void;

返回值

void

screenshotToCanvasAsync

screenshotToCanvasAsync(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number, timeout?: number): Promise<void>;

返回值

Promise<void>

getBoundingRect

getBoundingRect(scenePath: string): Rectangle;

返回值

Rectangle

addMagixEventListener

addMagixEventListener(event: string, listener: EventListener, options?: MagixEventListenerOptions): void;

addMagixEventListener(event: string, listener: EventListener, options?: MagixEventListenerOptions): void;

返回值

void

addMagixEventListener(event: string, listener: EventsListener, fireInterval: number): void;

addMagixEventListener(event: string, listener: EventsListener, fireInterval: number): void;

返回值

void

removeMagixEventListener

removeMagixEventListener(event: string, listener?: EventListener): void;

返回值

void

waitMagixEvent

waitMagixEvent(filter: EventFilter): Promise<Event>;

返回值

Promise<Event>

scalePptToFit

scalePptToFit(animationMode?: AnimationMode): void;

返回值

void

scenePathType

scenePathType(path: string): ScenePathType;

返回值

ScenePathType

entireScenes

entireScenes(): SceneMap;

返回值

SceneMap

getScene

getScene(path: string): WhiteScene | undefined;

返回值

WhiteScene | undefined