ngx-webrtc-lib

ngx-webrtc-lib

Angular microapp/library for Agora WebRTC client from Agora.io using agora-rtc-sdk and ngx-agora.

This library was generated with Angular CLI version 12.2.0.

Installation

Install ngx-web-rtc-lib from npm:

npm install ngx-webrtc-lib --save

Add wanted package to NgModule imports:

import { WebRtcModule } from 'ngx-webrtc-lib';

@NgModule({
  ...
  imports: [
    WebRtcModule.forRoot({
      AppID: 'agora AppID',
    }),
  ]
  ...
})

You can get started with Agora by following this guide and retrieve the Appid.

Add component to your page:

<ngx-webrtc
  [channel]="channel"
  [debug]="true"
  [uid]="uid"
  (callEnd)="onCallEnd()"
></ngx-webrtc>

How to build lib for development

git clone https://github.com/TarasMoskovych/ngx-webrtc.git
cd ngx-webrtc
npm ci
npm start

Compatibility

To use this library, please follow the versioning specified in the following table.

Angular Version	ngx-webrtc-lib Version
12.x	1.x

API reference

Name	Description
@Input() uid: string	User identifier.
@Input() channel: string	Channel identifier.
@Input() debug: boolean	Enable debugging. Default value false
@Output() callEnd: EventEmitter	Event that is emitted when the call is ended.