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 |

Documentation

For complete documentation, tutorials, and examples, visit our SDK Documentation.

Need Help?

• Developer Support
• Developer Forum
• Premier Developer Support (priority support)