Skip to content

cloudinary/video-live-streaming-js

Repository files navigation

Cloudinary Video Live Streaming (Beta)

Use the Video Live Streaming API to create and manage your RTMP live streams. This includes managing outputs as well as manually starting and stopping streams. See the live streaming guide for information on how to use the Live Streaming API to stream video to your users.

Note: The Live Streaming API is currently in development and is available as a Public Beta, which means we value your feedback, so please feel free to share any thoughts with us.

The API supports Basic Authentication using your Cloudinary API Key and API Secret (which can be found on the Dashboard page of your Cloudinary Console).

API Endpoints

All URIs are relative to https://api.cloudinary.com/v2/CLOUD_NAME/video

Class Method HTTP request Description
LiveStreamApi activateLiveStream POST /live_streams/{liveStreamId}/activate Manually activate a live stream
LiveStreamApi createLiveStream POST /live_streams Create a new live stream
LiveStreamApi createLiveStreamOutput POST /live_streams/{liveStreamId}/outputs Create a new live stream output
LiveStreamApi deleteLiveStream DELETE /live_streams/{liveStreamId} Delete a live stream
LiveStreamApi deleteLiveStreamOutput DELETE /live_streams/{liveStreamId}/outputs/{liveStreamOutputId} Delete a live stream output
LiveStreamApi getLiveStream GET /live_streams/{liveStreamId} Get a single live stream
LiveStreamApi getLiveStreamOutput GET /live_streams/{liveStreamId}/outputs/{liveStreamOutputId} Get a single live stream output
LiveStreamApi getLiveStreamOutputs GET /live_streams/{liveStreamId}/outputs Get a list of live stream outputs
LiveStreamApi getLiveStreams GET /live_streams Get a list of live streams
LiveStreamApi idleLiveStream POST /live_streams/{liveStreamId}/idle Manually idle a live stream
LiveStreamApi updateLiveStream PATCH /live_streams/{liveStreamId} Update a live stream
LiveStreamApi updateLiveStreamOutput PATCH /live_streams/{liveStreamId}/outputs/{liveStreamOutputId} Update a live stream output

Models

Installation

npm install @cloudinary/video-live-streaming

Get Help

If you run into an issue or have a question, you can either:

Additional Resources

Licence

Released under the MIT license.

About

Cloudinary Video Live Streaming NodeJS SDK

Resources

License

Stars

Watchers

Forks

Packages

No packages published