@aidenlx/player
Version:
Headless web components that make integrating media on the a web a breeze.
44 lines • 1.6 kB
TypeScript
import { CSSResultGroup, TemplateResult } from 'lit';
import { Html5MediaElement } from '../html5';
/**
* Used to embed sound content into documents via the native `<audio>` element. It may contain
* one or more audio sources, represented using the `src` attribute or the `<source>` element: the
* browser will choose the most suitable one.
*
* 💡 This element contains the exact same interface as the `<audio>` element. It redispatches
* all the native events if needed, but prefer the `vds-*` variants (eg: `vds-play`) as they
* iron out any browser issues.
*
* @tagname vds-audio
* @slot - Used to pass in `<source>`/`<track>` elements to the underlying HTML5 media player.
* @csspart media - The audio element (`<audio>`).
* @csspart audio - Alias for `media` part.
* @example
* ```html
* <vds-audio src="/media/audio.mp3">
* <!-- Additional media resources here. -->
* </vds-audio>
* ```
* @example
* ```html
* <vds-audio>
* <source src="/media/audio.mp3" type="audio/mp3" />
* </vds-audio>
* ```
*/
export declare class AudioElement extends Html5MediaElement {
static get styles(): CSSResultGroup;
protected render(): TemplateResult;
protected _renderAudio(): TemplateResult;
/**
* Override this to modify audio CSS Parts.
*/
protected _getAudioPartAttr(): string;
/**
* Can be used by attaching engine such as `hls.js` to prevent src attr being set on
* `<audio>` element.
*/
protected _shouldSetAudioSrcAttr(): boolean;
handleMediaCanLoad(): Promise<void>;
}
//# sourceMappingURL=AudioElement.d.ts.map