Git Product home page Git Product logo

agora-local-recording-javaweb-demo's Introduction

Agora-LocalRecording-JavaWeb-Demo

Build Status Version License

English | 中文

English

Installation

  1. Clone the project

    git clone https://github.com/your-username/your-project.git
    cd your-project
  2. Edit Configure

    Replace the configuration file src/main/resources/application.yml with your project values

     agora:
         domain: https://api.agora.io
         appid: your-app-id
         key: your-key
         secret: your-secret
         channel: your-channel
         uid: your-uid
         channelProfile: your-channel-profile
         appliteDir: /your/custom/path/to/AgoraRecord/bin
         recordFileRootDir: /your/custom/path/to/tmp
         lowUdpPort: your-low-udp-port
         highUdpPort: your-high-udp-port
         triggerMode: your-trigger-mode
         isAudioOnly: your-is-audio-only
         isVideoOnly: your-is-video-only
         streamType: your-stream-type
         autoSubscribe: your-auto-subscribe
  3. Compile

    mvn clean package
  4. Deploy

    java -jar target/your-project.jar &

Interface Description

Endpoint HTTP Method Request Type Request Body Response Status Codes Response Body
/record/getProp GET - None 200 - 5XX Default recording configuration information
/record/test GET - None 200 - 5XX "test ok"
/record/start POST JSON { "appId": "string", "channel": "string", "uid": "string" } 200 - 5XX "Recording started successfully" or Error message
/record/stop POST Query Parameter None 200 - 5XX "Recording stop successfully" or Error message
/record/help GET - None - Help message with available commands

中文

本地录制环境搭建参考: Agora 本地录制最全总结- 基于Java SDK

安装与运行

  1. 克隆项目到本地

    git clone https://github.com/your-username/your-project.git
    cd your-project
  2. 修改配置 将 src/main/resources/application.yml 文件中的以下配置替换为你的项目值

     agora:
         domain: https://api.agora.io
         appid: your-app-id
         key: your-key
         secret: your-secret
         channel: your-channel
         uid: your-uid
         channelProfile: your-channel-profile
         appliteDir: /your/custom/path/to/AgoraRecord/bin
         recordFileRootDir: /your/custom/path/to/tmp
         lowUdpPort: your-low-udp-port
         highUdpPort: your-high-udp-port
         triggerMode: your-trigger-mode
         isAudioOnly: your-is-audio-only
         isVideoOnly: your-is-video-only
         streamType: your-stream-type
         autoSubscribe: your-auto-subscribe
  3. 编译与打包

    mvn clean package
  4. 部署运行

    java -jar target/your-project.jar &

接口文档

Endpoint HTTP Method Request Type Request Body Response Status Codes Response Body
/record/getProp GET - None 200 - 5XX Default recording configuration information
/record/test GET - None 200 - 5XX "test ok"
/record/start POST JSON { "appId": "string", "channel": "string", "uid": "string" } 200 - 5XX "Recording started successfully" or Error message
/record/stop POST Query Parameter None 200 - 5XX "Recording stop successfully" or Error message
/record/help GET - None - Help message with available commands

参考链接

agora-local-recording-javaweb-demo's People

Contributors

lzz110 avatar

Watchers

 avatar

Forkers

liujinshan0812

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.