Home > hls.js > Hls > createImageIFramePlayer

Hls.createImageIFramePlayer() method

Returns an new image iframe focused Hls (HlsImageIFramesOnly) instance based on iframeVariants found in the current asset, or null when no image variants are available. An image iframe instance uses iframe variants with image codec values in CODECS ("mjpg") as its levels. Use HlsIFramesOnly.loadMediaAt(time) to load image IFrames. Attach an HTMLImageElement with HlsImageIFramesOnly.attachImage(image), or process image data on FRAG_LOADED.

Signature:

createImageIFramePlayer(configOverride?: Partial<HlsConfig>): HlsImageIFramesOnly | null;

Parameters

Returns:

HlsImageIFramesOnly | null