Class PLVPlayer

播放器接口

Export

Hierarchy

PLVPlayer

Methods

id

id(): null | number
获取播放器ID

Returns
播放器ID

Returns null | number

destroy

destroy(): void
释放播放器实例,释放后不能再使用该对象
建议复用播放器实例,不断更新配置使用.

Returns void

setConfig

setConfig(config: PLVPlayerConfig): void
设置播放器配置
Parameters
- config: PLVPlayerConfig
  
  播放器配置.根据播放场景,可仅配置必要选项.
Returns void

bind

bind(containerId: string): void
绑定视频渲染DIV容器
Parameters
- containerId: string
  
  HTML-DIV容器ID
Returns void

unbind

unbind(): void
解绑视频渲染DIV容器

Returns void

setOSDConfig

setOSDConfig(enable: boolean, config?: PLVOSDConfig): void
设置OSD跑马灯配置
Parameters
- enable: boolean
  
  是否开启
- Optional config: PLVOSDConfig
  
  跑马灯配置,启用时必填
Returns void

getOSDConfig

getOSDConfig(): null | PLVOSDConfig
获取当前OSD跑马灯配置

Returns
跑马灯配置

Returns null | PLVOSDConfig

setLogoConfig

setLogoConfig(enable: boolean, config?: PLVLogoConfig): void
设置LOGO
Parameters
- enable: boolean
  
  是否开启
- Optional config: PLVLogoConfig
  
  LOGO配置,启用时必填
Returns void

getLogoConfig

getLogoConfig(): null | PLVLogoConfig
获取LOGO配置

Returns
LOGO配置

Returns null | PLVLogoConfig

setCacheConfig

setCacheConfig(enable: boolean, cacheConfig?: PLVCacheConfig): void
设置缓存配置,一般默认即可,无需设置.
Parameters
- enable: boolean
  
  是否启用自定义缓存
- Optional cacheConfig: PLVCacheConfig
  
  缓存配置,启用时必填
Returns void

getCacheConfig

getCacheConfig(): null | PLVCacheConfig
获取缓存配置

Returns
缓存配置

Returns null | PLVCacheConfig

play

play(): void
开始播放

Returns void

stop

stop(): void
停止播放

Returns void

pause

pause(): void
暂停

Returns void

resume

resume(): void
继续

Returns void

mute

mute(status: boolean): void
静音
Parameters
- status: boolean
  
  是否静音
Returns void

seek

seek(time: number): void
定位
Parameters
- time: number
  
  播放进度ms
Returns void

seekToEnd

seekToEnd(): void
定位到最后

Returns void

setVolume

setVolume(volume: number): void
设置音量
Parameters
- volume: number
  
  音量值,[0,100]
Returns void

setVolumeMax

setVolumeMax(volume: number): void
设置音量增益,有失真的风险
Parameters
- volume: number
  
  音量增益,[100,1000]
Returns void

screenshot

screenshot(filepath: string): void
异步抓图到文件,PNG/JPG
Parameters
- filepath: string
  
  文件路径-utf-8
Returns void

setSpeed

setSpeed(speed: number): void
设置播放速度
Parameters
- speed: number
  
  速度
Returns void

isMute

isMute(): boolean
是否静音

Returns
是否静音

Returns boolean

isValid

isValid(): boolean
播放器与播放配置是否可用.仅检查vid信息

Returns
是否可用

Returns boolean

isPause

isPause(): boolean
是否处于暂停状态

Returns
是否暂停

Returns boolean

isPlaying

isPlaying(): boolean
是否处于播放状态

Returns
是否播放中

Returns boolean

isLoaded

isLoaded(): boolean
视频是否已加载

Returns
是否已加载

Returns boolean

isLoading

isLoading(): boolean
视频是否处于加载中

Returns
是否加载中

Returns boolean

getCurrentRateCount

getCurrentRateCount(): number
视频当前清晰度数量

Returns
清晰度数量

Returns number

getCurrentRate

getCurrentRate(): PLVVideoRateType
获取当前清晰度

Returns
当前清晰度

Returns PLVVideoRateType

getVolume

getVolume(): number
获取当前音量

Returns
音量

Returns number

getDuration

getDuration(): number
获取当前视频时长ms

Returns
时长

Returns number

getSpeed

getSpeed(): number
获取当前视频播放速度

Returns
播放速度

Returns number

getAudioDeviceCount

getAudioDeviceCount(): number
获取当前音频播放设备数量

Returns
设备数量

Returns number

getAudioDeviceInfo

getAudioDeviceInfo(index: number): null | PLVAudioDeviceInfo
获取音频设备信息

Returns
设备信息
Parameters
- index: number
  
  设备索引
Returns null | PLVAudioDeviceInfo

getCurrentAudioDevice

getCurrentAudioDevice(): string
获取当前设备ID

Returns
设备ID

Returns string

setCurrentAudioDevice

setCurrentAudioDevice(deviceId: string): void
设置当前设备
Parameters
- deviceId: string
  
  设备ID
Returns void

Generated using TypeDoc