@instructure/studio-player 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Instructure, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# studio-player
+
+## Sources
+
+- `sources` renamed to `src`: can be an url or an array of objects with the following props:
+  - `src` `type` `width` `height`
+- instead of `label` you have to provide the `width` and `height`, this is important, because the player will be able to collect the qualities based on these.
+
+example:
+
+```js
+[
+  {
+    src: 'my-video1.mp4',
+    type: 'video/mp4',
+    width: 1920,
+    height: 1080,
+  },
+  {
+    src: 'my-video2.mp4',
+    type: 'video/mp4',
+    width: 1280,
+    height: 720,
+  },
+];
+```
+
+### Captions
+
+- `tracks` has been renamed to `captions`
+- `id` and `kind` is not used
+- `type` should be the subtitle format, `vtt` or `srt`
+
+example:
+
+```js
+[
+  {
+    src: 'my-captions-en.srt',
+    label: 'English',
+    language: 'en',
+    type: 'srt',
+  },
+  {
+    src: 'my-captions-es.srt',
+    label: 'Spanish',
+    language: 'es',
+    type: 'srt',
+  },
+];
+```
+
+### Deprecated props compared to old Media Player
+
+these props are no longer used and you can remove them from the code:
+
+- `onLoadedMetadata`
+- `captionPosition`
+- `autoShowCaption`

package/dist/StudioPlayer/StudioPlayer.d.ts

@@ -0,0 +1,10 @@
+import { MediaPlayerProps } from '@vidstack/react';
+import { CaptionMetaData } from '@/types';
+export type StudioPlayerProps = {
+    title: string;
+    src: MediaPlayerProps['src'];
+    captions?: CaptionMetaData[];
+    thumbnail?: string;
+    hideFullScreen?: boolean;
+};
+export declare function StudioPlayer({ title, src, captions, thumbnail, hideFullScreen, }: StudioPlayerProps): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/StudioPlayerContext.d.ts

@@ -0,0 +1,11 @@
+import { Dispatch, SetStateAction } from 'react';
+import { CAPTION_FONT_SIZE_MULTIPLIERS } from '@/constants';
+export type StudioPlayerState = {
+    captionsFontSizeMultiplier: (typeof CAPTION_FONT_SIZE_MULTIPLIERS)[number];
+};
+export type StudioPlayerContextType = {
+    hideFullScreen: boolean;
+    state: StudioPlayerState;
+    setState: Dispatch<SetStateAction<StudioPlayerState>>;
+};
+export declare const StudioPlayerContext: import('react').Context<StudioPlayerContextType | null>;

package/dist/StudioPlayer/components/BufferingIndicator/BufferingIndicator.d.ts

