Class PlvPlayerCore

SDK接口操作全局对象

Hierarchy

  • PlvPlayerCore

Methods

on off removeAllListeners getSdkVersion getSdkErrorDescription setSdkLogFile setSdkLogLevel checkFileComplete setSdkHwdecEnable setSdkKeepLastFrame setSdkLocalRememberPlay setSdkRetryAttempts setSdkViewerInfo init release deleteLocalVideoFile createPlayer createDownloader

Methods

on

  • 观察事件,同一个事件可以在多处订阅.
    可以在初始化前调用

    See

    Type Parameters

    • K extends EventKey<PLVCoreEventParams>

    Parameters

    • eventName: K

      事件名

    • fn: EventReceiver<PLVCoreEventParams[K]>

      响应函数,事件参数根据事件类型不同

    Returns void

off

  • 取消观察事件.
    可以在初始化前调用

    See

    PLVEventType

    Type Parameters

    • K extends EventKey<PLVCoreEventParams>

    Parameters

    • eventName: K

      事件名

    • fn: EventReceiver<PLVCoreEventParams[K]>

      响应函数

    Returns void

removeAllListeners

  • 取消观察所有事件.
    可以在初始化前调用

    Returns void

getSdkVersion

  • 获取SDK版本
    可以在初始化前调用

    Returns

    版本号

    Returns string

getSdkErrorDescription

  • 获取SDK错误描述
    可以在初始化前调用

    Returns

    Parameters

    • code: number

    Returns string

setSdkLogFile

  • 设置日志文件路径-utf-8
    可以在初始化前调用

    Returns

    错误码

    Parameters

    • path: string

      日志文件路径

    Returns number

setSdkLogLevel

  • 设置日志等级-utf-8
    可以在初始化前调用

    See

    PLVLogLevel

    Returns

    错误码

    Parameters

    Returns number

checkFileComplete

  • 检查已下载视频文件完整性
    可以在初始化前调用

    Returns

    是否完整

    Parameters

    • vid: string

      视频VID

    • filePath: string

      文件路径-UTF-8

    • rate: PLVVideoRateType

      清晰度

    Returns boolean

setSdkHwdecEnable

  • 设置是否启用硬解码-VRM13下不建议开启,容易花屏,默认关
    可以在初始化前调用

    Returns

    错误码

    Parameters

    • enable: boolean

      是否启用

    Returns number

setSdkKeepLastFrame

  • 播放完成后,是否保留最后一帧画面.默认关
    可以在初始化前调用

    Returns

    错误码

    Parameters

    • enable: boolean

      是否保留

    Returns number

setSdkLocalRememberPlay

  • 是否开启本地进度记忆,默认开启
    可以在初始化前调用

    Returns

    错误码

    Parameters

    • enable: boolean

      是否开启

    Returns number

setSdkRetryAttempts

  • 设置下载的重试策略,每次重试间隔时间会递增,默认无限重试(-1)
    可以在初始化前调用

    Returns

    错误码

    Parameters

    • count: number

      下载的重试次数. 默认是无限重试.

    • minWaitTime: number

      重试间隔时间. 默认 500 ms.

    • maxWaitTime: number

      最大的重试间隔时间. 默认 25000 ms.

    Returns number

setSdkViewerInfo

  • 设置 qos 的信息追踪, 建议设置.VRM12/13播放时,必须设置
    可以在初始化前调用

    Returns

    错误码

    Parameters

    Returns number

init

release

  • 释放SDK.

    Description

    该释放函数会释放底层JS回调的引用，释放后对象无法再使用.
    如果需要重新使用,需要重新创建核心对象

    See

    PlvPlayerCore

    Returns void

deleteLocalVideoFile

  • 手动删除某个本地视频文件
    需要初始化后使用

    Returns

    错误码

    Parameters

    • vid: string

      视频VID

    • path: string

      本地文件路径

    • rate: PLVVideoRateType

      清晰度

    Returns number

createPlayer

  • 创建播放实例.
    播放实例可以不断更新配置使用,因此在播放新的视频时,建议复用实例而不是每次新建一个.
    需要初始化后使用

    Returns

    播放实例

    Returns PLVPlayer

createDownloader

Settings

Member Visibility

Theme

Generated using TypeDoc