agora-cloud-recording-api-client
TypeScript icon, indicating that this package has built-in type declarations

0.0.9 • Public • Published

Agora Cloud Recording API client

Typescript-based client for Node.js runtime to access Agora Cloud Recording REST API

Documentation to the REST API: https://docs.agora.io/en/cloud-recording/restfulapi/#/Cloud%20Recording/start

Cloud Recording documentation: https://docs.agora.io/en/cloud-recording/product_cloud_recording?platform=RESTful

Generated using openapitools/openapi-generator-cli:

openapi-generator generate -i swagger.yaml --generator-name typescript-fetch -o gen/api

And extended to reflect web page recording mode

How to use:


    OpenAPI.USERNAME = process.env.AGORA_RESTAPI_USERNAME;
    OpenAPI.PASSWORD = process.env.AGORA_RESTAPI_PASSWORD;
    ...
    const startBody = {
        ...
    }
    ...
    const startResponse: start_response = await CloudRecordingService.start(
        AgoraAppId,
        resourceId,
        'web',
        startBody,
      );

Postman collection: https://documenter.getpostman.com/view/6319646/SVSLr9AM#9743f8ce-ef00-412e-9f37-3c61689f973f

Readme

Keywords

none

Package Sidebar

Install

npm i agora-cloud-recording-api-client

Weekly Downloads

1

Version

0.0.9

License

ISC

Unpacked Size

101 kB

Total Files

62

Last publish

Collaborators

  • dreamteammobile