ngx-agora-sdk-ng

<div style="display:flex"> <img src="docs/images/angular-logo.svg" width="50px" height="50px" alt="Angular"/> <img src="docs/images/agora-logo.png" width="50px" height="50px" alt="Agora"/> </div>

Usage no npm install needed!

<script type="module">
  import ngxAgoraSdkNg from 'https://cdn.skypack.dev/ngx-agora-sdk-ng';
</script>

README

Video and Voice Conferencing in Angular

Angular Agora

npm version

Angular library for the Agora Web SDK next-generation client from Agora.io enabling audio and video real-time communications based on Agora SD-RTN™ and implementing scenarios such as voice-only calls, video call, voice-only interactive broadcast, and video interactive broadcast.

Prerequisites

Before using the Library, you need to:

  1. Get a valid Agora account. (Sign up for free.)
  2. Create a project in Agora Console and choose APP ID for authentication.

Installing

Run the following command to install the library.

npm i ngx-agora-sdk-ng 

Import Module

Import NgxAgoraSdkNgModule from ngx-agora-sdk-ng and add the module to the imports array with configuration.

  • Replace your own appId in agora-appId.
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { NgxAgoraSdkNgModule } from 'ngx-agora-sdk-ng';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgxAgoraSdkNgModule.forRoot({
      AppID: 'replace-agora-appId',
      Video: { codec: 'h264', mode: 'rtc', role: 'host' }
    })
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Import Service

Import NgxAgoraSdkNgService from ngx-agora-sdk-ng into your component or service to use.

import { Component } from '@angular/core';
import { NgxAgoraSdkNgService } from 'ngx-agora-sdk-ng';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {

  title = 'demo';

  constructor(private agoraService: NgxAgoraSdkNgService) { }
}

📚 Documentation

Deployment notes
Due to security limits on HTTP addresses except 127.0.0.1, the library only supports HTTPS or http://localhost (http://127.0.0.1). If you deploy your project over HTTP, you can only visit your project at http://localhost(http://127.0.0.1).

Made with ❤️