Skip to content

API Reference

Props

PropTypeDefaultNotes
srcstringrequiredStream or file URL
titlestringundefinedOverlay title
posterstringundefinedPoster image
mode'live' | 'vod''vod'Playback mode
autoplaybooleantrueAutoplay hint
controlsbooleanfalseShow player controls
mutedbooleanfalseStart muted
loopbooleanfalseLoop playback
fit'contain' | 'cover' | 'fill''contain'Layout strategy
timeoutnumber10Load timeout in seconds
playbackRatesnumber[][0.5, 1, 1.5, 2]Rate menu
playbackRatenumber1Initial rate
resolutionstringundefinedLiveQing resolution label
assetBaseUrlstringinferredAsset host override
retryLivePlayerRetryOptions{ attempts: 0, delay: 1000, backoffMultiplier: 1 }Reserved retry config
lowLatencybooleanfalseReserved low-latency hint
debugbooleanfalseReserved debug hook

Exposed methods

ts
interface LivePlayerPublicInstance {
  play(): void;
  pause(): void;
  seek(time: number): void;
  snapshot(): void;
  setMuted(muted: boolean): void;
  setVolume(volume: number): void;
  enterFullscreen(): void;
  exitFullscreen(): void;
  toggleFullscreen(): void;
  getInternalPlayer(): LivePlayerInnerInstance | null;
}

Released under the MIT License.