@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
57 lines (56 loc) • 2.86 kB
TypeScript
import React, { ReactNode } from 'react';
/** VwcAudioPlayer
* For more info on this Vivid element please visit https://vivid.deno.dev/components/audio-player
* @param {| string
| null} playButtonAriaLabel **attribute** `play-button-aria-label`
* @param {| string
| null} pauseButtonAriaLabel **attribute** `pause-button-aria-label`
* @param {string | null} sliderAriaLabel **attribute** `slider-aria-label`
* @param {| string
| null} skipForwardButtonAriaLabel **attribute** `skip-forward-aria-label`
* @param {| string
| null} skipBackwardButtonAriaLabel **attribute** `skip-backward-aria-label`
* @param {AudioPlayerConnotation | undefined} connotation - The connotation the audio-player should have. **attribute** `connotation`
* @param {string | undefined} src - Indicates the audio-player's src. **attribute** `src`
* @param playbackRate
* @param {boolean} disabled - Indicates whether audio player is disabled. **attribute** `disabled`
* @param {boolean} notime **attribute** `notime`
* @param {AudioPlayerMediaSkipBy | undefined} skipBy - Allows the audio to skip back or forward **attribute** `skip-by`
* @param {string | null} playbackRates - Sets the available playback rates. When an empty string, no choices will be available **attribute** `playback-rates`
* @param {boolean} paused
* @param duration
* @param currentTime
* @param {boolean} durationFallback - Enables fallback logic to fetch and decode audio buffer for duration when metadata is missing. **attribute** `duration-fallback`
* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
* @param {string} componentName - Core component name, without prefix
*/
declare const VwcAudioPlayer: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
playButtonAriaLabel?: any;
pauseButtonAriaLabel?: any;
sliderAriaLabel?: string | null | undefined;
skipForwardButtonAriaLabel?: any;
skipBackwardButtonAriaLabel?: any;
connotation?: any;
src?: string | undefined;
playbackRate?: any;
disabled?: boolean | undefined;
notime?: boolean | undefined;
skipBy?: any;
playbackRates?: string | null | undefined;
paused?: boolean | undefined;
duration?: any;
currentTime?: any;
durationFallback?: boolean | undefined;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcAudioPlayer;