Skip to content

Latest commit

 

History

History
100 lines (74 loc) · 2.53 KB

README.md

File metadata and controls

100 lines (74 loc) · 2.53 KB
Raw

Oven Media Engine TypeScript SDK

This SDK provides a TypeScript interface for seamlessly interacting with the Oven Media Engine (OME) REST API.

Installation

Use NPM to install the SDK:

npm install ovenmediaengine-ts-sdk

Usage

  1. Initialization

Import the SDK and initialize it with your OME server's base URL.

import OvenMediaEngineSDK from 'ovenmediaengine-ts-sdk';

const omeSDK = new OvenMediaEngineSDK({ baseURL: 'http://your-ome-server-address:port' });
  1. Authentication
omeSDK.setAuthorization('your_access_token');
  1. Version
omeSDK.setVersion('v1');
  1. Making API Calls

Use the provided methods from the SDK to make calls to the API.

// Example: Fetch the list of Virtual Host
omeSDK.getVirtualHosts().then(response => {
    console.log(response.data);
}).catch(error => {
    console.error("Error fetching Virtual Host:", error);
});

Available Methods

  • getVirtualHosts Get Virtual Host List
  • createVirtualHost Create Virtual Host
  • getVirtualHost Get Virtual Host Information
  • deleteVirtualHost Delete Virtual Host
  • reloadAllCertificates Reload All Certificates
  • reloadAllCertificate Reload Certificate
  • getApps Get Application List
  • createApp Create Application
  • getApp Get Application Information
  • patchApp Patch Application Information
  • deleteApp Delete Application
  • getOutputProfiles Get Output Profile List
  • createOutputProfile Create Output Profile
  • getOutputProfile Get Output Profile Information
  • deleteOutputProfile Delete Output Profile
  • startRecording Start Recording
  • stopRecording Stop Recording
  • getRecordingState Get Recording State
  • startPushPublishing Start Push Publishing
  • stopPushPublishing Stop Push Publishing
  • getPushPublishingState Get Push Publishing State
  • getStreams Get Stream List
  • createStream Create Stream (Pull)
  • getStream Get Stream Info
  • deleteStream Delete Stream
  • sendEvent Send Event
  • startDump Start Dump
  • stopDump Stop Dump
  • getVirtualHostStatistics Get Statistics of Virtual Host
  • getApplicationStatistics Get Statistics of Application
  • getStreamStatistics Get Statistics of Stream

[Add further methods here as they get added to the SDK.]

Development

To test the SDK during development, use:

npm run dev

This will run the sample script located in the samples folder.

Contributions

Contributions are welcome! Please create an issue or pull request for any suggestions or improvements.

License