react-native-theoplayer 1.8.2 → 2.0.0

package/lib/typescript/ui/components/button/MuteButton.d.ts

@@ -0,0 +1,16 @@
+import { PureComponent } from 'react';
+interface MuteButtonState {
+    muted: boolean;
+}
+/**
+ * The default mute button for the `react-native-theoplayer` UI.
+ */
+export declare class MuteButton extends PureComponent<unknown, MuteButtonState> {
+    constructor(props: unknown);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private onVolumeChange;
+    private toggleMuted;
+    render(): JSX.Element;
+}
+export {};

package/lib/typescript/ui/components/button/PipButton.d.ts

@@ -0,0 +1,17 @@
+import { PureComponent } from 'react';
+import { PresentationMode } from 'react-native-theoplayer';
+interface PipButtonState {
+    presentationMode: PresentationMode;
+}
+/**
+ * The default button to enable picture-in-picture for the `react-native-theoplayer` UI.
+ */
+export declare class PipButton extends PureComponent<unknown, PipButtonState> {
+    constructor(props: unknown);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private readonly onPresentationModeChange;
+    private togglePip;
+    render(): JSX.Element;
+}
+export {};

package/lib/typescript/ui/components/button/PlayButton.d.ts

@@ -0,0 +1,28 @@
+import type { StyleProp, ViewStyle } from 'react-native';
+import { PureComponent } from 'react';
+interface PlayButtonProps {
+    /**
+     * The style overrides for the play/pause button.
+     */
+    style?: StyleProp<ViewStyle>;
+}
+interface PlayButtonState {
+    paused: boolean;
+    ended: boolean;
+}
+/**
+ * The default play/pause button for the `react-native-theoplayer` UI.
+ */
+export declare class PlayButton extends PureComponent<PlayButtonProps, PlayButtonState> {
+    constructor(props: PlayButtonProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private onPlay;
+    private onPause;
+    private onSourceChange;
+    private onEnded;
+    private onSeeking;
+    private togglePlayPause;
+    render(): JSX.Element;
+}
+export {};

package/lib/typescript/ui/components/button/SkipButton.d.ts

@@ -0,0 +1,33 @@
+import { PureComponent } from 'react';
+import type { StyleProp, ViewStyle } from 'react-native';
+import { Animated } from 'react-native';
+interface SkipButtonProps {
+    /**
+     * The style overrides for the skip button.
+     */
+    style?: StyleProp<ViewStyle>;
+    /**
+     * The skip value for the skip button. This can be set to negative to skip backwards.
+     */
+    skip: number;
+    /**
+     * Whether the skip button should do a rotation animation when pressed instead of fading.
+     */
+    rotate?: boolean;
+}
+interface SkipButtonState {
+    enabled: boolean;
+    spinValue: Animated.Value;
+}
+/**
+ * The default skip button for the `react-native-theoplayer` UI.
+ */
+export declare class SkipButton extends PureComponent<SkipButtonProps, SkipButtonState> {
+    constructor(props: SkipButtonProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private readonly onTimeupdate;
+    private readonly onPress;
+    render(): JSX.Element;
+}
+export {};

package/lib/typescript/ui/components/button/actionbutton/ActionButton.d.ts

@@ -0,0 +1,41 @@
+import { ImageSourcePropType, StyleProp, ViewStyle } from 'react-native';
+import { ReactNode } from 'react';
+export interface ActionButtonProps {
+    /**
+     * The image to put in the button.
+     */
+    icon?: ImageSourcePropType;
+    /**
+     * The SVG component to put in the button. Takes priority over images.
+     */
+    svg?: ReactNode;
+    /**
+     * Whether the button should be touchable. This is `true` by default.
+     */
+    touchable: boolean;
+    /**
+     * The callback when the button is pressed.
+     */
+    onPress?: () => void;
+    /**
+     * The styling overrides.
+     */
+    style?: StyleProp<ViewStyle>;
+    /**
+     * Whether the button should be highlighted with `ColorTheme.iconSelected` color.
+     */
+    highlighted?: boolean;
+}
+/**
+ * The default style applied to the ActionButton
+ */
+export declare const DEFAULT_ACTION_BUTTON_STYLE: ViewStyle;
+/**
+ * The default button component that renders an image/svg source for the `react-native-theoplayer` UI.
+ */
+export declare const ActionButton: {
+    (props: ActionButtonProps): JSX.Element;
+    defaultProps: {
+        touchable: boolean;
+    };
+};

package/lib/typescript/ui/components/button/barrel.d.ts

@@ -0,0 +1,9 @@
+export * from './actionbutton/ActionButton';
+export * from './svg/barrel';
+export * from './AirplayButton';
+export * from './ChromecastButton';
+export * from './FullscreenButton';
+export * from './MuteButton';
+export * from './PipButton';
+export * from './PlayButton';
+export * from './SkipButton';

package/lib/typescript/ui/components/button/svg/AirplaySvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const AirplaySvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/ArrowForwardSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const ArrowForwardSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/BackSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const BackSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/BackwardSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const BackwardSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/ChromecastSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const ChromecastSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/ErrorSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const ErrorSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/ForwardSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const ForwardSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/FullscreenEnterSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const FullscreenEnterSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/FullscreenExitSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const FullscreenExitSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/LanguageSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const LanguageSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/ListSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const ListSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/PauseSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const PauseSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/PipEnterSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const PipEnterSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/PipExitSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const PipExitSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/PlaySvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const PlaySvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/ReplaySvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const ReplaySvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/SettingsSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const SettingsSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/SvgUtils.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { SvgProps } from 'react-native-svg';
+export declare const SvgContext: React.Context<SvgProps>;

package/lib/typescript/ui/components/button/svg/VolumeOffSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const VolumeOffSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/VolumeUpSvg.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { SvgProps } from 'react-native-svg';
+export declare const VolumeUpSvg: (props: SvgProps) => JSX.Element;

package/lib/typescript/ui/components/button/svg/barrel.d.ts

@@ -0,0 +1,20 @@
+export * from './AirplaySvg';
+export * from './ArrowForwardSvg';
+export * from './BackSvg';
+export * from './BackwardSvg';
+export * from './ChromecastSvg';
+export * from './ErrorSvg';
+export * from './ForwardSvg';
+export * from './FullscreenEnterSvg';
+export * from './FullscreenExitSvg';
+export * from './LanguageSvg';
+export * from './ListSvg';
+export * from './PauseSvg';
+export * from './PipEnterSvg';
+export * from './PipExitSvg';
+export * from './PlaySvg';
+export * from './ReplaySvg';
+export * from './SettingsSvg';
+export * from './SvgUtils';
+export * from './VolumeOffSvg';
+export * from './VolumeUpSvg';

package/lib/typescript/ui/components/controlbar/ControlBar.d.ts

@@ -0,0 +1,39 @@
+import React, { ReactNode } from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+/**
+ * The default style for the control bar.
+ */
+export declare const DEFAULT_CONTROL_BAR_STYLE: ViewStyle;
+interface ControlBarProps {
+    /**
+     * The style overrides for the control bar.
+     */
+    style?: StyleProp<ViewStyle>;
+}
+/**
+ * A control bar component that renders all children horizontally.
+ */
+export declare const ControlBar: (props: React.PropsWithChildren<ControlBarProps>) => JSX.Element;
+interface CenteredControlBarProps {
+    /**
+     * The style overrides for the control bar.
+     */
+    style?: StyleProp<ViewStyle>;
+    /**
+     * The component that will be placed in the left slot.
+     */
+    left?: ReactNode;
+    /**
+     * The component that will be placed in the middle slot.
+     */
+    middle?: ReactNode;
+    /**
+     * The component that will be placed in the right slot.
+     */
+    right?: ReactNode;
+}
+/**
+ * A control bar that can only render 3 properties in the left/middle/right. This is used to create controls in the center of the player.
+ */
+export declare const CenteredControlBar: (props: CenteredControlBarProps) => JSX.Element;
+export {};

package/lib/typescript/ui/components/controlbar/Spacer.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+/**
+ * A spacer that can be used with the control bar to space out components left and right.
+ */
+export declare const Spacer: () => JSX.Element;

package/lib/typescript/ui/components/controlbar/barrel.d.ts

@@ -0,0 +1,2 @@
+export * from './ControlBar';
+export * from './Spacer';

package/lib/typescript/ui/components/menu/LanguageMenuButton.d.ts

@@ -0,0 +1,40 @@
+import { PureComponent } from 'react';
+import type { MediaTrack } from 'react-native-theoplayer';
+import { TextTrack } from 'react-native-theoplayer';
+import type { StyleProp, ViewStyle } from 'react-native';
+export interface LanguageMenuButtonState {
+    audioTracks: MediaTrack[];
+    textTracks: TextTrack[];
+}
+export interface LanguageMenuButtonProps {
+    /**
+     * The style overrides.
+     */
+    menuStyle?: StyleProp<ViewStyle>;
+}
+/**
+ * A button component that opens a language selection menu (audio/text) for the `react-native-theoplayer` UI.
+ */
+export declare class LanguageMenuButton extends PureComponent<LanguageMenuButtonProps, LanguageMenuButtonState> {
+    constructor(props: LanguageMenuButtonProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _updateTrackLists;
+    render(): JSX.Element;
+}
+export interface LanguageMenuViewState extends LanguageMenuButtonState {
+    selectedAudioTrack: number | undefined;
+    selectedTextTrack: number | undefined;
+}
+export interface LanguageMenuViewProps {
+    style?: StyleProp<ViewStyle>;
+}
+export declare class LanguageMenuView extends PureComponent<LanguageMenuViewProps, LanguageMenuViewState> {
+    constructor(props: LanguageMenuViewProps);
+    private _updateTrackLists;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private onSelectTextTrack;
+    private selectAudioTrack;
+    render(): JSX.Element;
+}

package/lib/typescript/ui/components/menu/PlaybackRateSubMenu.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="react" />
+import type { StyleProp, ViewStyle } from 'react-native';
+export interface PlaybackRateValue {
+    /**
+     * The playbackRate value.
+     */
+    readonly value: number;
+    /**
+     * The label of the playbackRate value.
+     */
+    readonly label: string;
+}
+/**
+ * The default playback rate values for the menu.
+ */
+export declare const DEFAULT_PLAYBACK_RATE_MENU_VALUES: PlaybackRateValue[];
+interface PlaybackRateSubMenuProps {
+    /**
+     * Overrides for the default playbackRate values.
+     */
+    values?: PlaybackRateValue[];
+    /**
+     * Overrides for the style of the menu.
+     */
+    menuStyle?: StyleProp<ViewStyle>;
+}
+/**
+ * A button component that opens a playbackRate selection menu for the `react-native-theoplayer` UI.
+ */
+export declare const PlaybackRateSubMenu: (props: PlaybackRateSubMenuProps) => JSX.Element;
+interface PlaybackSelectionViewProps {
+    menuStyle?: StyleProp<ViewStyle>;
+    values: PlaybackRateValue[];
+}
+export declare const PlaybackSelectionView: (props: PlaybackSelectionViewProps) => JSX.Element;
+export {};

package/lib/typescript/ui/components/menu/QualitySubMenu.d.ts

@@ -0,0 +1,29 @@
+import { MediaTrack } from 'react-native-theoplayer';
+import { PureComponent } from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+export interface QualitySubMenuProps {
+    /**
+     * Overrides for the style of the menu.
+     */
+    menuStyle?: StyleProp<ViewStyle>;
+}
+/**
+ * A button component that opens a playbackRate selection menu for the `react-native-theoplayer` UI.
+ */
+export declare const QualitySubMenu: (props: QualitySubMenuProps) => JSX.Element;
+export interface QualitySelectionViewState {
+    videoTracks: MediaTrack[];
+    selectedVideoTrack: number | undefined;
+    targetVideoTrackQuality: number | number[] | undefined;
+}
+export interface QualitySelectionViewProps {
+    style?: StyleProp<ViewStyle>;
+}
+export declare class QualitySelectionView extends PureComponent<QualitySelectionViewProps, QualitySelectionViewState> {
+    constructor(props: QualitySelectionViewProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private onTrackListChanged;
+    private selectTargetVideoQuality;
+    render(): JSX.Element;
+}

package/lib/typescript/ui/components/menu/SettingsMenuButton.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import type { StyleProp, ViewStyle } from 'react-native';
+export interface SettingsMenuButtonProps {
+    /**
+     * Overrides for the style of the menu.
+     */
+    menuStyle?: StyleProp<ViewStyle>;
+}
+/**
+ * A button component that opens a settings menu containing all children for the `react-native-theoplayer` UI.
+ */
+export declare const SettingsMenuButton: (props: React.PropsWithChildren<SettingsMenuButtonProps>) => JSX.Element;

package/lib/typescript/ui/components/menu/barrel.d.ts

@@ -0,0 +1,5 @@
+export * from './common/barrel';
+export * from './LanguageMenuButton';
+export * from './PlaybackRateSubMenu';
+export * from './QualitySubMenu';
+export * from './SettingsMenuButton';

package/lib/typescript/ui/components/menu/common/MenuButton.d.ts

@@ -0,0 +1,25 @@
+import type { ImageSourcePropType, StyleProp, ViewStyle } from 'react-native';
+import { ReactNode } from 'react';
+import type { MenuConstructor } from '../../uicontroller/UiControls';
+export interface MenuButtonProps {
+    /**
+     * The image that will be used in the button.
+     */
+    icon?: ImageSourcePropType;
+    /**
+     * The SVG that will be used in the button. Takes priority over images.
+     */
+    svg?: ReactNode;
+    /**
+     * The style overrides for the menu button.
+     */
+    style?: StyleProp<ViewStyle>;
+    /**
+     * The menu that will be constructed when the button is pressed.
+     */
+    menuConstructor?: MenuConstructor;
+}
+/**
+ * A menu button that opens a fullscreen menu for in the `react-native-theoplayer` UI.
+ */
+export declare const MenuButton: (props: MenuButtonProps) => JSX.Element;

package/lib/typescript/ui/components/menu/common/MenuRadioButton.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+import { StyleProp, TextStyle } from 'react-native';
+export interface MenuRadioButtonProps {
+    /**
+     * The label for the button.
+     */
+    label: string;
+    /**
+     * The uid used in the callback when the button is pressed.
+     */
+    uid: number | undefined;
+    /**
+     * Whether the radio button is selected.
+     */
+    selected?: boolean;
+    /**
+     * The callback that is called when the button is pressed.
+     * @param id The uid prop.
+     */
+    onSelect: (id: number | undefined) => void;
+    /**
+     * The style overrides for the radio button.
+     */
+    style?: StyleProp<TextStyle>;
+}
+/**
+ * The default style for the menu button.
+ */
+export declare const DEFAULT_MENU_BUTTON_STYLE: TextStyle;
+/**
+ * The default radio button that can be used in menus for the `react-native-theoplayer` UI.
+ */
+export declare const MenuRadioButton: (props: MenuRadioButtonProps) => JSX.Element;

package/lib/typescript/ui/components/menu/common/MenuTitle.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { StyleProp, TextStyle } from 'react-native';
+export interface MenuTitleProps {
+    /**
+     * The label of the menu title component.
+     */
+    label: string;
+    /**
+     * The style overrides.
+     */
+    style?: StyleProp<TextStyle>;
+}
+/**
+ * The default style for the menu title.
+ */
+export declare const DEFAULT_MENU_TITLE_STYLE: TextStyle;
+/**
+ * The title placed at the top of the fullscreen menu.
+ */
+export declare const MenuTitle: (props: MenuTitleProps) => JSX.Element;

package/lib/typescript/ui/components/menu/common/MenuView.d.ts

@@ -0,0 +1,21 @@
+import { ReactNode } from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+interface MenuViewProps {
+    /**
+     * The menu to render inside the menu view.
+     */
+    menu: ReactNode;
+    /**
+     * The style overrides for the menu view.
+     */
+    style?: StyleProp<ViewStyle>;
+}
+/**
+ * The default style for the menu view.
+ */
+export declare const DEFAULT_MENU_VIEW_STYLE: ViewStyle;
+/**
+ * A component to render a fullscreen menu with a title and back button for the `react-native-theoplayer` UI.
+ */
+export declare const MenuView: (props: MenuViewProps) => JSX.Element;
+export {};

package/lib/typescript/ui/components/menu/common/ScrollableMenu.d.ts

@@ -0,0 +1,23 @@
+import { ReactNode } from 'react';
+import { ViewStyle } from 'react-native';
+interface ScrollableMenuProps {
+    /**
+     * The title of the scrollable menu.
+     */
+    title: string;
+    /**
+     * The items to be put in the scrollable menu.
+     */
+    items?: ReactNode;
+}
+/**
+ * The default style for the scrollable menu.
+ */
+export declare const DEFAULT_SCROLLABLE_MENU_STYLE: ViewStyle;
+/**
+ * A menu component that provides a ScrollView for menu items for the `react-native-theoplayer` UI.
+ * @param props
+ * @constructor
+ */
+export declare const ScrollableMenu: (props: ScrollableMenuProps) => JSX.Element;
+export {};

package/lib/typescript/ui/components/menu/common/SubMenuWithButton.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+import { StyleProp, TextStyle, ViewStyle } from 'react-native';
+import type { MenuConstructor } from '../../uicontroller/UiControls';
+export interface SubMenuButtonProps {
+    /**
+     * The style overrides.
+     */
+    style?: StyleProp<ViewStyle>;
+    /**
+     * The style overrides for the text components.
+     */
+    textStyle?: StyleProp<TextStyle>;
+    /**
+     * The sub menu that will be opened.
+     */
+    menuConstructor: MenuConstructor;
+    /**
+     * The label for the sub menu button.
+     */
+    label: string;
+    /**
+     * A preview for the currently selected value before opening the sub menu.
+     */
+    preview: string;
+}
+/**
+ * A component that can be put inside a SettingsMenuButton to create a sub menu.
+ */
+export declare const SubMenuWithButton: (props: SubMenuButtonProps) => JSX.Element;

package/lib/typescript/ui/components/menu/common/barrel.d.ts

@@ -0,0 +1,6 @@
+export * from './MenuButton';
+export * from './MenuTitle';
+export * from './MenuView';
+export * from './MenuRadioButton';
+export * from './ScrollableMenu';
+export * from './SubMenuWithButton';

package/lib/typescript/ui/components/message/CastMessage.d.ts

@@ -0,0 +1,16 @@
+import { PureComponent } from 'react';
+interface CastMessageState {
+    message: string | undefined;
+}
+/**
+ * A simple cast message showing the current state of casting for the `react-native-theoplayer` UI.
+ */
+export declare class CastMessage extends PureComponent<unknown, CastMessageState> {
+    constructor(props: unknown);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _processCastState;
+    private onCastEvent;
+    render(): JSX.Element;
+}
+export {};

package/lib/typescript/ui/components/message/ErrorDisplay.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { PlayerError } from 'react-native-theoplayer';
+export interface ErrorDisplayProps {
+    /**
+     * The error that will be displayed.
+     */
+    error: PlayerError;
+}
+/**
+ * A fullscreen error component for the `react-native-theoplayer` UI.
+ */
+export declare function ErrorDisplay(props: ErrorDisplayProps): JSX.Element;