Skip to main content
Version: v7 Beta

Type Alias: VideoConfig

type VideoConfig = object;

Defined in: types/VideoConfig.ts:6

Properties​

bufferConfig?​

optional bufferConfig?: BufferConfig;

Defined in: types/VideoConfig.ts:28

The player buffer configuration.

drm?​

optional drm?: DrmParams;

Defined in: types/VideoConfig.ts:24

The DRM parameters to be used.

externalSubtitles?​

optional externalSubtitles?: ExternalSubtitle[];

Defined in: types/VideoConfig.ts:56

The external subtitles to be used.

Note​

on iOS, only WebVTT (.vtt) subtitles are supported (for HLS streams and MP4 files).

Note​

on iOS, label can be overridden by player and there is no way to get around it.

Example​

externalSubtitles: [
  {
    uri: 'https://example.com/subtitles_en.vtt',
    label: 'English',
    type: 'vtt',
    language: 'en'
  },
  {
    uri: 'https://example.com/subtitles_es.vtt',
    label: 'Español',
    type: 'vtt',
    language: 'es'
  }
]

headers?​

optional headers?: Record<string, string>;

Defined in: types/VideoConfig.ts:20

The headers to be sent with the request.

initializeOnCreation?​

optional initializeOnCreation?: boolean;

Defined in: types/VideoConfig.ts:63

when the player is created, this flag will determine if native player should be initialized immediately. If set to true, the player will be initialized as soon as player is created If set to false, the player will need be initialized manually later

Default​

true

metadata?​

optional metadata?: CustomVideoMetadata;

Defined in: types/VideoConfig.ts:33

The custom metadata to be associated with the video. This metadata can be used by the native player to show information about the video.

uri​

uri: VideoSource;

Defined in: types/VideoConfig.ts:16

The uri of the video.

Example​

uri: 'https://example.com/video.mp4'
// or
uri: require('./assets/video.mp4')
We are TheWidlarzGroupPremium support →