forked from muxinc/elements
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypes.ts
More file actions
154 lines (145 loc) · 5.43 KB
/
types.ts
File metadata and controls
154 lines (145 loc) · 5.43 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
import type { CSSProperties } from 'react';
import type {
StreamTypes,
PlaybackTypes,
CmcdTypes,
MaxResolutionValue,
MinResolutionValue,
RenditionOrderValue,
} from '@mux/playback-core';
import type MuxPlayerElement from '@mux/mux-player';
import type { Tokens, EventMap as MuxPlayerElementEventMap } from '@mux/mux-player';
/**
* CSS properties interface for Mux components
* Extends standard CSSProperties to include custom CSS variables
*/
export interface MuxCSSProperties extends CSSProperties {
[key: `--${string}`]: string | undefined;
}
// Alias for backward compatibility
export type MuxPlayerCSSProperties = MuxCSSProperties;
type ValueOf<T> = T[keyof T];
export interface GenericEventListener<T extends Event = CustomEvent> {
(evt: T): void;
}
export type MuxPlayerRefAttributes = MuxPlayerElement;
type VideoApiAttributes = {
currentTime: number;
volume: number;
paused: boolean;
src: string | null;
poster: string;
playbackRate: number;
playsInline: boolean;
preload: string;
crossOrigin: string;
autoPlay: boolean | string;
loop: boolean;
muted: boolean;
style: MuxPlayerCSSProperties;
};
type MuxMediaPropTypes = {
audio: boolean;
// envKey: Options["data"]["env_key"];
envKey: string;
// debug: Options["debug"] & Hls["config"]["debug"];
debug: boolean;
disableTracking: boolean;
disableCookies: boolean;
disablePictureInPicture?: boolean;
disablePseudoEnded?: boolean;
// metadata: Partial<Options["data"]>;
metadata: { [k: string]: any };
extraSourceParams: Record<string, any>;
_hlsConfig: MuxPlayerElement['_hlsConfig'];
beaconCollectionDomain: string;
customDomain: string;
playbackId: string;
preferPlayback: ValueOf<PlaybackTypes> | undefined;
// NOTE: Explicitly adding deprecated values here for now to avoid fully breaking changes in TS envs (CJP)
streamType: ValueOf<StreamTypes> | 'll-live' | 'live:dvr' | 'll-live:dvr';
defaultStreamType: ValueOf<StreamTypes>;
targetLiveWindow: number;
startTime: number;
storyboardSrc: string;
preferCmcd: ValueOf<CmcdTypes> | undefined;
children?: React.ReactNode;
};
export type Props = MuxPlayerProps;
export type MuxPlayerProps = {
className?: string;
hotkeys?: string;
nohotkeys?: boolean;
castReceiver?: string | undefined;
castCustomData?: Record<string, any> | undefined;
defaultHiddenCaptions?: boolean;
playerSoftwareVersion?: string;
playerSoftwareName?: string;
playerInitTime?: number;
forwardSeekOffset?: number;
backwardSeekOffset?: number;
maxResolution?: MaxResolutionValue;
minResolution?: MinResolutionValue;
renditionOrder?: RenditionOrderValue;
programStartTime?: number;
programEndTime?: number;
proudlyDisplayMuxBadge?: boolean;
/** Allow playback with ad blocker */
allowAdBlocker?: boolean;
adTagUrl?: string;
assetStartTime?: number;
assetEndTime?: number;
metadataVideoId?: string;
metadataVideoTitle?: string;
metadataViewerUserId?: string;
primaryColor?: string;
secondaryColor?: string;
accentColor?: string;
placeholder?: string;
playbackRates?: number[];
defaultShowRemainingTime?: boolean;
defaultDuration?: number;
noVolumePref?: boolean;
thumbnailTime?: number;
title?: string;
videoTitle?: string;
tokens?: Tokens;
theme?: string;
themeProps?: { [k: string]: any };
onAbort?: GenericEventListener<MuxPlayerElementEventMap['abort']>;
onCanPlay?: GenericEventListener<MuxPlayerElementEventMap['canplay']>;
onCanPlayThrough?: GenericEventListener<MuxPlayerElementEventMap['canplaythrough']>;
onEmptied?: GenericEventListener<MuxPlayerElementEventMap['emptied']>;
onLoadStart?: GenericEventListener<MuxPlayerElementEventMap['loadstart']>;
onLoadedData?: GenericEventListener<MuxPlayerElementEventMap['loadeddata']>;
onLoadedMetadata?: GenericEventListener<MuxPlayerElementEventMap['loadedmetadata']>;
onProgress?: GenericEventListener<MuxPlayerElementEventMap['progress']>;
onDurationChange?: GenericEventListener<MuxPlayerElementEventMap['durationchange']>;
onVolumeChange?: GenericEventListener<MuxPlayerElementEventMap['volumechange']>;
onRateChange?: GenericEventListener<MuxPlayerElementEventMap['ratechange']>;
onResize?: GenericEventListener<MuxPlayerElementEventMap['resize']>;
onWaiting?: GenericEventListener<MuxPlayerElementEventMap['waiting']>;
onPlay?: GenericEventListener<MuxPlayerElementEventMap['play']>;
onPlaying?: GenericEventListener<MuxPlayerElementEventMap['playing']>;
onTimeUpdate?: GenericEventListener<MuxPlayerElementEventMap['timeupdate']>;
onPause?: GenericEventListener<MuxPlayerElementEventMap['pause']>;
onSeeking?: GenericEventListener<MuxPlayerElementEventMap['seeking']>;
onSeeked?: GenericEventListener<MuxPlayerElementEventMap['seeked']>;
onStalled?: GenericEventListener<MuxPlayerElementEventMap['stalled']>;
onSuspend?: GenericEventListener<MuxPlayerElementEventMap['suspend']>;
onEnded?: GenericEventListener<MuxPlayerElementEventMap['ended']>;
onError?: GenericEventListener<MuxPlayerElementEventMap['error']>;
onCuePointChange?: GenericEventListener<MuxPlayerElementEventMap['cuepointchange']>;
onChapterChange?: GenericEventListener<MuxPlayerElementEventMap['chapterchange']>;
} & Partial<MuxMediaPropTypes> &
Partial<VideoApiAttributes>;
declare global {
namespace JSX {
interface IntrinsicElements {
'mux-player': React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> & {
style?: MuxCSSProperties;
[key: string]: any;
};
}
}
}