Skip to content

Commit

Permalink
Version 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
SDK Gen Bot committed Oct 8, 2024
1 parent 02351c5 commit 7b3dafe
Show file tree
Hide file tree
Showing 49 changed files with 3,214 additions and 1 deletion.
26 changes: 26 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Node.js Package to npm

# trigger when a release is created
on:
workflow_dispatch:
push:
tags:
- "*.*.*"

jobs:
publish-npm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 14
registry-url: https://registry.npmjs.org/
- run: |
npm install
npm run build
npm run prepare:dist
cd ./dist
npm publish --access public
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
wwwroot/*.js
node_modules
typings
dist
.idea
23 changes: 23 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
47 changes: 47 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.github/workflows/npm-publish.yml
.gitignore
.openapi-generator-ignore
API_VERSION
ErrorWrappedResponse.md
LICENSE.md
LiveStreamApi.md
LiveStreamCreatePayload.md
LiveStreamInputCreatePayload.md
LiveStreamInputResponse.md
LiveStreamOutputCreatePayload.md
LiveStreamOutputResponse.md
LiveStreamOutputUpdatePayload.md
LiveStreamOutputWrappedResponse.md
LiveStreamOutputsWrappedResponse.md
LiveStreamResponse.md
LiveStreamUpdatePayload.md
LiveStreamWrappedResponse.md
LiveStreamsWrappedResponse.md
MessageWrappedResponse.md
MessageWrappedResponseData.md
README.md
README.md
TEMPLATE_VERSION
VERSION
api.ts
api/apis.ts
api/liveStreamApi.ts
git_push.sh
model/errorWrappedResponse.ts
model/liveStreamCreatePayload.ts
model/liveStreamInputCreatePayload.ts
model/liveStreamInputResponse.ts
model/liveStreamOutputCreatePayload.ts
model/liveStreamOutputResponse.ts
model/liveStreamOutputUpdatePayload.ts
model/liveStreamOutputWrappedResponse.ts
model/liveStreamOutputsWrappedResponse.ts
model/liveStreamResponse.ts
model/liveStreamUpdatePayload.ts
model/liveStreamWrappedResponse.ts
model/liveStreamsWrappedResponse.ts
model/messageWrappedResponse.ts
model/messageWrappedResponseData.ts
model/models.ts
package.json
tsconfig.json
1 change: 1 addition & 0 deletions .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6.0.1-SNAPSHOT
1 change: 1 addition & 0 deletions API_VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.1.9
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Changelog

## [0.1.0](https://github.com/cloudinary/video-live-streaming-js/compare/0.0.0...0.1.0) (08-10-2024)


### ⚠ BREAKING CHANGES

* Fix Typescript Node string enums
* Add support for multiple API level schemas


### Features

* Add node deployment
* Add support for multiple API level schemas


### Bug Fixes

* Add video live streaming API schema
* Fix node build
* Fix node build
* Fix node build script name
* Fix node publish job
* Fix node package.json
* Fix node job publish
* Fix docs templates
* Fix Typescript Node string enums
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Cloudinary
Copyright (c) 2020 Cloudinary

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# 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](https://cloudinary.com/documentation/video_live_streaming) 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](https://support.cloudinary.com/hc/en-us/requests/new).

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)).


### API Endpoints

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

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


### Models

- [ErrorWrappedResponse](ErrorWrappedResponse.md)
- [LiveStreamCreatePayload](LiveStreamCreatePayload.md)
- [LiveStreamInputCreatePayload](LiveStreamInputCreatePayload.md)
- [LiveStreamInputResponse](LiveStreamInputResponse.md)
- [LiveStreamOutputCreatePayload](LiveStreamOutputCreatePayload.md)
- [LiveStreamOutputResponse](LiveStreamOutputResponse.md)
- [LiveStreamOutputUpdatePayload](LiveStreamOutputUpdatePayload.md)
- [LiveStreamOutputWrappedResponse](LiveStreamOutputWrappedResponse.md)
- [LiveStreamOutputsWrappedResponse](LiveStreamOutputsWrappedResponse.md)
- [LiveStreamResponse](LiveStreamResponse.md)
- [LiveStreamUpdatePayload](LiveStreamUpdatePayload.md)
- [LiveStreamWrappedResponse](LiveStreamWrappedResponse.md)
- [LiveStreamsWrappedResponse](LiveStreamsWrappedResponse.md)
- [MessageWrappedResponse](MessageWrappedResponse.md)
- [MessageWrappedResponseData](MessageWrappedResponseData.md)


## Installation
```bash
npm install @cloudinary/video-live-streaming
```

## Get Help
If you run into an issue or have a question, you can either:
- Issues related to the SDK: [Open a Github issue](https://github.com/cloudinary/media-editing-js/issues)
- Issues related to your account: [Open a support ticket](https://cloudinary.com/contact)

## Additional Resources
- [Cloudinary Transformation and REST API References](https://cloudinary.com/documentation/cloudinary_references): Comprehensive references, including syntax and examples for all SDKs.
- [MediaJams.dev](https://mediajams.dev/): Bite-size use-case tutorials written by and for Cloudinary Developers
- [DevJams](https://www.youtube.com/playlist?list=PL8dVGjLA2oMr09amgERARsZyrOz_sPvqw): Cloudinary developer podcasts on YouTube.
- [Cloudinary Academy](https://training.cloudinary.com/): Free self-paced courses, instructor-led virtual courses, and on-site courses.
- [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.
- [Cloudinary Roadmap](https://cloudinary.com/roadmap): Your chance to follow, vote, or suggest what Cloudinary should develop next.
- [Cloudinary Facebook Community](https://www.facebook.com/groups/CloudinaryCommunity): Learn from and offer help to other Cloudinary developers.
- [Cloudinary Account Registration](https://cloudinary.com/users/register/free): Free Cloudinary account registration.
- [Cloudinary Website](https://cloudinary.com)


## Licence
Released under the MIT license.
1 change: 1 addition & 0 deletions TEMPLATE_VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.2.0
1 change: 1 addition & 0 deletions VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.1.0
3 changes: 3 additions & 0 deletions api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// This is the entrypoint for the package
export * from './api/apis';
export * from './model/models';
25 changes: 25 additions & 0 deletions api/apis.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
export * from './liveStreamApi';
import { LiveStreamApi } from './liveStreamApi';
import * as http from 'http';

export class HttpError extends Error {
constructor (public response: http.IncomingMessage, public body: any, public statusCode?: number) {
super('HTTP request failed');
this.name = 'HttpError';
}
}

export { RequestFile } from '../model/models';

export const APIS = [LiveStreamApi];

export interface ICloudinaryUrlConfig {
cloudinaryUrl?: string;
basePath?: string;
}

export interface IConfig {
userName: string;
password: string;
basePath?: string;
}
Loading

0 comments on commit 7b3dafe

Please sign in to comment.