flv.js API

本文檔使用類似TypeScript的定義來描述接口串慰。

接口

flv.js將所有接口都以flvjs對象暴露在全局上下文window中.

flvjs 還可以通過require或ES6導(dǎo)入來訪問對象祖今。

方法:

• flvjs.createPlayer()
• flvjs.isSupported()
• flvjs.getFeatureList()

類:

• flvjs.FlvPlayer
• flvjs.NativePlayer
• flvjs.LoggingControl

枚舉:

• flvjs.Events
• flvjs.ErrorTypes
• flvjs.ErrorDetails

flvjs.createPlayer()

function createPlayer(mediaDataSource: MediaDataSource, config?: Config): Player;

根據(jù)中指定的type字段創(chuàng)建一個播放器實例mediaDataSource（可選）config乌妒。

MediaDataSource

如果segments存在字段遣铝，則transmuxer會將其MediaDataSource視為多部分源外潜。

在多部分模式下玖媚，結(jié)構(gòu)中的duration filesize url字段MediaDataSource將被忽略精续。

MediaSegment

Config

flvjs.isSupported()

function isSupported(): boolean;

如果基本上可以再您的瀏覽器上播放則返回true

flvjs.getFeatureList()

function getFeatureList(): FeatureList;

返回FeatureList具有以下詳細(xì)信息的對象：

FeatureList

flvjs.FlvPlayer

interface FlvPlayer extends Player {}

實現(xiàn)Player接口的FLV播放器兽泄±旄牛可以通過new操作進(jìn)行創(chuàng)建

flvjs.NativePlayer

interface NativePlayer extends Player {}

Player wrapper for browser's native player (HTMLVideoElement) without MediaSource src, which implements the Player interface. Useful for singlepart MP4 file playback.

Player 接口 (抽象)

interface Player {
    constructor(mediaDataSource: MediaDataSource, config?: Config): Player;
    destroy(): void;
    on(event: string, listener: Function): void;
    off(event: string, listener: Function): void;
    attachMediaElement(mediaElement: HTMLMediaElement): void;
    detachMediaElement(): void;
    load(): void;
    unload(): void;
    play(): Promise<void>;
    pause(): void;
    type: string;
    buffered: TimeRanges;
    duration: number;
    volume: number;
    muted: boolean;
    currentTime: number;
    mediaInfo: Object;
    statisticsInfo: Object;
}

flvjs.LoggingControl

A global interface which include several static getter/setter to set flv.js logcat verbose level.
一個全局接口，其中包括幾個用于設(shè)置flv.js logcat詳細(xì)級別的靜態(tài)getter / setter病梢。

interface LoggingControl {
    forceGlobalTag: boolean;
    globalTag: string;
    enableAll: boolean;
    enableDebug: boolean;
    enableVerbose: boolean;
    enableInfo: boolean;
    enableWarn: boolean;
    enableError: boolean;
    getConfig(): Object;
    applyConfig(config: Object): void;
    addLogListener(listener: Function): void;
    removeLogListener(listener: Function): void;
}

flvjs.Events

一系列可以和 Player.on() / Player.off()一起使用的常數(shù). 它們需要前綴flvjs.Events.

flvjs.ErrorTypes

播放期間可能出現(xiàn)的錯誤飒责。它們需要前綴flvjs.ErrorTypes赘娄。

flvjs.ErrorDetails

針對網(wǎng)絡(luò)和媒體錯誤提供更詳細(xì)的說明宏蛉。它們需要前綴flvjs.ErrorDetails遣臼。