Interface: ScrapeResult

Defined in: src/youtube/ytdl.ts:27

The ScrapeResult interface represents the final structured output returned by the scraper, encapsulating the results of the scraping operation.

Properties

status

status: "success"

Defined in: src/youtube/ytdl.ts:28

Indicates the success of the scraping operation. Value is always set to "success" on a successful scrape.

metadata

metadata: Metadata

Defined in: src/youtube/ytdl.ts:29

Contains additional information about the scraped content, as defined by the Metadata type.

downloads

downloads: object

Defined in: src/youtube/ytdl.ts:30

An object that contains the formats available for download.

video

video: MediaFormat[]

An array of video formats available for download.

audio

audio: MediaFormat[]

An array of audio formats available for download.

Example


const scrapeResult: ScrapeResult = {
    status: "success",
    metadata: {
        title: "Example Video",
        uploader: "Example Uploader",
        // other metadata properties
    },
    downloads: {
        video: [
            { quality: "720p", format: "mp4", url: "http://example.com/video720.mp4" },
            { quality: "1080p", format: "mp4", url: "http://example.com/video1080.mp4" },
        ],
        audio: [
            { format: "mp3", url: "http://example.com/audio.mp3" },
        ],
    },
};