@@ -0,0 +1 @@
+export declare function BufferingIndicator(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/CaptionsButton/CaptionsButton.d.ts

@@ -0,0 +1 @@
+export declare function CaptionsButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CaptionsOverlay/CaptionsOverlay.d.ts

@@ -0,0 +1,5 @@
+import { CaptionMetaData } from '@/types';
+export type CaptionsOverlayProps = {
+    captions: CaptionMetaData[];
+};
+export declare function CaptionsOverlay({ captions }: CaptionsOverlayProps): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/ControlsLayout/ControlsLayout.d.ts

@@ -0,0 +1 @@
+export declare function ControlsLayout(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/CustomSettingsMenu/CustomSettingsMenu.d.ts

@@ -0,0 +1 @@
+export declare function CustomSettingsMenu(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/CustomSettingsMenu/CustomSettingsMenuContext.d.ts

@@ -0,0 +1,8 @@
+import { SettingsMenuState } from './useCustomSettingsMenu';
+export type CustomSettingsMenuContextType = {
+    setPage: (page: SettingsMenuState) => void;
+    backToMain: () => void;
+    backToCaptions: () => void;
+    toggle: () => void;
+};
+export declare const CustomSettingsMenuContext: import('react').Context<CustomSettingsMenuContextType | null>;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/CaptionsMenu/CaptionsFontSizeMenu.d.ts

@@ -0,0 +1 @@
+export declare function CaptionsFontSizeMenu(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/CaptionsMenu/CaptionsLanguageMenu.d.ts

@@ -0,0 +1 @@
+export declare function CaptionsLanguageMenu(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/CaptionsMenu/CaptionsMenu.d.ts

@@ -0,0 +1 @@
+export declare function CaptionsMenu(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/MainMenu/MainMenu.d.ts

@@ -0,0 +1 @@
+export declare function MainMenu(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/QualityMenu/QualityMenu.d.ts

@@ -0,0 +1 @@
+export declare function QualityMenu(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/SpeedMenu/SpeedMenu.d.ts

@@ -0,0 +1 @@
+export declare function SpeedMenu(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/buttons/BaseButton.d.ts

@@ -0,0 +1,8 @@
+type BaseButtonProps = {
+    label: string;
+    hint: string;
+    onClick: () => void;
+    Icon?: (props: React.SVGProps<SVGSVGElement>) => React.ReactElement;
+};
+export declare function BaseButton({ label, hint, onClick, Icon }: BaseButtonProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/buttons/CaptionsButton.d.ts

@@ -0,0 +1 @@
+export declare function CaptionsButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/buttons/CaptionsFontSizeButton.d.ts

@@ -0,0 +1 @@
+export declare function CaptionsFontSizeButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/buttons/CaptionsLanguageButton.d.ts

@@ -0,0 +1 @@
+export declare function CaptionsLanguageButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/buttons/QualityButton.d.ts

@@ -0,0 +1 @@
+export declare function QualityButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/menus/buttons/SpeedButton.d.ts

@@ -0,0 +1 @@
+export declare function SpeedButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/CustomSettingsMenu/useCallbackOnEsc.d.ts

@@ -0,0 +1 @@
+export declare function useCallbackOnEsc(callback?: () => void): void;

package/dist/StudioPlayer/components/CustomSettingsMenu/useCustomSettingsMenu.d.ts

@@ -0,0 +1,18 @@
+import { useFloating, useInteractions } from '@floating-ui/react';
+export type SettingsMenuState = 'main' | 'speed' | 'captions' | 'captionLanguage' | 'captionFontSize' | 'quality';
+type useCustomSettingsMenuReturnType = {
+    Page: React.FunctionComponent;
+    open: boolean;
+    toggle: () => void;
+    setPage: (page: SettingsMenuState) => void;
+    backToCaptions: () => void;
+    backToMain: () => void;
+    arrowRef: React.LegacyRef<SVGSVGElement> | undefined;
+    refs: ReturnType<typeof useFloating>['refs'];
+    floatingStyles: ReturnType<typeof useFloating>['floatingStyles'];
+    context: ReturnType<typeof useFloating>['context'];
+    getReferenceProps: ReturnType<typeof useInteractions>['getReferenceProps'];
+    getFloatingProps: ReturnType<typeof useInteractions>['getFloatingProps'];
+};
+export declare function useCustomSettingsMenu(): useCustomSettingsMenuReturnType;
+export {};

package/dist/StudioPlayer/components/FeedbackOverlay/FeedbackIcon.d.ts

@@ -0,0 +1 @@
+export declare function FeedbackIcon(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/FeedbackOverlay/FeedbackMessage.d.ts

@@ -0,0 +1 @@
+export declare function FeedbackMessage(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/FeedbackOverlay/FeedbackOverlay.d.ts

@@ -0,0 +1 @@
+export declare function FeedbackOverlay(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/FeedbackOverlay/createFeedbackComponent.d.ts

@@ -0,0 +1 @@
+export declare function createFeedbackComponent(Component: React.FunctionComponent, timeout?: number): () => import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/FullscreenButton/FullscreenButton.d.ts

@@ -0,0 +1 @@
+export declare function FullscreenButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/GesturesContainer/GesturesContainer.d.ts

@@ -0,0 +1 @@
+export declare function GesturesContainer(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/PlayPauseButton/PlayPauseButton.d.ts

@@ -0,0 +1 @@
+export declare function PlayPauseButton(): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/PosterContainer/PosterContainer.d.ts

@@ -0,0 +1,4 @@
+export type PosterContainerProps = {
+    src?: string | null;
+};
+export declare function PosterContainer({ src }: PosterContainerProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/StudioPlayer/components/SmallLayoutOverlay/SmallLayoutOverlay.d.ts

@@ -0,0 +1 @@
+export declare function SmallLayoutOverlay(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/TimeIndicator/TimeIndicator.d.ts

@@ -0,0 +1 @@
+export declare function TimeIndicator(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/TimeLine/TimeLine.d.ts

@@ -0,0 +1,4 @@
+export type TimeLineProps = {
+    className?: string;
+};
+export declare function TimeLine({ className }: TimeLineProps): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/VolumeMenu/VolumeMenu.d.ts

@@ -0,0 +1 @@
+export declare function VolumeMenu(): import("react/jsx-runtime").JSX.Element;

package/dist/StudioPlayer/components/index.d.ts

@@ -0,0 +1,14 @@
+export * from './BufferingIndicator/BufferingIndicator';
+export * from './CaptionsButton/CaptionsButton';
+export * from './CaptionsOverlay/CaptionsOverlay';
+export * from './ControlsLayout/ControlsLayout';
+export * from './CustomSettingsMenu/CustomSettingsMenu';
+export * from './FeedbackOverlay/FeedbackOverlay';
+export * from './FullscreenButton/FullscreenButton';
+export * from './GesturesContainer/GesturesContainer';
+export * from './PlayPauseButton/PlayPauseButton';
+export * from './PosterContainer/PosterContainer';
+export * from './SmallLayoutOverlay/SmallLayoutOverlay';
+export * from './TimeIndicator/TimeIndicator';
+export * from './TimeLine/TimeLine';
+export * from './VolumeMenu/VolumeMenu';

package/dist/StudioPlayer/shortcuts.d.ts

@@ -0,0 +1,2 @@
+import { MediaKeyShortcuts } from '@vidstack/react';
+export declare const keyShortcuts: MediaKeyShortcuts;

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const PLAYBACK_RATES: number[];
+export declare const CAPTION_FONT_SIZE_MULTIPLIERS: {
+    label: string;
+    value: number;
+}[];

package/dist/errors-DCJKAXTz.js

@@ -0,0 +1,70 @@
+import { P as a, c as t } from "./prod-DTLJXtPo.js";
+const i = {
+  r() {
+    return new a({
+      code: t.BadSignature,
+      reason: "missing WEBVTT file header",
+      line: 1
+    });
+  },
+  s(n, e) {
+    return new a({
+      code: t.BadTimestamp,
+      reason: `cue start timestamp \`${n}\` is invalid on line ${e}`,
+      line: e
+    });
+  },
+  t(n, e) {
+    return new a({
+      code: t.BadTimestamp,
+      reason: `cue end timestamp \`${n}\` is invalid on line ${e}`,
+      line: e
+    });
+  },
+  u(n, e, r) {
+    return new a({
+      code: t.BadTimestamp,
+      reason: `cue end timestamp \`${e}\` is greater than start \`${n}\` on line ${r}`,
+      line: r
+    });
+  },
+  y(n, e, r) {
+    return new a({
+      code: t.BadSettingValue,
+      reason: `invalid value for cue setting \`${n}\` on line ${r} (value: ${e})`,
+      line: r
+    });
+  },
+  x(n, e, r) {
+    return new a({
+      code: t.UnknownSetting,
+      reason: `unknown cue setting \`${n}\` on line ${r} (value: ${e})`,
+      line: r
+    });
+  },
+  w(n, e, r) {
+    return new a({
+      code: t.BadSettingValue,
+      reason: `invalid value for region setting \`${n}\` on line ${r} (value: ${e})`,
+      line: r
+    });
+  },
+  v(n, e, r) {
+    return new a({
+      code: t.UnknownSetting,
+      reason: `unknown region setting \`${n}\` on line ${r} (value: ${e})`,
+      line: r
+    });
+  },
+  // SSA-specific errors
+  T(n, e) {
+    return new a({
+      code: t.BadFormat,
+      reason: `format missing for \`${n}\` block on line ${e}`,
+      line: e
+    });
+  }
+};
+export {
+  i as ParseErrorBuilder
+};