Skip to content

Commit 7b3dafe

Browse files
author
SDK Gen Bot
committed
Version 0.1.0
1 parent 02351c5 commit 7b3dafe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+3214
-1
lines changed

‎.github/workflows/npm-publish.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Node.js Package to npm
2+
3+
# trigger when a release is created
4+
on:
5+
workflow_dispatch:
6+
push:
7+
tags:
8+
- "*.*.*"
9+
10+
jobs:
11+
publish-npm:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v3
15+
- uses: actions/setup-node@v3
16+
with:
17+
node-version: 14
18+
registry-url: https://registry.npmjs.org/
19+
- run: |
20+
npm install
21+
npm run build
22+
npm run prepare:dist
23+
cd ./dist
24+
npm publish --access public
25+
env:
26+
NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
wwwroot/*.js
2+
node_modules
3+
typings
4+
dist
5+
.idea

‎.openapi-generator-ignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# OpenAPI Generator Ignore
2+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md

‎.openapi-generator/FILES

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.github/workflows/npm-publish.yml
2+
.gitignore
3+
.openapi-generator-ignore
4+
API_VERSION
5+
ErrorWrappedResponse.md
6+
LICENSE.md
7+
LiveStreamApi.md
8+
LiveStreamCreatePayload.md
9+
LiveStreamInputCreatePayload.md
10+
LiveStreamInputResponse.md
11+
LiveStreamOutputCreatePayload.md
12+
LiveStreamOutputResponse.md
13+
LiveStreamOutputUpdatePayload.md
14+
LiveStreamOutputWrappedResponse.md
15+
LiveStreamOutputsWrappedResponse.md
16+
LiveStreamResponse.md
17+
LiveStreamUpdatePayload.md
18+
LiveStreamWrappedResponse.md
19+
LiveStreamsWrappedResponse.md
20+
MessageWrappedResponse.md
21+
MessageWrappedResponseData.md
22+
README.md
23+
README.md
24+
TEMPLATE_VERSION
25+
VERSION
26+
api.ts
27+
api/apis.ts
28+
api/liveStreamApi.ts
29+
git_push.sh
30+
model/errorWrappedResponse.ts
31+
model/liveStreamCreatePayload.ts
32+
model/liveStreamInputCreatePayload.ts
33+
model/liveStreamInputResponse.ts
34+
model/liveStreamOutputCreatePayload.ts
35+
model/liveStreamOutputResponse.ts
36+
model/liveStreamOutputUpdatePayload.ts
37+
model/liveStreamOutputWrappedResponse.ts
38+
model/liveStreamOutputsWrappedResponse.ts
39+
model/liveStreamResponse.ts
40+
model/liveStreamUpdatePayload.ts
41+
model/liveStreamWrappedResponse.ts
42+
model/liveStreamsWrappedResponse.ts
43+
model/messageWrappedResponse.ts
44+
model/messageWrappedResponseData.ts
45+
model/models.ts
46+
package.json
47+
tsconfig.json

‎.openapi-generator/VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
6.0.1-SNAPSHOT

‎API_VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.1.9

‎CHANGELOG.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
## [0.1.0](https://github.com/cloudinary/video-live-streaming-js/compare/0.0.0...0.1.0) (08-10-2024)
4+
5+
6+
### ⚠ BREAKING CHANGES
7+
8+
* Fix Typescript Node string enums
9+
* Add support for multiple API level schemas
10+
11+
12+
### Features
13+
14+
* Add node deployment
15+
* Add support for multiple API level schemas
16+
17+
18+
### Bug Fixes
19+
20+
* Add video live streaming API schema
21+
* Fix node build
22+
* Fix node build
23+
* Fix node build script name
24+
* Fix node publish job
25+
* Fix node package.json
26+
* Fix node job publish
27+
* Fix docs templates
28+
* Fix Typescript Node string enums

‎LICENSE ‎LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 Cloudinary
3+
Copyright (c) 2020 Cloudinary
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Cloudinary Video Live Streaming (Beta)
2+
3+
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](https://cloudinary.com/documentation/video_live_streaming) for information on how to use the Live Streaming API to stream video to your users.
4+
5+
**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](https://support.cloudinary.com/hc/en-us/requests/new).
6+
7+
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](https://console.cloudinary.com/pm)).
8+
9+
10+
### API Endpoints
11+
12+
All URIs are relative to *https://api.cloudinary.com/v2/CLOUD_NAME/video*
13+
14+
| Class | Method | HTTP request | Description |
15+
| ------------ | ------------- | ------------- | ------------- |
16+
*LiveStreamApi* | [**activateLiveStream**](LiveStreamApi.md#activateLiveStream) | **POST** /live_streams/{liveStreamId}/activate | Manually activate a live stream
17+
*LiveStreamApi* | [**createLiveStream**](LiveStreamApi.md#createLiveStream) | **POST** /live_streams | Create a new live stream
18+
*LiveStreamApi* | [**createLiveStreamOutput**](LiveStreamApi.md#createLiveStreamOutput) | **POST** /live_streams/{liveStreamId}/outputs | Create a new live stream output
19+
*LiveStreamApi* | [**deleteLiveStream**](LiveStreamApi.md#deleteLiveStream) | **DELETE** /live_streams/{liveStreamId} | Delete a live stream
20+
*LiveStreamApi* | [**deleteLiveStreamOutput**](LiveStreamApi.md#deleteLiveStreamOutput) | **DELETE** /live_streams/{liveStreamId}/outputs/{liveStreamOutputId} | Delete a live stream output
21+
*LiveStreamApi* | [**getLiveStream**](LiveStreamApi.md#getLiveStream) | **GET** /live_streams/{liveStreamId} | Get a single live stream
22+
*LiveStreamApi* | [**getLiveStreamOutput**](LiveStreamApi.md#getLiveStreamOutput) | **GET** /live_streams/{liveStreamId}/outputs/{liveStreamOutputId} | Get a single live stream output
23+
*LiveStreamApi* | [**getLiveStreamOutputs**](LiveStreamApi.md#getLiveStreamOutputs) | **GET** /live_streams/{liveStreamId}/outputs | Get a list of live stream outputs
24+
*LiveStreamApi* | [**getLiveStreams**](LiveStreamApi.md#getLiveStreams) | **GET** /live_streams | Get a list of live streams
25+
*LiveStreamApi* | [**idleLiveStream**](LiveStreamApi.md#idleLiveStream) | **POST** /live_streams/{liveStreamId}/idle | Manually idle a live stream
26+
*LiveStreamApi* | [**updateLiveStream**](LiveStreamApi.md#updateLiveStream) | **PATCH** /live_streams/{liveStreamId} | Update a live stream
27+
*LiveStreamApi* | [**updateLiveStreamOutput**](LiveStreamApi.md#updateLiveStreamOutput) | **PATCH** /live_streams/{liveStreamId}/outputs/{liveStreamOutputId} | Update a live stream output
28+
29+
30+
### Models
31+
32+
- [ErrorWrappedResponse](ErrorWrappedResponse.md)
33+
- [LiveStreamCreatePayload](LiveStreamCreatePayload.md)
34+
- [LiveStreamInputCreatePayload](LiveStreamInputCreatePayload.md)
35+
- [LiveStreamInputResponse](LiveStreamInputResponse.md)
36+
- [LiveStreamOutputCreatePayload](LiveStreamOutputCreatePayload.md)
37+
- [LiveStreamOutputResponse](LiveStreamOutputResponse.md)
38+
- [LiveStreamOutputUpdatePayload](LiveStreamOutputUpdatePayload.md)
39+
- [LiveStreamOutputWrappedResponse](LiveStreamOutputWrappedResponse.md)
40+
- [LiveStreamOutputsWrappedResponse](LiveStreamOutputsWrappedResponse.md)
41+
- [LiveStreamResponse](LiveStreamResponse.md)
42+
- [LiveStreamUpdatePayload](LiveStreamUpdatePayload.md)
43+
- [LiveStreamWrappedResponse](LiveStreamWrappedResponse.md)
44+
- [LiveStreamsWrappedResponse](LiveStreamsWrappedResponse.md)
45+
- [MessageWrappedResponse](MessageWrappedResponse.md)
46+
- [MessageWrappedResponseData](MessageWrappedResponseData.md)
47+
48+
49+
## Installation
50+
```bash
51+
npm install @cloudinary/video-live-streaming
52+
```
53+
54+
## Get Help
55+
If you run into an issue or have a question, you can either:
56+
- Issues related to the SDK: [Open a Github issue](https://github.com/cloudinary/media-editing-js/issues)
57+
- Issues related to your account: [Open a support ticket](https://cloudinary.com/contact)
58+
59+
## Additional Resources
60+
- [Cloudinary Transformation and REST API References](https://cloudinary.com/documentation/cloudinary_references): Comprehensive references, including syntax and examples for all SDKs.
61+
- [MediaJams.dev](https://mediajams.dev/): Bite-size use-case tutorials written by and for Cloudinary Developers
62+
- [DevJams](https://www.youtube.com/playlist?list=PL8dVGjLA2oMr09amgERARsZyrOz_sPvqw): Cloudinary developer podcasts on YouTube.
63+
- [Cloudinary Academy](https://training.cloudinary.com/): Free self-paced courses, instructor-led virtual courses, and on-site courses.
64+
- [Code Explorers and Feature Demos](https://cloudinary.com/documentation/code_explorers_demos_index): A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.
65+
- [Cloudinary Roadmap](https://cloudinary.com/roadmap): Your chance to follow, vote, or suggest what Cloudinary should develop next.
66+
- [Cloudinary Facebook Community](https://www.facebook.com/groups/CloudinaryCommunity): Learn from and offer help to other Cloudinary developers.
67+
- [Cloudinary Account Registration](https://cloudinary.com/users/register/free): Free Cloudinary account registration.
68+
- [Cloudinary Website](https://cloudinary.com)
69+
70+
71+
## Licence
72+
Released under the MIT license.

‎TEMPLATE_VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.2.0

‎VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.1.0

‎api.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// This is the entrypoint for the package
2+
export * from './api/apis';
3+
export * from './model/models';

‎api/apis.ts

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
export * from './liveStreamApi';
2+
import { LiveStreamApi } from './liveStreamApi';
3+
import * as http from 'http';
4+
5+
export class HttpError extends Error {
6+
constructor (public response: http.IncomingMessage, public body: any, public statusCode?: number) {
7+
super('HTTP request failed');
8+
this.name = 'HttpError';
9+
}
10+
}
11+
12+
export { RequestFile } from '../model/models';
13+
14+
export const APIS = [LiveStreamApi];
15+
16+
export interface ICloudinaryUrlConfig {
17+
cloudinaryUrl?: string;
18+
basePath?: string;
19+
}
20+
21+
export interface IConfig {
22+
userName: string;
23+
password: string;
24+
basePath?: string;
25+
}

0 commit comments

Comments
 (0)