downloadPackagePluginFrame

GET

/api/v1/player/packages/{packageId}/plugins/{pluginId}/frame

const url = 'https://example.com/api/v1/player/packages/example/plugins/example/frame';
const options = {
  method: 'GET',
  headers: {Range: 'bytes=0-1048575', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/player/packages/example/plugins/example/frame \
  --header 'Authorization: Bearer <token>' \
  --header 'Range: bytes=0-1048575'

Download the deterministically assembled frame of an installed external Plugin API v2 contribution. Requires a device credential. Players verify exact size and SHA-256 before execution. The response confines scripts to an opaque sandbox and denies network and subresource loads.

Authorizations

deviceBearer

Parameters

Path Parameters

packageId

required

string

/^[a-z][a-z0-9_.:-]{0,127}$/

Store package identifier such as countdown_bar.

pluginId

required

string

/^[a-z][a-z0-9_]{0,79}$/

Header Parameters

Range

string

Example

bytes=0-1048575

If-Range

string

If-None-Match

string

Responses

200

Complete external plugin frame

text/html

string format: binary

206

Requested byte range

text/html

string format: binary

304

ETag matched

401

Device credential invalid or revoked

403

Screen disabled

404

Package or frame unavailable

416

Range not satisfiable