Module AgoraRTC

Index

Modules

Logger

Enumerations

AREAS

Classes

ChannelMediaError

Variables

VERSION

Functions

Variables

Const VERSION

VERSION: string

Functions

checkSystemRequirements

checkSystemRequirements(): boolean

- Defined in index.d.ts:90
Returns boolean
- true: The Web SDK is compatible with the current web browser.
- false: The Web SDK is not compatible with the current web browser.

createClient

createClient(config: ClientConfig): Client

- Defined in index.d.ts:67
Parameters
- config: ClientConfig
Returns Client

createStream

createStream(spec: StreamSpec): Stream

- Defined in index.d.ts:75
Parameters
- spec: StreamSpec
Returns Stream

getDevices

getDevices(callback: function, callback_Error?: function): void

- Defined in index.d.ts:165
Parameters
- callback: function
  - - (devices: MediaDeviceInfo[]): void
    - Parameters
      - devices: MediaDeviceInfo[]
      Returns void
- Optional callback_Error: function
  - - (errStr: string): void
    - Parameters
      - errStr: string
      Returns void
Returns void

getScreenSources

getScreenSources(callback: function): void

- Defined in index.d.ts:59
Parameters
- callback: function
  - - (sources: DesktopCapturerSource[]): void
    - Parameters
      - sources: DesktopCapturerSource[]
      Returns void
Returns void

getSupportedCodec

getSupportedCodec(supportedCodecOptions?: object): Promise<object>

- Defined in index.d.ts:128
Parameters
- Optional supportedCodecOptions: object
  - stream: MediaStream
Returns Promise<object>

Returns a Promise object. In the .then(function(result){}) callback, result has the following properties:
- video: array, the supported video codecs. The array might include "H264" and "VP8", or be empty.
- audio: array, the supported audio codecs. The array might include "OPUS", or be empty.