UNPKG

2.63 kBTypeScriptView Raw
1import { PlayerParams } from './lg-video-utils';
2export interface VideoSettings {
3 /**
4 * Enable/DIsable first video autoplay.
5 * @description Autoplay has to be managed using this setting.
6 * Autoplay in PlayerParams doesn't have any effect.
7 */
8 autoplayFirstVideo: boolean;
9 /**
10 * Change YouTube player parameters.
11 * You can find the list of YouTube player parameters from the following link
12 * <a href="https://developers.google.com/youtube/player_parameters">YouTube player parameters</a>
13 * @example
14 * lightGallery(document.getElementById('lightGallery'), {
15 * youTubePlayerParams: {
16 * modestbranding : 1,
17 * showinfo : 0,
18 * controls : 0
19 * }
20 * })
21 */
22 youTubePlayerParams: any;
23 /**
24 * Change Vimeo player parameters.
25 * You can find the list of vimeo player parameters from the following link
26 * <a href="https://developer.vimeo.com/player/embedding#universal-parameters">Vimeo player parameters</a>
27 * @example
28 * lightGallery(document.getElementById('lightGallery'), {
29 * vimeoPlayerParams: {
30 * byline : 0,
31 * portrait : 0,
32 * color : 'CCCCCC'
33 * }
34 * })
35 */
36 vimeoPlayerParams: PlayerParams;
37 /**
38 * Change Wistia player parameters.
39 * You can find the list of Wistia player parameters from the following link
40 * <a href="https://wistia.com/support/developers/embed-options#using-embed-options">Vimeo player parameters</a>
41 */
42 wistiaPlayerParams: any;
43 /**
44 * Go to next slide when video is ended
45 * Note - this doesn't work with YouTube videos at the moment
46 */
47 gotoNextSlideOnVideoEnd: boolean;
48 /**
49 * Autoplay video on slide change
50 * @description Make sure you set preload:"none"
51 */
52 autoplayVideoOnSlide: boolean;
53 /**
54 * Enbale videojs custom video player
55 * <div class="alert alert-info" role="alert">
56 * <b>Dependency</b> - You need to include <a href="https://videojs.com/">videoJs</a> on your document to enable videojs player
57 * </div>
58 */
59 videojs: boolean;
60 /**
61 * Class name of the videojs theme
62 * You need to include the theme stylesheet on your document. <a href="https://videojs.com/getting-started/#home-page-themes" target="_blank">More info</a>
63 * @version V2.5.0
64 */
65 videojsTheme: string;
66 /**
67 * Videojs player options
68 */
69 videojsOptions: any;
70}
71export declare const videoSettings: VideoSettings;