@shockpkg/dir-projector/dts/projector/html.d.ts

Package for creating Shockwave Director projectors

import { Projector } from '../projector.ts';
/**
 * ProjectorHtml object.
 */
export declare class ProjectorHtml extends Projector {
    /**
     * The HTML document lang.
     */
    lang: string | null;
    /**
     * The HTML document title.
     */
    title: string | null;
    /**
     * HTML document background style.
     */
    background: string | null;
    /**
     * HTML document color style.
     */
    color: string | null;
    /**
     * Required <object> classid attribute.
     */
    classid: string;
    /**
     * Required <embed> type attribute.
     */
    type: string;
    /**
     * The <object> codebase attribute.
     */
    codebase: string | null;
    /**
     * The <embed> codebase attribute.
     */
    pluginspage: string | null;
    /**
     * Required src/movie URL (unless using custom HTML).
     */
    src: string;
    /**
     * Required movie width (unless using custom HTML).
     */
    width: string | number | null;
    /**
     * Required movie height (unless using custom HTML).
     */
    height: string | number | null;
    /**
     * The name for object, param, and embed elements.
     */
    name: string | null;
    /**
     * The id for the object element.
     */
    id: string | null;
    /**
     * The movie background color.
     */
    bgcolor: string | null;
    /**
     * The movie stretch style (none | meet | fill | stage).
     */
    swStretchStyle: string | null;
    /**
     * The stretch horizontal alignment (left | center | right).
     */
    swStretchHAlign: string | null;
    /**
     * The stretch vertical alignment (top | center | bottom).
     */
    swStretchVAlign: string | null;
    /**
     * A set of parameters in the form of "swVolume='false' swRestart='true'".
     * Boolean: swSaveEnabled.
     * Boolean: swVolume.
     * Boolean: swRestart.
     * Boolean: swPausePlay.
     * Boolean: swFastForward.
     * Boolean: swContextMenu.
     */
    swRemote: string | null;
    /**
     * Custom parameter 1.
     */
    sw1: string | null;
    /**
     * Custom parameter 2.
     */
    sw2: string | null;
    /**
     * Custom parameter 3.
     */
    sw3: string | null;
    /**
     * Custom parameter 4.
     */
    sw4: string | null;
    /**
     * Custom parameter 5.
     */
    sw5: string | null;
    /**
     * Custom parameter 6.
     */
    sw6: string | null;
    /**
     * Custom parameter 7.
     */
    sw7: string | null;
    /**
     * Custom parameter 8.
     */
    sw8: string | null;
    /**
     * Custom parameter 9.
     */
    sw9: string | null;
    /**
     * The progress attribute (controls loading screen?).
     */
    progress: string | boolean | null;
    /**
     * The logo attribute (controls loading screen?).
     */
    logo: string | boolean | null;
    /**
     * The playerversion attribute (for update checking?).
     */
    playerVersion: string | number | null;
    /**
     * Custom HTML to use instead of generated HTML.
     */
    html: string | ((self: this) => string) | ((self: this) => Promise<string>) | null;
    /**
     * ProjectorHtml constructor.
     *
     * @param path Output path.
     */
    constructor(path: string);
    /**
     * @inheritdoc
     */
    write(): Promise<void>;
    /**
     * Get HTML document code.
     *
     * @returns HTML code.
     */
    getHtml(): Promise<string>;
    /**
     * Get the default HTML document code.
     *
     * @returns HTML code.
     */
    getHtmlDefault(): string;
}