@playkit-js/playkit-js-ui 0.82.9 → 0.82.10-canary.0-e694d66

package/dist/playkit-js-ui.d.ts

@@ -90,6 +90,42 @@ declare const actions_12: {
     };
 };
 
+declare const actions_13: {
+    updateAudioDescriptionLanguages: (audioDescriptionLanguages: string[]) => {
+        type: string;
+        audioDescriptionLanguages: string[];
+    };
+    updateAdvancedAudioDescriptionLanguages: (advancedAudioDescriptionLanguages: string[]) => {
+        type: string;
+        advancedAudioDescriptionLanguages: string[];
+    };
+    updateAudioDescriptionEnabled: (isEnabled: boolean) => {
+        type: string;
+        isEnabled: boolean;
+    };
+    updateAudioDescriptionType: (selectedType: AUDIO_DESCRIPTION_TYPE) => {
+        type: string;
+        selectedType: AUDIO_DESCRIPTION_TYPE;
+    };
+    updateSelectionByLanguage: (language: string, isEnabled: boolean, selectedType: AUDIO_DESCRIPTION_TYPE) => {
+        type: string;
+        language: string;
+        isEnabled: boolean;
+        selectedType: AUDIO_DESCRIPTION_TYPE;
+    };
+    resetSelectionByLanguage: () => {
+        type: string;
+    };
+    updateDefaultValueSet: (isDefaultValueSet: boolean) => {
+        type: string;
+        isDefaultValueSet: boolean;
+    };
+    updateSelectedAudioLanguage: (selectedAudioLanguage: string | null) => {
+        type: string;
+        selectedAudioLanguage: string | null;
+    };
+};
+
 declare const actions_2: {
     updateCaptionsStyle: (style: string) => {
         type: string;
@@ -392,14 +428,6 @@ declare const actions_8: {
         type: string;
         speed: string;
     };
-    updateAudio: (audio: string) => {
-        type: string;
-        audio: string;
-    };
-    updateAdvancedAudioDesc: (isChecked: boolean) => {
-        type: string;
-        isChecked: boolean;
-    };
     updateIsCaptionsEnabled: (isCaptionsEnabled: boolean) => {
         type: string;
         isCaptionsEnabled: boolean;
@@ -895,75 +923,6 @@ declare type AdSkipProps = {
  */
 declare function adsUI(props: any): VNode<any> | undefined;
 
-/**
- * AdvancedAudioDesc component
- *
- * @class AdvancedAudioDesc
- * @example <AdvancedAudioDesc step={5} />
- * @extends {Component}
- */
-declare class AdvancedAudioDesc extends Component<any, any> implements IconComponent {
-    componentDidUpdate(previousProps: any): void;
-    get advancedAudioDesc(): boolean;
-    registerComponent(): any;
-    getComponentText: () => any;
-    getSvgIcon: () => any;
-    /**
-     * should render component
-     * @returns {boolean} - whether to render the component
-     */
-    private _shouldRender;
-    /**
-     * AdvancedAudioDesc click handler
-     *
-     * @returns {void}
-     * @memberof AdvancedAudioDesc
-     */
-    private onClick;
-    /**
-     * on key down handler
-     *
-     * @param {KeyboardEvent} e - keyboard event
-     * @returns {void}
-     * @memberof AdvancedAudioDesc
-     */
-    onKeyDown: (e: KeyboardEvent) => void;
-    /**
-     * render component
-     *
-     * @param {*} props - component props
-     * @returns {React$Element} - component element
-     * @memberof AdvancedAudioDesc
-     */
-    render({ innerRef }: any): VNode<any> | undefined;
-}
-
-/**
- * AdvancedAudioDescToggle component
- *
- * @class AdvancedAudioDescToggle
- * @example <AdvancedAudioDescToggle />
- * @extends {Component}
- */
-declare class AdvancedAudioDescToggle extends Component<any, any> {
-    /**
-     * Toggle the Advanced Audio Description option and update it in the store state
-     *
-     * @param {boolean} isChecked - Whether the feature is enabled or not
-     * @returns {void}
-     * @memberof AdvancedAudioDescToggle
-     */
-    onAdvancedAudioClick: (isChecked: boolean) => void;
-    /**
-     * render function
-     *
-     * @param {*} props - component props
-     * @returns {React$Element} - component
-     * @memberof AdvancedAudioDescToggle
-     */
-    render(props: any): h.JSX.Element;
-}
-
 /**
  * @typedef {Object} KPAdvertisingConfigObject@typedef {Object} KPAdvertisingConfigObject
  * @property {PrebidConfig} prebid - The prebid config.
@@ -980,36 +939,34 @@ declare interface AdvertisingConfig {
     adBreakCuePointStyle?: Object;
 }
 
-/**
- * AudioMenu component
- *
- * @class AudioMenu
- * @example <AudioMenu />
- * @extends {Component}
- */
-declare class AudioMenu extends Component<AudioMenuProps & WithPlayerProps & WithEventDispatcherProps, any> {
-    /**
-     * call to player selectTrack method and change audio track
-     *
-     * @param {Object} audioTrack - audio track
-     * @returns {void}
-     * @memberof Settings
-     */
-    onAudioChange(audioTrack: any): void;
-    /**
-     * render function
-     *
-     * @param {*} props - component props
-     * @returns {React$Element} - component
-     * @memberof AudioMenu
-     */
-    render(props: any): h.JSX.Element;
+declare const Audio_2: any;
+
+declare enum AUDIO_DESCRIPTION_TYPE {
+    AUDIO_DESCRIPTION = 1,
+    EXTENDED_AUDIO_DESCRIPTION = 2
 }
 
-declare type AudioMenuProps = {
-    audioTracks?: any[];
-    audioLabelText?: string;
-};
+declare const AudioDesc: any;
+
+declare namespace audioDescription {
+    export {
+        types_13 as types,
+        initialState_13 as initialState,
+        _default_13 as default,
+        actions_13 as actions
+    }
+}
+
+declare interface AudioDescriptionState {
+    audioDescriptionLanguages: string[];
+    advancedAudioDescriptionLanguages: string[];
+    isEnabled: boolean;
+    selectedType: AUDIO_DESCRIPTION_TYPE;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+    selectedAudioLanguage: string | null;
+}
+
+declare const AudioMenu: any;
 
 declare const BadgeType: {
     qualityHd: string;
@@ -1672,6 +1629,7 @@ declare function bindActions<A, M extends ActionCreatorsMapObject<A>>(actions: M
  */
 declare class BottomBar extends Component<any, any> {
     private bottomBarContainerRef;
+    private leftControlsRef;
     private presetControls;
     private resizeObserver;
     private _currBarWidthArr;
@@ -2076,8 +2034,7 @@ declare namespace Components {
         QualityMenu,
         HeightResolution,
         getLabelBadgeType,
-        AdvancedAudioDescToggle,
-        AdvancedAudioDesc,
+        AudioDesc,
         ExpandableText,
         Scrollable,
         ProgressIndicator,
@@ -2111,6 +2068,7 @@ declare namespace Components {
         ClosedCaptions,
         ClosedCaptions as ClosedCaptionsControl,
         CaptionsControl,
+        Audio_2 as Audio,
         EventDispatcherProvider,
         WithEventDispatcherProps,
         withEventDispatcher,
@@ -2318,6 +2276,51 @@ declare const _default_12: (state: BottomBarState | undefined, action: any) => {
     controlsToMove: any;
 };
 
+declare const _default_13: (state: AudioDescriptionState | undefined, action: any) => {
+    audioDescriptionLanguages: any;
+    advancedAudioDescriptionLanguages: string[];
+    isEnabled: boolean;
+    selectedType: AUDIO_DESCRIPTION_TYPE;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+    selectedAudioLanguage: string | null;
+} | {
+    advancedAudioDescriptionLanguages: any;
+    audioDescriptionLanguages: string[];
+    isEnabled: boolean;
+    selectedType: AUDIO_DESCRIPTION_TYPE;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+    selectedAudioLanguage: string | null;
+} | {
+    isEnabled: any;
+    audioDescriptionLanguages: string[];
+    advancedAudioDescriptionLanguages: string[];
+    selectedType: AUDIO_DESCRIPTION_TYPE;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+    selectedAudioLanguage: string | null;
+} | {
+    selectedType: any;
+    audioDescriptionLanguages: string[];
+    advancedAudioDescriptionLanguages: string[];
+    isEnabled: boolean;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+    selectedAudioLanguage: string | null;
+} | {
+    isDefaultValueSet: any;
+    audioDescriptionLanguages: string[];
+    advancedAudioDescriptionLanguages: string[];
+    isEnabled: boolean;
+    selectedType: AUDIO_DESCRIPTION_TYPE;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+    selectedAudioLanguage: string | null;
+} | {
+    selectedAudioLanguage: any;
+    audioDescriptionLanguages: string[];
+    advancedAudioDescriptionLanguages: string[];
+    isEnabled: boolean;
+    selectedType: AUDIO_DESCRIPTION_TYPE;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+};
+
 declare const _default_2: (state: CvaaState | undefined, action: any) => {
     style: any;
 };
@@ -2472,28 +2475,19 @@ declare const _default_8: (state: SettingsState | undefined, action: any) => {
     quality: any;
     speed: number;
     audio?: string | undefined;
-    advancedAudioDesc: boolean;
 } | {
     speed: any;
     quality: number;
     audio?: string | undefined;
-    advancedAudioDesc: boolean;
 } | {
     audio: any;
     quality: number;
     speed: number;
-    advancedAudioDesc: boolean;
-} | {
-    advancedAudioDesc: any;
-    quality: number;
-    speed: number;
-    audio?: string | undefined;
 } | {
     isCaptionsEnabled: any;
     quality: number;
     speed: number;
     audio?: string | undefined;
-    advancedAudioDesc: boolean;
 };
 
 declare const _default_9: (state: ShellState | undefined, action: any) => {
@@ -2884,7 +2878,7 @@ declare type EngineConnectorProps = {
     engine: EngineState;
     player: KalturaPlayer;
     eventManager: EventManager;
-} & typeof actions_3 & typeof actions_4 & typeof actions_9 & {
+} & typeof actions_3 & typeof actions_4 & typeof actions_13 & typeof actions_9 & {
     seekbarUpdateCurrentTime: typeof actions_7.updateCurrentTime;
 } & {
     updateIsCaptionsEnabled: typeof actions_8.updateIsCaptionsEnabled;
@@ -3107,6 +3101,7 @@ declare const EventType: {
     readonly USER_SELECTED_CAPTIONS_BACKGROUND_COLOR: "playkit-ui-userselectedcaptionsbackgroundcolor";
     readonly USER_SELECTED_CAPTIONS_BACKGROUND_OPACITY: "playkit-ui-userselectedcaptionsbackgroundopacity";
     readonly BOTTOM_BAR_CLIENT_RECT_CHANGED: "playkit-ui-bottombarclientrectchanged";
+    readonly BOTTOM_BAR_NEEDS_RESIZE: "playkit-ui-bottombarneedsresize";
     readonly PLAYER_HOVERED: "playkit-ui-playerhovered";
     readonly USER_COPIED_DEBUG_INFO: "playkit-ui-usercopieddebuginfo";
 };
@@ -3330,9 +3325,9 @@ declare interface IAdsPluginController {
  * @extends {Component}
  */
 declare class Icon extends Component<any, any> {
-    _defaultColor: string;
-    _activeColor: string;
-    _className: string;
+    private _defaultColor;
+    private _activeColor;
+    private _className;
     /**
      * @constructor
      * @param {Object} props - component props
@@ -3345,7 +3340,7 @@ declare class Icon extends Component<any, any> {
      * @returns {void}
      * @memberof Icon
      */
-    createDynamicIconClass: (props: any) => void;
+    private createDynamicIconClass;
     /**
      * Generates the encoded svg url for a certain svg path
      *
@@ -3357,7 +3352,7 @@ declare class Icon extends Component<any, any> {
      * @returns {string} - encoded svg url
      * @memberof Icon
      */
-    getSVGUrl: (path: string, width?: number, height?: number, viewBox?: string, fillRule?: string) => string;
+    private getSVGUrl;
     /**
      * @param {?number} state - icon state
      * @param {?string} color - external default color
@@ -3365,14 +3360,14 @@ declare class Icon extends Component<any, any> {
      * @returns {string} - svg fill color
      * @memberof Icon
      */
-    getFillColor: (state?: number, color?: string, activeColor?: string) => string;
+    private getFillColor;
     /**
      * @param {string | Array<string>} pathProps - svg path or paths (if an icon contains multiple paths)
      * @param {string} fillColor - icon fill color
      * @returns {string} - icon path tag
      * @memberof Icon
      */
-    getPathTag: (pathProps: any | Array<any>, fillColor: string) => string;
+    private getPathTag;
     /**
      * component will update
      * @param {Object} nextProps - the next props
@@ -3405,6 +3400,7 @@ declare const IconType: {
     Minimize: string;
     Play: string;
     Pause: string;
+    Stop: string;
     VolumeBase: string;
     VolumeWaves: string;
     VolumeWave: string;
@@ -3439,6 +3435,8 @@ declare const IconType: {
     ClosedCaptionsOff: string;
     AdvancedAudioDescription: string;
     AdvancedAudioDescriptionActive: string;
+    AdvancedAudioDescriptionDisabled: string;
+    AdvancedAudioDescriptionDisabledDropdown: string;
 };
 
 /**
@@ -3468,15 +3466,20 @@ declare function imgUI(props: any): VNode<any>;
 declare const initialState: {
     targetId: string;
     forceTouchUI: boolean;
+    allowPlayPause: boolean;
+    allowLivePlayPause: boolean;
     showCCButton: boolean;
+    showAudioButton: boolean;
+    showAudioDescriptionButton: boolean;
     openMenuFromCCButton: boolean;
+    openMenuFromAudioDescriptionButton: boolean;
     settings: {
         showAudioMenu: boolean;
         showCaptionsMenu: boolean;
         showQualityMenu: boolean;
         showSpeedMenu: boolean;
-        showAdvancedAudioDescToggle: boolean;
         showAdvancedCaptionsMenu: boolean;
+        showAudioDescriptionMenu: boolean;
     };
     hoverTimeout: number;
     tinySizeDisabled: boolean;
@@ -3503,6 +3506,16 @@ declare const initialState_12: {
     controlsToMove: never[];
 };
 
+declare const initialState_13: {
+    audioDescriptionLanguages: never[];
+    advancedAudioDescriptionLanguages: never[];
+    isEnabled: boolean;
+    selectedType: AUDIO_DESCRIPTION_TYPE;
+    selectionByLanguage: Map<string, [boolean, AUDIO_DESCRIPTION_TYPE]>;
+    isDefaultValueSet: boolean;
+    selectedAudioLanguage: null;
+};
+
 declare const initialState_2: {
     style: string;
 };
@@ -3584,7 +3597,6 @@ declare const initialState_7: SeekbarState;
 declare const initialState_8: {
     quality: number;
     speed: number;
-    advancedAudioDesc: boolean;
     isCaptionsEnabled: boolean;
 };
 
@@ -4356,9 +4368,7 @@ declare class Keyboard extends Component<any, any> {
      *
      * @memberof Keyboard
      */
-    keyboardHandlers: {
-        [key: number]: (event: KeyboardEvent) => KeyboardEventResult;
-    };
+    private keyboardHandlers;
     render(): undefined;
 }
 
@@ -4855,7 +4865,7 @@ declare interface MediaSourceOptionsObject {
  * @extends {Component}
  */
 declare class Menu extends Component<MenuProps & WithEventManagerProps, any> {
-    _menuElement: HTMLDivElement;
+    private _menuElement;
     /**
      * before component mounted, set initial state of the menu position
      * @returns {void}
@@ -4874,7 +4884,7 @@ declare class Menu extends Component<MenuProps & WithEventManagerProps, any> {
      * @returns {Array} position style classes array
      * @memberof Menu
      */
-    getPosition(): Array<string>;
+    private getPosition;
     /**
      * handler to click outside of the component event listener.
      * if not mobile device and clicked outside the component, call the onClose callback
@@ -4883,7 +4893,7 @@ declare class Menu extends Component<MenuProps & WithEventManagerProps, any> {
      * @returns {void}
      * @memberof Menu
      */
-    handleClickOutside: (e: any) => void;
+    private handleClickOutside;
     /**
      * indication if option is active or not
      *
@@ -4891,7 +4901,7 @@ declare class Menu extends Component<MenuProps & WithEventManagerProps, any> {
      * @returns {boolean} is option active boolean
      * @memberof Menu
      */
-    isSelected(option: any): boolean;
+    private isSelected;
     /**
      * when option selected, change the active prop immediately for instant ui change
      * and call the onSelect callback with the option value
@@ -4900,7 +4910,7 @@ declare class Menu extends Component<MenuProps & WithEventManagerProps, any> {
      * @returns {void}
      * @memberof Menu
      */
-    onSelect(option: OptionType): void;
+    private onSelect;
     /**
      * on change handler
      * @param {Event} e - event
@@ -4914,14 +4924,14 @@ declare class Menu extends Component<MenuProps & WithEventManagerProps, any> {
      * - If the selected index is within `options.length`, it's a normal option, so we call `onSelect()`.
      * - Otherwise, it's `additionalOptions`, so we calculate itsrelative index and call `onMenuChosen()` directly
      */
-    onChange: (e: Event) => void;
+    private onChange;
     /**
      * render native select element
      * @param {string} labelledby - the label id the describes the dropdown (for screen reader)
      * @returns {React$Element} - component element
      * @memberof Menu
      */
-    renderNativeSelect(labelledby: string): VNode<any>;
+    private renderNativeSelect;
     /**
      * if mobile device detected, renders the native select element.
      * otherwise, render the styled menu
@@ -4962,7 +4972,9 @@ declare interface NetworkConfig {
 declare type OptionType = {
     value: any;
     label: string;
+    ariaLabel?: string;
     active: boolean;
+    disabled?: boolean;
 };
 
 /**
@@ -5065,7 +5077,7 @@ declare class OverlayAction extends Component<any, any> {
      * @returns {void}
      * @memberof OverlayAction
      */
-    togglePlayPause: () => void;
+    private togglePlayPause;
     /**
      * toggle exit-enter fullscreen
      *
@@ -5841,9 +5853,7 @@ declare interface PlaylistState {
  */
 declare class PlayPause extends Component<any, any> {
     private _playPauseButtonRef?;
-    state: {
-        entryName: string;
-    };
+    constructor();
     /**
      * component mounted
      *
@@ -5857,8 +5867,8 @@ declare class PlayPause extends Component<any, any> {
      * @returns {void}
      * @memberof PlayPause
      */
-    togglePlayPause: () => void;
-    handleKeyDown: (e: KeyboardEvent) => void;
+    private togglePlayPause;
+    private handleKeyDown;
     /**
      * render component
      *
@@ -6029,7 +6039,8 @@ declare namespace Reducers {
         shell,
         volume,
         overlay,
-        bottomBar
+        bottomBar,
+        audioDescription
     }
 }
 export { Reducers }
@@ -6270,6 +6281,7 @@ export declare interface RootState {
     playlist: PlaylistState;
     overlay: OverlayState;
     bottomBar: BottomBarState;
+    audioDescription: AudioDescriptionState;
 }
 
 /**
@@ -6382,7 +6394,7 @@ declare class SeekBar extends Component<any, any> {
      * @returns {void}
      * @memberof SeekBar
      */
-    togglePlayPause: () => void;
+    private togglePlayPause;
     /**
      * seekbar touch end handler
      *
@@ -6735,7 +6747,6 @@ declare interface SettingsState {
     quality: number;
     speed: number;
     audio?: string;
-    advancedAudioDesc: boolean;
 }
 
 /**
@@ -6793,7 +6804,7 @@ declare class Shell extends Component<any, any> {
      * @param {KeyboardEvent} e - event object
      * @returns {void}
      */
-    onKeyDown: (e: KeyboardEvent) => void;
+    private onKeyDown;
     /**
      * componentWillMount
      *
@@ -7589,6 +7600,17 @@ declare const types_12: {
     UPDATE_CONTROLS_TO_MOVE: string;
 };
 
+declare const types_13: {
+    UPDATE_AUDIO_DESCRIPTION_LANGUAGES: string;
+    UPDATE_EXTENDED_AUDIO_DESCRIPTION_LANGUAGES: string;
+    UPDATE_AUDIO_DESCRIPTION_ENABLED: string;
+    UPDATE_AUDIO_DESCRIPTION_TYPE: string;
+    UPDATE_SELECTION_BY_LANGUAGE: string;
+    RESET_SELECTION_BY_LANGUAGE: string;
+    UPDATE_DEFAULT_VALUE_SET: string;
+    UPDATE_SELECTED_AUDIO_LANGUAGE: string;
+};
+
 declare const types_2: {
     UPDATE_CAPTIONS_STYLE: string;
 };
@@ -7845,15 +7867,20 @@ export declare interface UIOptionsObject {
     targetId: string;
     debugActions?: boolean;
     forceTouchUI?: boolean;
+    allowPlayPause?: boolean;
+    allowLivePlayPause?: boolean;
     showCCButton?: boolean;
+    showAudioDescriptionButton?: boolean;
     openMenuFromCCButton?: boolean;
+    openMenuFromAudioDescriptionButton?: boolean;
+    showAudioButton?: boolean;
     settings?: {
         showAudioMenu?: boolean;
         showCaptionsMenu?: boolean;
         showQualityMenu?: boolean;
         showSpeedMenu?: boolean;
-        showAdvancedAudioDescToggle?: boolean;
         showAdvancedCaptionsMenu?: boolean;
+        showAudioDescriptionMenu?: boolean;
     };
     hoverTimeout?: number;
     logger?: LoggerType;