Options
All
  • Public
  • Public/Protected
  • All
Menu

Module AgoraRTC

Index

Variables

Const VERSION

VERSION: string

Functions

checkSystemRequirements

  • checkSystemRequirements(): boolean
  • 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

createStream

getDevices

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

    • callback: function
    • Optional callback_Error: function
        • (errStr: string): void
        • Parameters

          • errStr: string

          Returns void

    Returns void

getScreenSources

  • getScreenSources(callback: function): void

getSupportedCodec

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

    • Optional supportedCodecOptions: object

    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.