{"id":28513755,"url":"https://github.com/livepeer/livepeer-js","last_synced_at":"2025-07-04T07:31:42.672Z","repository":{"id":206769677,"uuid":"716441152","full_name":"livepeer/livepeer-js","owner":"livepeer","description":"JavaScript library for the Livepeer API.","archived":false,"fork":false,"pushed_at":"2024-11-18T02:14:33.000Z","size":2083,"stargazers_count":7,"open_issues_count":2,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-06-30T02:49:03.817Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/livepeer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-09T06:24:41.000Z","updated_at":"2025-03-05T22:37:09.000Z","dependencies_parsed_at":"2024-05-20T20:41:37.353Z","dependency_job_id":"b0438cae-d705-4c9a-bc6c-6c0554f5794e","html_url":"https://github.com/livepeer/livepeer-js","commit_stats":null,"previous_names":["livepeer/livepeer-js"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/livepeer/livepeer-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Flivepeer-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Flivepeer-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Flivepeer-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Flivepeer-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/livepeer","download_url":"https://codeload.github.com/livepeer/livepeer-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Flivepeer-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263467781,"owners_count":23471128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-09T01:07:54.060Z","updated_at":"2025-07-04T07:31:42.659Z","avatar_url":"https://github.com/livepeer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Livepeer JavaScript Library\n\n[![Version](https://img.shields.io/npm/v/livepeer.svg)](https://www.npmjs.org/package/livepeer)\n[![Downloads](https://img.shields.io/npm/dm/livepeer.svg)](https://www.npmjs.com/package/livepeer)\n[![Try on RunKit](https://badge.runkitcdn.com/livepeer.svg)](https://runkit.com/npm/livepeer)\n\nThe Livepeer JavaScript library provides convenient access to the Livepeer Studio API from\napplications written in both browser and server-side JavaScript\n\n## Documentation\n\nFor full documentation and examples, please visit [docs.livepeer.org](https://docs.livepeer.org/sdks/javascript/).\n\n\u003c!-- No SDK Installation [installation] --\u003e\n## Installation\n\nInstall the package with:\n\n```sh\nnpm install livepeer\n# or\nyarn add livepeer\n```\n\n\u003c!-- Start Summary [summary] --\u003e\n## Summary\n\nLivepeer API Reference: Welcome to the Livepeer API reference docs. Here you will find all the\nendpoints exposed on the standard Livepeer API, learn how to use them and\nwhat they return.\n\u003c!-- End Summary [summary] --\u003e\n\n\u003c!-- Start Table of Contents [toc] --\u003e\n## Table of Contents\n\n* [SDK Installation](#sdk-installation)\n* [Requirements](#requirements)\n* [SDK Example Usage](#sdk-example-usage)\n* [Available Resources and Operations](#available-resources-and-operations)\n* [Standalone functions](#standalone-functions)\n* [File uploads](#file-uploads)\n* [Retries](#retries)\n* [Error Handling](#error-handling)\n* [Server Selection](#server-selection)\n* [Custom HTTP Client](#custom-http-client)\n* [Authentication](#authentication)\n* [Debugging](#debugging)\n\u003c!-- End Table of Contents [toc] --\u003e\n\n\u003c!-- Start Requirements [requirements] --\u003e\n## Requirements\n\nFor supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).\n\u003c!-- End Requirements [requirements] --\u003e\n\n\u003c!-- No SDK Example Usage [usage] --\u003e\n## SDK Example Usage\n\n```ts\nimport { Livepeer } from \"livepeer\";\n\nconst livepeer = new Livepeer({\n  apiKey: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  const result = await livepeer.stream.create({\n    name: \"test_stream\",\n  });\n\n  console.log(result);\n}\n\nrun();\n```\n\n\u003c!-- Start Available Resources and Operations [operations] --\u003e\n## Available Resources and Operations\n\n\u003cdetails open\u003e\n\u003csummary\u003eAvailable methods\u003c/summary\u003e\n\n### [accessControl](docs/sdks/accesscontrol/README.md)\n\n* [create](docs/sdks/accesscontrol/README.md#create) - Create a signing key\n* [getAll](docs/sdks/accesscontrol/README.md#getall) - Retrieves signing keys\n* [delete](docs/sdks/accesscontrol/README.md#delete) - Delete Signing Key\n* [get](docs/sdks/accesscontrol/README.md#get) - Retrieves a signing key\n* [update](docs/sdks/accesscontrol/README.md#update) - Update a signing key\n\n### [asset](docs/sdks/asset/README.md)\n\n* [getAll](docs/sdks/asset/README.md#getall) - Retrieve assets\n* [create](docs/sdks/asset/README.md#create) - Upload an asset\n* [createViaUrl](docs/sdks/asset/README.md#createviaurl) - Upload asset via URL\n* [get](docs/sdks/asset/README.md#get) - Retrieves an asset\n* [update](docs/sdks/asset/README.md#update) - Patch an asset\n* [delete](docs/sdks/asset/README.md#delete) - Delete an asset\n\n### [generate](docs/sdks/generate/README.md)\n\n* [textToImage](docs/sdks/generate/README.md#texttoimage) - Text To Image\n* [imageToImage](docs/sdks/generate/README.md#imagetoimage) - Image To Image\n* [imageToVideo](docs/sdks/generate/README.md#imagetovideo) - Image To Video\n* [upscale](docs/sdks/generate/README.md#upscale) - Upscale\n* [audioToText](docs/sdks/generate/README.md#audiototext) - Audio To Text\n* [segmentAnything2](docs/sdks/generate/README.md#segmentanything2) - Segment Anything 2\n* [llm](docs/sdks/generate/README.md#llm) - LLM\n\n\n### [metrics](docs/sdks/metrics/README.md)\n\n* [getRealtimeViewership](docs/sdks/metrics/README.md#getrealtimeviewership) - Query realtime viewership\n* [getViewership](docs/sdks/metrics/README.md#getviewership) - Query viewership metrics\n* [getCreatorViewership](docs/sdks/metrics/README.md#getcreatorviewership) - Query creator viewership metrics\n* [getPublicViewership](docs/sdks/metrics/README.md#getpublicviewership) - Query public total views metrics\n* [getUsage](docs/sdks/metrics/README.md#getusage) - Query usage metrics\n\n### [multistream](docs/sdks/multistream/README.md)\n\n* [getAll](docs/sdks/multistream/README.md#getall) - Retrieve Multistream Targets\n* [create](docs/sdks/multistream/README.md#create) - Create a multistream target\n* [get](docs/sdks/multistream/README.md#get) - Retrieve a multistream target\n* [update](docs/sdks/multistream/README.md#update) - Update Multistream Target\n* [delete](docs/sdks/multistream/README.md#delete) - Delete a multistream target\n\n### [playback](docs/sdks/playback/README.md)\n\n* [get](docs/sdks/playback/README.md#get) - Retrieve Playback Info\n\n### [~~room~~](docs/sdks/room/README.md)\n\n* [~~create~~](docs/sdks/room/README.md#create) - Create a room :warning: **Deprecated**\n* [~~get~~](docs/sdks/room/README.md#get) - Retrieve a room :warning: **Deprecated**\n* [~~delete~~](docs/sdks/room/README.md#delete) - Delete a room :warning: **Deprecated**\n* [~~startEgress~~](docs/sdks/room/README.md#startegress) - Start room RTMP egress :warning: **Deprecated**\n* [~~stopEgress~~](docs/sdks/room/README.md#stopegress) - Stop room RTMP egress :warning: **Deprecated**\n* [~~createUser~~](docs/sdks/room/README.md#createuser) - Create a room user :warning: **Deprecated**\n* [~~getUser~~](docs/sdks/room/README.md#getuser) - Get user details :warning: **Deprecated**\n* [~~updateUser~~](docs/sdks/room/README.md#updateuser) - Update a room user :warning: **Deprecated**\n* [~~deleteUser~~](docs/sdks/room/README.md#deleteuser) - Remove a user from the room :warning: **Deprecated**\n\n### [session](docs/sdks/session/README.md)\n\n* [getClips](docs/sdks/session/README.md#getclips) - Retrieve clips of a session\n* [getAll](docs/sdks/session/README.md#getall) - Retrieve sessions\n* [get](docs/sdks/session/README.md#get) - Retrieve a session\n* [getRecorded](docs/sdks/session/README.md#getrecorded) - Retrieve Recorded Sessions\n\n### [stream](docs/sdks/stream/README.md)\n\n* [create](docs/sdks/stream/README.md#create) - Create a stream\n* [getAll](docs/sdks/stream/README.md#getall) - Retrieve streams\n* [get](docs/sdks/stream/README.md#get) - Retrieve a stream\n* [update](docs/sdks/stream/README.md#update) - Update a stream\n* [delete](docs/sdks/stream/README.md#delete) - Delete a stream\n* [terminate](docs/sdks/stream/README.md#terminate) - Terminates a live stream\n* [startPull](docs/sdks/stream/README.md#startpull) - Start ingest for a pull stream\n* [createClip](docs/sdks/stream/README.md#createclip) - Create a clip\n* [getClips](docs/sdks/stream/README.md#getclips) - Retrieve clips of a livestream\n* [addMultistreamTarget](docs/sdks/stream/README.md#addmultistreamtarget) - Add a multistream target\n* [removeMultistreamTarget](docs/sdks/stream/README.md#removemultistreamtarget) - Remove a multistream target\n\n### [task](docs/sdks/task/README.md)\n\n* [getAll](docs/sdks/task/README.md#getall) - Retrieve Tasks\n* [get](docs/sdks/task/README.md#get) - Retrieve a Task\n\n### [transcode](docs/sdks/transcode/README.md)\n\n* [create](docs/sdks/transcode/README.md#create) - Transcode a video\n\n### [webhook](docs/sdks/webhook/README.md)\n\n* [getAll](docs/sdks/webhook/README.md#getall) - Retrieve a Webhook\n* [create](docs/sdks/webhook/README.md#create) - Create a webhook\n* [get](docs/sdks/webhook/README.md#get) - Retrieve a webhook\n* [update](docs/sdks/webhook/README.md#update) - Update a webhook\n* [delete](docs/sdks/webhook/README.md#delete) - Delete a webhook\n* [getLogs](docs/sdks/webhook/README.md#getlogs) - Retrieve webhook logs\n* [getLog](docs/sdks/webhook/README.md#getlog) - Retrieve a webhook log\n* [resendLog](docs/sdks/webhook/README.md#resendlog) - Resend a webhook\n\n\u003c/details\u003e\n\u003c!-- End Available Resources and Operations [operations] --\u003e\n\n\u003c!-- Start Error Handling [errors] --\u003e\n## Error Handling\n\nAll SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.\n\nIf a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:\n\n| HTTP Client Error                                    | Description                                          |\n| ---------------------------------------------------- | ---------------------------------------------------- |\n| RequestAbortedError                                  | HTTP request was aborted by the client               |\n| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |\n| ConnectionError                                      | HTTP client was unable to make a request to a server |\n| InvalidRequestError                                  | Any input used to create a request is invalid        |\n| UnexpectedClientError                                | Unrecognised or unexpected error                     |\n\nIn addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `get` method may throw the following errors:\n\n| Error Type      | Status Code | Content Type     |\n| --------------- | ----------- | ---------------- |\n| errors.ErrorT   | 404         | application/json |\n| errors.SDKError | 4XX, 5XX    | \\*/\\*            |\n\n```typescript\nimport { Livepeer } from \"livepeer\";\nimport { ErrorT, SDKValidationError } from \"livepeer/models/errors\";\n\nconst livepeer = new Livepeer({\n  apiKey: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  let result;\n  try {\n    result = await livepeer.playback.get(\"\u003cid\u003e\");\n\n    // Handle the result\n    console.log(result);\n  } catch (err) {\n    switch (true) {\n      case (err instanceof SDKValidationError): {\n        // Validation errors can be pretty-printed\n        console.error(err.pretty());\n        // Raw value may also be inspected\n        console.error(err.rawValue);\n        return;\n      }\n      case (err instanceof ErrorT): {\n        // Handle err.data$: ErrorTData\n        console.error(err);\n        return;\n      }\n      default: {\n        throw err;\n      }\n    }\n  }\n}\n\nrun();\n\n```\n\nValidation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.\n\u003c!-- End Error Handling [errors] --\u003e\n\n\u003c!-- No Server Selection [server] --\u003e\n\n\u003c!-- Start Custom HTTP Client [http-client] --\u003e\n## Custom HTTP Client\n\nThe TypeScript SDK makes API calls using an `HTTPClient` that wraps the native\n[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This\nclient is a thin wrapper around `fetch` and provides the ability to attach hooks\naround the request lifecycle that can be used to modify the request or handle\nerrors and response.\n\nThe `HTTPClient` constructor takes an optional `fetcher` argument that can be\nused to integrate a third-party HTTP client or when writing tests to mock out\nthe HTTP client and feed in fixtures.\n\nThe following example shows how to use the `\"beforeRequest\"` hook to to add a\ncustom header and a timeout to requests and how to use the `\"requestError\"` hook\nto log errors:\n\n```typescript\nimport { Livepeer } from \"livepeer\";\nimport { HTTPClient } from \"livepeer/lib/http\";\n\nconst httpClient = new HTTPClient({\n  // fetcher takes a function that has the same signature as native `fetch`.\n  fetcher: (request) =\u003e {\n    return fetch(request);\n  }\n});\n\nhttpClient.addHook(\"beforeRequest\", (request) =\u003e {\n  const nextRequest = new Request(request, {\n    signal: request.signal || AbortSignal.timeout(5000)\n  });\n\n  nextRequest.headers.set(\"x-custom-header\", \"custom value\");\n\n  return nextRequest;\n});\n\nhttpClient.addHook(\"requestError\", (error, request) =\u003e {\n  console.group(\"Request Error\");\n  console.log(\"Reason:\", `${error}`);\n  console.log(\"Endpoint:\", `${request.method} ${request.url}`);\n  console.groupEnd();\n});\n\nconst sdk = new Livepeer({ httpClient });\n```\n\u003c!-- End Custom HTTP Client [http-client] --\u003e\n\n\u003c!-- Start Authentication [security] --\u003e\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name     | Type | Scheme      |\n| -------- | ---- | ----------- |\n| `apiKey` | http | HTTP Bearer |\n\nTo authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:\n```typescript\nimport { Livepeer } from \"livepeer\";\nimport {\n  Profile,\n  TranscodeProfileEncoder,\n  TranscodeProfileProfile,\n  Type,\n} from \"livepeer/models/components\";\n\nconst livepeer = new Livepeer({\n  apiKey: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  const result = await livepeer.stream.create({\n    name: \"test_stream\",\n    pull: {\n      source: \"https://myservice.com/live/stream.flv\",\n      headers: {\n        \"Authorization\": \"Bearer 123\",\n      },\n      location: {\n        lat: 39.739,\n        lon: -104.988,\n      },\n    },\n    playbackPolicy: {\n      type: Type.Webhook,\n      webhookId: \"1bde4o2i6xycudoy\",\n      webhookContext: {\n        \"streamerId\": \"my-custom-id\",\n      },\n      refreshInterval: 600,\n    },\n    profiles: [\n      {\n        width: 1280,\n        name: \"720p\",\n        height: 720,\n        bitrate: 3000000,\n        fps: 30,\n        fpsDen: 1,\n        quality: 23,\n        gop: \"2\",\n        profile: Profile.H264Baseline,\n      },\n    ],\n    record: false,\n    recordingSpec: {\n      profiles: [\n        {\n          width: 1280,\n          name: \"720p\",\n          height: 720,\n          bitrate: 3000000,\n          quality: 23,\n          fps: 30,\n          fpsDen: 1,\n          gop: \"2\",\n          profile: TranscodeProfileProfile.H264Baseline,\n          encoder: TranscodeProfileEncoder.H264,\n        },\n      ],\n    },\n    multistream: {\n      targets: [\n        {\n          profile: \"720p0\",\n          videoOnly: false,\n          id: \"PUSH123\",\n          spec: {\n            name: \"My target\",\n            url: \"rtmps://live.my-service.tv/channel/secretKey\",\n          },\n        },\n      ],\n    },\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();\n\n```\n\u003c!-- End Authentication [security] --\u003e\n\n\u003c!-- Start Standalone functions [standalone-funcs] --\u003e\n## Standalone functions\n\nAll the methods listed above are available as standalone functions. These\nfunctions are ideal for use in applications running in the browser, serverless\nruntimes or other environments where application bundle size is a primary\nconcern. When using a bundler to build your application, all unused\nfunctionality will be either excluded from the final bundle or tree-shaken away.\n\nTo read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).\n\n\u003cdetails\u003e\n\n\u003csummary\u003eAvailable standalone functions\u003c/summary\u003e\n\n- [`accessControlCreate`](docs/sdks/accesscontrol/README.md#create) - Create a signing key\n- [`accessControlDelete`](docs/sdks/accesscontrol/README.md#delete) - Delete Signing Key\n- [`accessControlGet`](docs/sdks/accesscontrol/README.md#get) - Retrieves a signing key\n- [`accessControlGetAll`](docs/sdks/accesscontrol/README.md#getall) - Retrieves signing keys\n- [`accessControlUpdate`](docs/sdks/accesscontrol/README.md#update) - Update a signing key\n- [`assetCreate`](docs/sdks/asset/README.md#create) - Upload an asset\n- [`assetCreateViaUrl`](docs/sdks/asset/README.md#createviaurl) - Upload asset via URL\n- [`assetDelete`](docs/sdks/asset/README.md#delete) - Delete an asset\n- [`assetGet`](docs/sdks/asset/README.md#get) - Retrieves an asset\n- [`assetGetAll`](docs/sdks/asset/README.md#getall) - Retrieve assets\n- [`assetUpdate`](docs/sdks/asset/README.md#update) - Patch an asset\n- [`generateAudioToText`](docs/sdks/generate/README.md#audiototext) - Audio To Text\n- [`generateImageToImage`](docs/sdks/generate/README.md#imagetoimage) - Image To Image\n- [`generateImageToVideo`](docs/sdks/generate/README.md#imagetovideo) - Image To Video\n- [`generateLlm`](docs/sdks/generate/README.md#llm) - LLM\n- [`generateSegmentAnything2`](docs/sdks/generate/README.md#segmentanything2) - Segment Anything 2\n- [`generateTextToImage`](docs/sdks/generate/README.md#texttoimage) - Text To Image\n- [`generateUpscale`](docs/sdks/generate/README.md#upscale) - Upscale\n- [`metricsGetCreatorViewership`](docs/sdks/metrics/README.md#getcreatorviewership) - Query creator viewership metrics\n- [`metricsGetPublicViewership`](docs/sdks/metrics/README.md#getpublicviewership) - Query public total views metrics\n- [`metricsGetRealtimeViewership`](docs/sdks/metrics/README.md#getrealtimeviewership) - Query realtime viewership\n- [`metricsGetUsage`](docs/sdks/metrics/README.md#getusage) - Query usage metrics\n- [`metricsGetViewership`](docs/sdks/metrics/README.md#getviewership) - Query viewership metrics\n- [`multistreamCreate`](docs/sdks/multistream/README.md#create) - Create a multistream target\n- [`multistreamDelete`](docs/sdks/multistream/README.md#delete) - Delete a multistream target\n- [`multistreamGet`](docs/sdks/multistream/README.md#get) - Retrieve a multistream target\n- [`multistreamGetAll`](docs/sdks/multistream/README.md#getall) - Retrieve Multistream Targets\n- [`multistreamUpdate`](docs/sdks/multistream/README.md#update) - Update Multistream Target\n- [`playbackGet`](docs/sdks/playback/README.md#get) - Retrieve Playback Info\n- [`sessionGet`](docs/sdks/session/README.md#get) - Retrieve a session\n- [`sessionGetAll`](docs/sdks/session/README.md#getall) - Retrieve sessions\n- [`sessionGetClips`](docs/sdks/session/README.md#getclips) - Retrieve clips of a session\n- [`sessionGetRecorded`](docs/sdks/session/README.md#getrecorded) - Retrieve Recorded Sessions\n- [`streamAddMultistreamTarget`](docs/sdks/stream/README.md#addmultistreamtarget) - Add a multistream target\n- [`streamCreate`](docs/sdks/stream/README.md#create) - Create a stream\n- [`streamCreateClip`](docs/sdks/stream/README.md#createclip) - Create a clip\n- [`streamDelete`](docs/sdks/stream/README.md#delete) - Delete a stream\n- [`streamGet`](docs/sdks/stream/README.md#get) - Retrieve a stream\n- [`streamGetAll`](docs/sdks/stream/README.md#getall) - Retrieve streams\n- [`streamGetClips`](docs/sdks/stream/README.md#getclips) - Retrieve clips of a livestream\n- [`streamRemoveMultistreamTarget`](docs/sdks/stream/README.md#removemultistreamtarget) - Remove a multistream target\n- [`streamStartPull`](docs/sdks/stream/README.md#startpull) - Start ingest for a pull stream\n- [`streamTerminate`](docs/sdks/stream/README.md#terminate) - Terminates a live stream\n- [`streamUpdate`](docs/sdks/stream/README.md#update) - Update a stream\n- [`taskGet`](docs/sdks/task/README.md#get) - Retrieve a Task\n- [`taskGetAll`](docs/sdks/task/README.md#getall) - Retrieve Tasks\n- [`transcodeCreate`](docs/sdks/transcode/README.md#create) - Transcode a video\n- [`webhookCreate`](docs/sdks/webhook/README.md#create) - Create a webhook\n- [`webhookDelete`](docs/sdks/webhook/README.md#delete) - Delete a webhook\n- [`webhookGet`](docs/sdks/webhook/README.md#get) - Retrieve a webhook\n- [`webhookGetAll`](docs/sdks/webhook/README.md#getall) - Retrieve a Webhook\n- [`webhookGetLog`](docs/sdks/webhook/README.md#getlog) - Retrieve a webhook log\n- [`webhookGetLogs`](docs/sdks/webhook/README.md#getlogs) - Retrieve webhook logs\n- [`webhookResendLog`](docs/sdks/webhook/README.md#resendlog) - Resend a webhook\n- [`webhookUpdate`](docs/sdks/webhook/README.md#update) - Update a webhook\n- ~~[`roomCreate`](docs/sdks/room/README.md#create)~~ - Create a room :warning: **Deprecated**\n- ~~[`roomCreateUser`](docs/sdks/room/README.md#createuser)~~ - Create a room user :warning: **Deprecated**\n- ~~[`roomDelete`](docs/sdks/room/README.md#delete)~~ - Delete a room :warning: **Deprecated**\n- ~~[`roomDeleteUser`](docs/sdks/room/README.md#deleteuser)~~ - Remove a user from the room :warning: **Deprecated**\n- ~~[`roomGet`](docs/sdks/room/README.md#get)~~ - Retrieve a room :warning: **Deprecated**\n- ~~[`roomGetUser`](docs/sdks/room/README.md#getuser)~~ - Get user details :warning: **Deprecated**\n- ~~[`roomStartEgress`](docs/sdks/room/README.md#startegress)~~ - Start room RTMP egress :warning: **Deprecated**\n- ~~[`roomStopEgress`](docs/sdks/room/README.md#stopegress)~~ - Stop room RTMP egress :warning: **Deprecated**\n- ~~[`roomUpdateUser`](docs/sdks/room/README.md#updateuser)~~ - Update a room user :warning: **Deprecated**\n\n\u003c/details\u003e\n\u003c!-- End Standalone functions [standalone-funcs] --\u003e\n\n\u003c!-- Start File uploads [file-upload] --\u003e\n## File uploads\n\nCertain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.\n\n\u003e [!TIP]\n\u003e\n\u003e Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:\n\u003e\n\u003e - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).\n\u003e - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.\n\u003e - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `\u003cinput type=\"file\"\u003e` element.\n\u003e - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).\n\n```typescript\nimport { Livepeer } from \"livepeer\";\nimport { openAsBlob } from \"node:fs\";\n\nconst livepeer = new Livepeer({\n  apiKey: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  const result = await livepeer.generate.imageToImage({\n    image: await openAsBlob(\"example.file\"),\n    prompt: \"\u003cvalue\u003e\",\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();\n\n```\n\u003c!-- End File uploads [file-upload] --\u003e\n\n\u003c!-- Start Retries [retries] --\u003e\n## Retries\n\nSome of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a retryConfig object to the call:\n```typescript\nimport { Livepeer } from \"livepeer\";\nimport {\n  Profile,\n  TranscodeProfileEncoder,\n  TranscodeProfileProfile,\n  Type,\n} from \"livepeer/models/components\";\n\nconst livepeer = new Livepeer({\n  apiKey: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  const result = await livepeer.stream.create({\n    name: \"test_stream\",\n    pull: {\n      source: \"https://myservice.com/live/stream.flv\",\n      headers: {\n        \"Authorization\": \"Bearer 123\",\n      },\n      location: {\n        lat: 39.739,\n        lon: -104.988,\n      },\n    },\n    playbackPolicy: {\n      type: Type.Webhook,\n      webhookId: \"1bde4o2i6xycudoy\",\n      webhookContext: {\n        \"streamerId\": \"my-custom-id\",\n      },\n      refreshInterval: 600,\n    },\n    profiles: [\n      {\n        width: 1280,\n        name: \"720p\",\n        height: 720,\n        bitrate: 3000000,\n        fps: 30,\n        fpsDen: 1,\n        quality: 23,\n        gop: \"2\",\n        profile: Profile.H264Baseline,\n      },\n    ],\n    record: false,\n    recordingSpec: {\n      profiles: [\n        {\n          width: 1280,\n          name: \"720p\",\n          height: 720,\n          bitrate: 3000000,\n          quality: 23,\n          fps: 30,\n          fpsDen: 1,\n          gop: \"2\",\n          profile: TranscodeProfileProfile.H264Baseline,\n          encoder: TranscodeProfileEncoder.H264,\n        },\n      ],\n    },\n    multistream: {\n      targets: [\n        {\n          profile: \"720p0\",\n          videoOnly: false,\n          id: \"PUSH123\",\n          spec: {\n            name: \"My target\",\n            url: \"rtmps://live.my-service.tv/channel/secretKey\",\n          },\n        },\n      ],\n    },\n  }, {\n    retries: {\n      strategy: \"backoff\",\n      backoff: {\n        initialInterval: 1,\n        maxInterval: 50,\n        exponent: 1.1,\n        maxElapsedTime: 100,\n      },\n      retryConnectionErrors: false,\n    },\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:\n```typescript\nimport { Livepeer } from \"livepeer\";\nimport {\n  Profile,\n  TranscodeProfileEncoder,\n  TranscodeProfileProfile,\n  Type,\n} from \"livepeer/models/components\";\n\nconst livepeer = new Livepeer({\n  retryConfig: {\n    strategy: \"backoff\",\n    backoff: {\n      initialInterval: 1,\n      maxInterval: 50,\n      exponent: 1.1,\n      maxElapsedTime: 100,\n    },\n    retryConnectionErrors: false,\n  },\n  apiKey: \"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n});\n\nasync function run() {\n  const result = await livepeer.stream.create({\n    name: \"test_stream\",\n    pull: {\n      source: \"https://myservice.com/live/stream.flv\",\n      headers: {\n        \"Authorization\": \"Bearer 123\",\n      },\n      location: {\n        lat: 39.739,\n        lon: -104.988,\n      },\n    },\n    playbackPolicy: {\n      type: Type.Webhook,\n      webhookId: \"1bde4o2i6xycudoy\",\n      webhookContext: {\n        \"streamerId\": \"my-custom-id\",\n      },\n      refreshInterval: 600,\n    },\n    profiles: [\n      {\n        width: 1280,\n        name: \"720p\",\n        height: 720,\n        bitrate: 3000000,\n        fps: 30,\n        fpsDen: 1,\n        quality: 23,\n        gop: \"2\",\n        profile: Profile.H264Baseline,\n      },\n    ],\n    record: false,\n    recordingSpec: {\n      profiles: [\n        {\n          width: 1280,\n          name: \"720p\",\n          height: 720,\n          bitrate: 3000000,\n          quality: 23,\n          fps: 30,\n          fpsDen: 1,\n          gop: \"2\",\n          profile: TranscodeProfileProfile.H264Baseline,\n          encoder: TranscodeProfileEncoder.H264,\n        },\n      ],\n    },\n    multistream: {\n      targets: [\n        {\n          profile: \"720p0\",\n          videoOnly: false,\n          id: \"PUSH123\",\n          spec: {\n            name: \"My target\",\n            url: \"rtmps://live.my-service.tv/channel/secretKey\",\n          },\n        },\n      ],\n    },\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();\n\n```\n\u003c!-- End Retries [retries] --\u003e\n\n\u003c!-- Start Debugging [debug] --\u003e\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass a logger that matches `console`'s interface as an SDK option.\n\n\u003e [!WARNING]\n\u003e Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.\n\n```typescript\nimport { Livepeer } from \"livepeer\";\n\nconst sdk = new Livepeer({ debugLogger: console });\n```\n\u003c!-- End Debugging [debug] --\u003e\n\n\u003c!-- Placeholder for Future Speakeasy SDK Sections --\u003e\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivepeer%2Flivepeer-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flivepeer%2Flivepeer-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivepeer%2Flivepeer-js/lists"}