@w3stream/nodejs-client v1.0.8

W3Stream is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Project description

W3Stream's Node.js is a lightweight client built in TypeScript that streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

Getting started

Installation

With npm:

npm install @w3stream/nodejs-client

...or with yarn:

yarn add @w3stream/nodejs-client

Code sample

import W3StreamClient from "@w3stream/nodejs-client";
 
(async () => {
  try {
    const client = new W3StreamClient({
      publicKey: "YOUR_PUBLIC_KEY",
      secretKey: "YOUR_SECRET_KEY",
    });
    const videoCreationPayload = {
      title: "First video", // The title of your new video.
      description: "A new video.", // A brief description of your video.
    };
 
    const video = await client.video.create(videoCreationPayload);
    if (!video.data) {
      throw new Error("Failed to create video");
    }
    if (!video.data.id) {
      throw new Error("Failed to create video");
    }
    // Option 1: Use client upload with videoId
    // await client.uploadVideo(video.data.id, "./path/to/video.mp4");
    // console.log("Upload successfully");
    // Option 2: Upload parts yourself
    const uploadResult = await client.video.uploadPart(
      video.data.id,
      "./path/to/video.mp4",
    );
    console.log(uploadResult);
 
    const checkResult = await client.video.uploadVideoComplete(video.data.id);
    // Check if the video upload is complete
    console.log(checkResult);
  } catch (e) {
    console.error(e);
  }
})();

Documentation

API endpoints

ApiKeyApi

LiveStreamApi

PlayersApi

PlaylistApi

VideoApi

VideoChapterApi

WebhookApi

Models

• AddPlayerThemesToVideoRequest
• AddVideoToPlaylistRequest
• ApiKey
• Asset
• Controls
• CreateApiKeyData
• CreateApiKeyRequest
• CreateApiKeyResponse
• CreateLiveStreamKeyRequest
• CreateLiveStreamKeyResponse
• CreatePlayerThemeRequest
• CreatePlayerThemesData
• CreatePlayerThemesResponse
• CreatePlaylistData
• CreatePlaylistRequest
• CreatePlaylistResponse
• CreateStreamingRequest
• CreateStreamingResponse
• CreateVideoCaptionData
• CreateVideoCaptionResponse
• CreateVideoChapterData
• CreateVideoChapterResponse
• CreateVideoRequest
• CreateVideoResponse
• CreateWebhookData
• CreateWebhookRequest
• CreateWebhookResponse
• GetApiKeysData
• GetApiKeysResponse
• GetLiveStreamKeyData
• GetLiveStreamKeyResponse
• GetLiveStreamKeysListData
• GetLiveStreamKeysListResponse
• GetLiveStreamVideoPublicResponse
• GetLiveStreamVideoResponse
• GetLiveStreamVideosRequest
• GetLiveStreamVideosResponse
• GetPlayerThemeByIdData
• GetPlayerThemeByIdResponse
• GetPlayerThemeData
• GetPlayerThemeResponse
• GetPlaylistByIdData
• GetPlaylistByIdResponse
• GetPlaylistListData
• GetPlaylistListRequest
• GetPlaylistListResponse
• GetStreamingResponse
• GetStreamingsResponse
• GetTranscodeCostData
• GetTranscodeCostResponse
• GetUserWebhookData
• GetUserWebhookResponse
• GetVideoCaptionsData
• GetVideoCaptionsResponse
• GetVideoChaptersData
• GetVideoChaptersResponse
• GetVideoDetailResponse
• GetVideoListData
• GetVideoListRequest
• GetVideoListResponse
• GetVideoPlayerInfoResponse
• GetWebhooksListData
• GetWebhooksListResponse
• LiveStreamAssets
• LiveStreamKeyData
• LiveStreamVideoData
• LiveStreamVideoResponse
• LiveStreamVideosResponse
• Metadata
• MoveVideoInPlaylistRequest
• PlayerTheme
• Playlist
• PlaylistItem
• PlaylistItemVideo
• PublicPlaylistObject
• QualityObject
• RemovePlayerThemesFromVideoRequest
• RenameAPIKeyRequest
• ResponseError
• ResponseSuccess
• Theme
• UpdateLiveStreamKeyData
• UpdateLiveStreamKeyRequest
• UpdateLiveStreamKeyResponse
• UpdateLiveStreamVideoRequest
• UpdatePlayerThemeRequest
• UpdatePlayerThemeResponse
• UpdateVideoInfoRequest
• UpdateWebhookRequest
• UploadLogoByIdResponse
• Video
• VideoAssets
• VideoCaption
• VideoChapter
• VideoWatermark
• Webhook

Rate Limiting

W3Stream implements rate limiting to ensure fair usage and stability of the service. The API provides the rate limit values in the response headers for any API requests you make. In this Node.js client, you can access these headers by using the *WithResponseHeaders() versions of the methods. These methods return both the response body and the headers, allowing you to check the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Retry-After headers to understand your current rate limit status.

Here is an example of how to use these methods:

const client = new W3StreamClient({
  secretKey: "YOUR_SECRET_KEY",
  publicKey: "YOUR_PUBLIC_KEY"
});

const { headers, body } = const webhook = await client.webhook.listWithResponseHeaders();

Authorization

API key and public key

All endpoints required to be authenticated using the API key and public key mechanism described in our documentation.

All you have to do is provide an API key and public key when instantiating the W3StreamClient:

const client = new W3StreamClient({
  secretKey: "YOUR_SECRET_KEY",
  publicKey: "YOUR_PUBLIC_KEY"
});

Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!