tencent cloud

WebRTCAPI.fn.detectRTC

This API is used to detect whether WebRTC is supported.
Syntax example:
WebRTCAPI.fn.detectRTC(options, callback);

Parameter description:

options:

Callback's info field:

Actual example:

WebRTCAPI.fn.detectRTC({
        screenshare : false
    }, function(info){
    if( !info.support ) {
        alert('WebRTC is not supported')
    }
});

WebRTCAPI

This API is used to initialize WebRTC.
Syntax example:

var RTC = new WebRTCAPI( options , succ , error)

Parameter description:

Options description:

Actual example:

var RTC = new WebRTCAPI( {
    "userId": userId,
    "sdkAppId":  sdkappid,
    "accountType":  accountType,
    "userSig": userSig
} );

// Debug mode
var RTC = new WebRTCAPI( {
    "userId": userId,
    "sdkAppId":  sdkappid,
    "accountType":  accountType,
    "userSig": userSig,
    "debug":{
        "log": true, //Whether to print the debug log on the console. It is false by default
        "vconsole": true //Whether the vconsole is shown (to facilitate viewing logs on the mobile end)
        "uploadLog": true //Whether to report the log
    }
} );

WebRTCAPI.enterRoom ( WebRTCAPI.createRoom )

This API is used to create or enter an audio/video room.
Syntax example

var RTC = new WebRTCAPI( ... )
...
//Note: This must be called in the successful initialized callback of WebRTCAPI
RTC.enterRoom( options, succ , error );

Parameter description:

Options description:

Actual example:

var RTC = new WebRTCAPI({
    "userId": "username",
    "sdkAppId":  1400012345,
    "accountType":  12345,
    "userSig": "xxxxxxxxxxxxxxxxxxxxxxxxx",
}, function(data){
    //Initialized successfully
    RTC.createRoom( {
        roomid : 123456,
        role : "user",
    }, function(){
        //Entered the room successfully
    } ,  function(data){
        //Failed to enter the room
    } );
}, function(data){
    //Initialization failed
});

WebRTCAPI.quit

This API is used to exit the audio/video room.
Syntax example

 var RTC = new WebRTCAPI( ... )
 ...
 //Note: This must be called in the successful initialized callback of WebRTCAPI
 RTC.quit(  succ , error );

Parameter description:

Actual example:

var RTC = new WebRTCAPI( ... )
...
//Note: This must be called in the successful initialized callback of WebRTCAPI
RTC.quit(  function(){
    //Exited successfully
} , function(){
    //Failed to exit
} );