Variable OGDownloadsConst

Type Declaration

• add: function

  • add(item: OGMediaItem, config?: OGDownloadConfig): Promise<void>

    Queues a download (idempotent per URL — re-adding a completed or in-flight URL is a no-op). For DRM items this also acquires the persistent offline license during the download; see the DRM note above for how tokenProvider items are handled. Resolves once the request has been handed to the native download manager — progress and completion arrive via OGDownloads.addListener.

    Parameters

    • item: OGMediaItem
    • config: OGDownloadConfig = {}

    Returns Promise<void>

• addListener: function

  • addListener(callback: (event: OGDownloadEvent) => void): { remove(): void }

    Subscribes to download events: stateChanged on every state transition, throttled progress while downloading, and failed with the mirrored OGPlayerError. Returns a subscription — call remove() to stop.

    Parameters

    • callback: (event: OGDownloadEvent) => void

    Returns { remove(): void }

• list: function

  • list(): Promise<OGDownload[]>

    A snapshot of every download the SDK knows about, in insertion order.

    Returns Promise<OGDownload[]>

• pause: function

  • pause(url: string): void

    Pauses the download with this media URL.

    Parameters

    • url: string

    Returns void

• pauseAll: function

  • pauseAll(): void

    Pauses every download.

    Returns void

• remove: function

  • remove(url: string, item?: OGMediaItem): Promise<void>

    Deletes the downloaded media AND releases/erases its stored license.

    For DRM'd downloads on Android, pass the item (same drm config used for OGDownloads.add) so the Widevine release request to the license server can authenticate — without it, token-authorized deployments leak that device's server-side offline slot until it expires. A tokenProvider is invoked once (renewal: true) before the call crosses the bridge. iOS ignores item: FairPlay persistent keys are erased locally, no server round-trip exists.

    Parameters

    • url: string
    • Optionalitem: OGMediaItem

    Returns Promise<void>

• renewLicense: function

  • renewLicense(item: OGMediaItem): Promise<OfflineLicenseInfo>

    Re-fetches the persistent license for a downloaded DRM item — call when OfflineLicenseInfo.isExpired (or playback fails with 4006 DRM_OFFLINE_LICENSE_EXPIRED) and the device is online. The item must carry the same drm config used for the download; a tokenProvider is invoked once with renewal: true before the request crosses the bridge.

    Parameters

    • item: OGMediaItem

    Returns Promise<OfflineLicenseInfo>

• resume: function

  • resume(url: string): void

    Resumes a paused/failed download with this media URL.

    Parameters

    • url: string

    Returns void

• resumeAll: function

  • resumeAll(): void

    Resumes every paused download.

    Returns void