Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rixl/videosdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

RIXL Video SDK

The RIXL Video SDK enables you to build custom media experiences with RIXL's core technology through a highly optimized TypeScript library.

Library provides utilities for fetching and managing images, videos, and feed content. It serves as the foundation for the React components in @rixl/videosdk-react but can also be used independently in any JavaScript/TypeScript project.

Use of this SDK is subject to our Terms of Use.

Installation

In your project, install the Video SDK:

npm install @rixl/videosdk
# or
pnpm add @rixl/videosdk
# or
bun add @rixl/videosdk

Media Fetching

Function	Description
`getImage(imageId)`	Fetches image data by ID
`getVideo(videoId)`	Fetches video data by ID
`getFeedPost(feedId, postId)`	Fetches a single post from a feed
`getFeedPosts(feedId, offset?, limit?)`	Fetches paginated posts from a feed

Usage:

// Fetch image data
const imageData = await getImage('image-id');

// Fetch video data
const videoData = await getVideo('video-id');

// Fetch a single post from a feed
const post = await getFeedPost('feed-id', 'post-id');

// Fetch paginated posts from a feed
const posts = await getFeedPosts('feed-id', 0, 10);

TypeScript Types

The library exports the following TypeScript types:

Type	Description
`ImageData`	Image metadata and URLs
`VideoData`	Video metadata, URLs, and playback information
`FeedPost`	Feed post content and metadata
`FeedPostsResponse`	Paginated response for feed posts
`FileStatus`	Status of a media file
`FileData`	Generic file metadata

API Reference

All data is fetched from https://api.rixl.com.

REST Endpoints

Endpoint	Description
`GET /images/{imageId}`	Fetch image metadata and URLs
`GET /videos/{videoId}`	Fetch video metadata and playback information
`GET /feeds/{feedId}/posts?offset=...&limit=...`	Fetch paginated feed posts
`GET /feeds/{feedId}/posts/{postId}`	Fetch a specific feed post
`GET /feeds/{feedId}/creators/{creatorId}?offset=...&limit=...`	Fetch posts by a specific creator

Need Help?

If you're looking for help, try our Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.