Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IEngineEventMediaResource

    Allows accessing a media resource related with certain EngineEvents.

    interface IEngineEventMediaResource {
        createUrl(): Promise<string>;
        getMediaTypeCategory(): MediaTypeCategory;
        getResourceUrl(): string;
        isDataUrl(): boolean;
        isRemoteUrl(): boolean;
        revokeUrl(url: string): void;
        toJSON(): IEngineEventMediaResourceData;
    }

    Methods

    • Creates a URL to the resource that can used to render the resource in the browser using an Element appropriate for the resource, like for example an or

      Regardless, clients MUST call revokeUrl() with the url returned by this method to avoid memory leakage.

      Returns Promise<string>

      Resolved with a URL to the resource.

    • Returns the URL of the resource. Note that this URL might not be usable by the browser directly. Use createUrl() to get an URL that can be used with the browser.

      Returns string

    • Returns true if the resource URL is a data URL.

      Returns boolean

    • Returns true if the resource URL is a remote http or https URL.

      Returns boolean

    • Revokes a URL previously created with createUrl(), allowing any underlying resources to be released.

      Parameters

      • url: string

        The URL to revoke.

      Returns void