API flv.js

В данном документе используются определения, подобные TypeScript, для описания интерфейсов.

Интерфейсы

flv.js экспортирует все интерфейсы через объект flvjs, который доступен в глобальном контексте window.

Доступ к объекту flvjs также можно получить с помощью require или ES6 import.

Функции:

• 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;

Создаёт экземпляр проигрывателя в соответствии с полем type, указанным в mediaDataSource, с опциональным config.

MediaDataSource

Если поле segments существует, трансмьюксер будет рассматривать этот MediaDataSource как многочастный источник.

В многочастном режиме поля duration, filesize и url в структуре MediaDataSource будут игнорироваться.

MediaSegment

Config

flvjs.isSupported()

function isSupported(): boolean;

Возвращает true, если базовое воспроизведение работает в вашем браузере.

flvjs.getFeatureList()

function getFeatureList(): FeatureList;

Возвращает объект FeatureList, который содержит следующие детали:

FeatureList

flvjs.FlvPlayer

interface FlvPlayer extends Player {}

FLV-плеер, реализующий интерфейс Player. Может быть создан непосредственно с помощью оператора new.

flvjs.NativePlayer

interface NativePlayer extends Player {}

Оболочка проигрывателя для собственного проигрывателя браузера (HTMLVideoElement) без источника MediaSource, которая реализует интерфейс Player. Полезен для воспроизведения одночастных файлов MP4.

interface Player (абстрактный) Интерфейс 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; pause(): void; type: string; buffered: TimeRanges; duration: number; volume: number; muted: boolean; currentTime: number; mediaInfo: Object; statisticsInfo: Object; }

Интерфейс LoggingControl

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; }

События (Events)

Серия констант, которые можно использовать с Player.on() / Player.off(). Они требуют префикса flvjs.Events.

Типы ошибок (ErrorTypes)

Возможные ошибки, которые могут возникнуть во время воспроизведения. Они требуют префикса flvjs.ErrorTypes.

Детали ошибок (ErrorDetails)

Предоставляют более подробное объяснение сетевых и медиа ошибок. Они требуют префикса flvjs.ErrorDetails.