Functional APIs

API List

Details

Create a Client Object

- const SDK = require("../../lib/thunderblot_wechat_sdk.js");
- client = new SDK.ClientSdk();

init

init(appid: number): Err | null

This API initializes the SDK.

Parameters

on

on(event: string, listener: any)

To add event bindings, refer to callback event for details

Parameters

joinRoom

joinRoom(roomParam: RoomParam)

This API allows users to join the communication channel.

Users in the channel can communicate with one another or engage in group chat. Applications using different application IDs cannot intercommunicate. If you are already in the midst of communication, you must exit by calling leaveRoom() before you can join the next channel.

Parameters

RoomParam

interface RoomParam {
    uid: number;
    roomId: string;
    token?: string;    
}

leaveRoom

- leaveRoom(): void

Leave the channel, i.e. hanging up or exiting the conversation.

publishMedia

- publishMedia(publishParam：publishParam):void

Call this API to push audio/video streams into the channel for live streaming. You must join the channel before calling. Returns the published audio/video stream's URL to users through the update_publish_url callback event. publishParam (the channel stream information parameter):

unpublishMedia

Call to cancel pushing audio/video streams into the channel. You can call it at any point during publishing.

- unpublishMedia():void

subscribeMedia

Send a remote media stream notification to users who join the channel. Then receiving the message triggers the "remote_stream_add" callback event. Subscription then requires this API.

-subscribeMedia(uid:number,target:object):void

Subscribed remote media stream parameters:

Target (Select profile for the subscribed media stream):

unsubscribeMedia

Call to cancel the subscription to a remote video stream.

-unsubscribeMedia(uid:number):void

Unsubscribe to remote media stream parameters:

enableLocalMedia

Call to resume local audio/video stream publishing.

-enableLocalMedia(parm:param):void

Param (resume local audio/video stream publishing):

disableLocalMedia

Call to disable local audio/video stream publishing.

- disableLocalMedia(parm:param):void

param (disable local audio/video stream publishing):

enableRemoteMedia

Call to resume remote audio/video stream reception.

-enableRemoteMedia(uid:number，parm:param):void

param (resume remote audio/video stream reception)

disableRemoteMedia

Call to disable remote audio/video stream reception.

-disableRemoteMedia(uid:number,parm:param):void

param (disable remote audio/video stream reception)