Skip to content

ProviderMetadata.md

Latest commit

 

History

History
189 lines (97 loc) · 5.48 KB

ProviderMetadata.md

File metadata and controls

189 lines (97 loc) · 5.48 KB

downflux

downflux / ProviderMetadata

Interface: ProviderMetadata

Defined in: packages/base/BaseContracts.ts:29

Describes provider capabilities, integration status, and access restrictions.

Remarks

Provider metadata lets the execution layer make conservative decisions without hard-coding site behavior into registries, engines, or storage code. It also documents which parts of a provider are verified, still experimental, or blocked by external requirements such as login, browser automation, or geo restrictions.

Properties

hasHls

hasHls: boolean

Defined in: packages/base/BaseContracts.ts:31

Whether the site exposes HLS playlist sources.

hlsIntegrated?

optional hlsIntegrated?: boolean

Defined in: packages/base/BaseContracts.ts:34

Whether HLS sources are wired into the download pipeline.

hasMp4

hasMp4: boolean

Defined in: packages/base/BaseContracts.ts:37

Whether the site exposes direct MP4/progressive sources.

mp4Integrated?

optional mp4Integrated?: boolean

Defined in: packages/base/BaseContracts.ts:40

Whether MP4 sources are wired into the download pipeline.

hasKvs

hasKvs: boolean

Defined in: packages/base/BaseContracts.ts:43

Whether the site uses KVS/Kernel Video Sharing page variables.

hasEmbeddableVideos?

optional hasEmbeddableVideos?: boolean

Defined in: packages/base/BaseContracts.ts:46

Whether the site exposes embeddable video pages.

underGeoRestriction

underGeoRestriction: boolean

Defined in: packages/base/BaseContracts.ts:49

Whether access may vary by region.

cloudflareChallenge?

optional cloudflareChallenge?: boolean

Defined in: packages/base/BaseContracts.ts:52

Whether Cloudflare or similar anti-bot handling is expected.

requiresBrowser

requiresBrowser: boolean

Defined in: packages/base/BaseContracts.ts:55

Whether extraction requires browser automation instead of plain HTTP.

underDevelopment

underDevelopment: boolean

Defined in: packages/base/BaseContracts.ts:58

Whether the provider is still changing or only partially supported.

needsExternalAPI?

optional needsExternalAPI?: boolean

Defined in: packages/base/BaseContracts.ts:61

Whether extraction depends on an external API.

canDownload?

optional canDownload?: boolean

Defined in: packages/base/BaseContracts.ts:64

Whether downloads are expected to work for supported methods.

nonFunctional?

optional nonFunctional?: boolean

Defined in: packages/base/BaseContracts.ts:67

Whether the provider is known to be non-functional.

sniSpoofingIssues?

optional sniSpoofingIssues?: boolean

Defined in: packages/base/BaseContracts.ts:70

Whether SNI spoofing is known to cause issues for this site.

requiresLogin?

optional requiresLogin?: boolean

Defined in: packages/base/BaseContracts.ts:73

Whether content access requires an authenticated user session.

sniSpoofing

sniSpoofing: SniSpoofStatus

Defined in: packages/base/BaseContracts.ts:76

Current support status for SNI spoofing on this provider.

type

type: ProviderType

Defined in: packages/base/BaseContracts.ts:79

The type of the provider.