Class Player

Hierarchy

Subscribe<VreoKeyframeEvent>
- Player

Index

Constructors

constructor

Properties

Accessors

paused

Methods

Constructors

constructor

new Player(five: Five, configs?: Partial<PlayerConfigs>): Player

Overrides Subscribe<VreoKeyframeEvent>.constructor
- Defined in resources/Player/index.tsx:18
Parameters
- five: Five
- configs: Partial<PlayerConfigs> = {}
Returns Player

Properties

$five

$five: Five

configs

configs: Readonly<PlayerConfigs>

Private controller

controller: Controller

Accessors

paused

get paused(): boolean

- Defined in resources/Player/index.tsx:167
Returns boolean

Methods

dispose

dispose(): void

- Defined in resources/Player/index.tsx:198
Returns void

emit

emit<K>(name: K, ...data: Parameters<VreoKeyframeEvent[K]>): boolean

Inherited from Subscribe.emit
- Defined in node_modules/@realsee/five/five/index.d.ts:1914
触发事件

Type parameters
- K: VreoKeyframeEnum | "loaded" | "paused" | "playing" | "unknownKeyframeType" | "ended"
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<VreoKeyframeEvent[K]>
  
  触发事件的数据
Returns boolean
canceled 是否被触发取消

getCurrentTime

getCurrentTime(): number

- Defined in resources/Player/index.tsx:194
Returns number

hasListener

hasListener(name: VreoKeyframeEnum | "loaded" | "paused" | "playing" | "unknownKeyframeType" | "ended"): boolean

Inherited from Subscribe.hasListener
- Defined in node_modules/@realsee/five/five/index.d.ts:1877
判断是否注册了事件

Parameters
- name: VreoKeyframeEnum | "loaded" | "paused" | "playing" | "unknownKeyframeType" | "ended"
  
  事件类型
Returns boolean

hide

hide(): void

- Defined in resources/Player/index.tsx:190
Returns void

load

load(vreoUnit: VreoUnit, currentTime?: number, preload?: boolean, force?: boolean): Promise<boolean>

- Defined in resources/Player/index.tsx:89
Parameters
- vreoUnit: VreoUnit
- currentTime: number = 0
- preload: boolean = false
- force: boolean = false
Returns Promise<boolean>

off

off<K>(name?: K, callback?: (...args: Parameters<VreoKeyframeEvent[K]>) => ReturnType<VreoKeyframeEvent[K]>): void

Inherited from Subscribe.off
- Defined in node_modules/@realsee/five/five/index.d.ts:1906
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件

Type parameters
- K: VreoKeyframeEnum | "loaded" | "paused" | "playing" | "unknownKeyframeType" | "ended"
  
  预设的监听事件名称
Parameters
- Optional name: K
  
  事件类型
- Optional callback: (...args: Parameters<VreoKeyframeEvent[K]>) => ReturnType<VreoKeyframeEvent[K]>
  
  事件回调函数
  - - (...args: Parameters<VreoKeyframeEvent[K]>): ReturnType<VreoKeyframeEvent[K]>
    - Parameters
      - Rest ...args: Parameters<VreoKeyframeEvent[K]>
      Returns ReturnType<VreoKeyframeEvent[K]>
Returns void

on

on<K>(name: K, callback: (...args: Parameters<VreoKeyframeEvent[K]>) => ReturnType<VreoKeyframeEvent[K]>, once?: boolean): () => void

Inherited from Subscribe.on
- Defined in node_modules/@realsee/five/five/index.d.ts:1887
注册事件

Type parameters
- K: VreoKeyframeEnum | "loaded" | "paused" | "playing" | "unknownKeyframeType" | "ended"
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<VreoKeyframeEvent[K]>) => ReturnType<VreoKeyframeEvent[K]>
  
  事件回调函数
  - - (...args: Parameters<VreoKeyframeEvent[K]>): ReturnType<VreoKeyframeEvent[K]>
    - Parameters
      - Rest ...args: Parameters<VreoKeyframeEvent[K]>
      Returns ReturnType<VreoKeyframeEvent[K]>
- Optional once: boolean
  
  是否只执行一次
Returns () => void
解除事件
- - (): void
  - 注册事件
    
    Returns void
    解除事件

once

once<K>(name: K, callback: (...args: Parameters<VreoKeyframeEvent[K]>) => ReturnType<VreoKeyframeEvent[K]>): () => void

Inherited from Subscribe.once
- Defined in node_modules/@realsee/five/five/index.d.ts:1896
注册事件(是否只执行一次)

Type parameters
- K: VreoKeyframeEnum | "loaded" | "paused" | "playing" | "unknownKeyframeType" | "ended"
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<VreoKeyframeEvent[K]>) => ReturnType<VreoKeyframeEvent[K]>
  
  事件回调函数
  - - (...args: Parameters<VreoKeyframeEvent[K]>): ReturnType<VreoKeyframeEvent[K]>
    - Parameters
      - Rest ...args: Parameters<VreoKeyframeEvent[K]>
      Returns ReturnType<VreoKeyframeEvent[K]>
Returns () => void
解除事件
- - (): void
  - 注册事件(是否只执行一次)
    
    Returns void
    解除事件

pause

pause(): void

- Defined in resources/Player/index.tsx:182
Returns void

play

play(currentTime?: number): boolean

- Defined in resources/Player/index.tsx:171
Parameters
- Optional currentTime: number
Returns boolean

show

show(): void

- Defined in resources/Player/index.tsx:186
Returns void