Player
- Web
更新时间
Whiteboard Web SDK 2.16.59 公开 interface。
export declare interface Player extends Displayer成员
- roomUUID
- slice
- isPlayable
- phase
- state
- progressTime
- timeDuration
- framesCount
- beginTimestamp
- playbackSpeed
- play
- pause
- stop
- seekToProgressTime
- setObserverMode
继承自 Displayer
Properties
roomUUID
readonly roomUUID: string;
录像所属的房间 UUIDslice
readonly slice: string;
当前录像所属的分片唯一识别符isPlayable
readonly isPlayable: boolean;
当前是否能立即播放(可能会缓冲)phase
readonly phase: PlayerPhase;
回放播放器连接的阶段state
readonly state: PlayerState;
业务状态
阅读 [《房间与回放的业务状态管理》](/javascript-zh/home/business-state-management) 、[《房间业务状态管理》](/document-zh/home/business-state-management) 以了解更多。progressTime
readonly progressTime: number;
播放进度(毫秒),录像开始时为 0timeDuration
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;播放Returns
void
pause
pause(): void;暂停Returns
void
stop
stop(): void;停止Returns
void
seekToProgressTime
seekToProgressTime(progressTime: number): Promise<PlayerSeekingResult>;跳转到特定进度Returns
Promise<PlayerSeekingResult>
setObserverMode
setObserverMode(observerMode: ObserverMode): void;修改观察模式Returns
void
refreshViewSize
refreshViewSize(): void;Returns
void
setCameraBound
setCameraBound(cameraBound: CameraBound): void;Returns
void
createScenesCallback
createScenesCallback(path: string, callbacks?: Partial<ScenesCallbacks>): ScenesCallbacksNode | null;Returns
ScenesCallbacksNode | null
memberState
memberState(memberId: number): MemberState;Returns
MemberState
moveCamera
moveCamera(camera: Partial<Camera> & Readonly<{ animationMode?: AnimationMode; }>): void;Returns
void
moveCameraToContain
moveCameraToContain(rectangle: Rectangle & Readonly<{ animationMode?: AnimationMode; }>): void;Returns
void
bindHtmlElement
bindHtmlElement(element: HTMLDivElement | null): void;Returns
void
getInvisiblePlugin
getInvisiblePlugin<A extends Object, MA extends Object>(kind: string): InvisiblePlugin<A, MA> | null;Returns
InvisiblePlugin<A, MA> | null
convertToPointInWorld
convertToPointInWorld(point: { x: number; y: number; }): { x: number; y: number; };Returns
{ x: number; y: number; }
scenePreview
scenePreview(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;Returns
void
generateScreenshot
generateScreenshot(scenePath?: string, width?: number, height?: number): Promise<string>;Returns
Promise<string>
fillSceneSnapshot
fillSceneSnapshot(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;Returns
void
screenshotToCanvas
screenshotToCanvas(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number): void;Returns
void
screenshotToCanvasAsync
screenshotToCanvasAsync(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number, timeout?: number): Promise<void>;Returns
Promise<void>
getBoundingRect
getBoundingRect(scenePath: string): Rectangle;Returns
Rectangle
addMagixEventListener
addMagixEventListener(event: string, listener: EventListener, options?: MagixEventListenerOptions): void;addMagixEventListener(event: string, listener: EventsListener, fireInterval: number): void;Returns
void
Returns
void
removeMagixEventListener
removeMagixEventListener(event: string, listener?: EventListener): void;Returns
void
waitMagixEvent
waitMagixEvent(filter: EventFilter): Promise<Event>;Returns
Promise<Event>
scalePptToFit
scalePptToFit(animationMode?: AnimationMode): void;Returns
void
scenePathType
scenePathType(path: string): ScenePathType;Returns
ScenePathType
entireScenes
entireScenes(): SceneMap;Returns
SceneMap
getScene
getScene(path: string): WhiteScene | undefined;Returns
WhiteScene | undefined