Remon
Most important class for using RemoteMonster API. It can be use to P2P communication and broadcast. You can receive callback events from listener.
Constructor Summary
Public Constructor | ||
public |
create Remon object with config object and listener object. |
Member Summary
Public Members | ||
public |
config: * |
|
public |
context: * |
|
public |
key: * |
|
public |
media: * |
|
public |
serviceId: * |
|
public |
uri: * |
|
public |
|
Method Summary
Public Methods | ||
public |
switch camera between fore and back |
|
public |
close(closeType: *) close all Remon's resources |
|
public |
async connectCall(args: ...*) |
|
public |
async connectChannel(args: ...*): * Create P2P channel, if there is no P2P channel with the id. |
|
public |
async createCast((string): *) Create a broadcast room |
|
public |
async fetchCalls(id: *): * |
|
public |
async fetchCasts(): * |
|
public |
getChannelId(): * get channel id |
|
public |
getHealth(): * retrieve current stream health information |
|
public |
getState(): * retrieve current remon state information |
|
public |
getVersion(): * retrieve current sdk version |
|
public |
async init() |
|
public |
async joinCast((string): *) Join a room by room id. |
|
public |
liveRooms(): * Retrieve all broadcast rooms information |
|
public |
muteLocalAudio(bool: bool) mute local audio and mic stream |
|
public |
muteRemoteAudio(bool: *) mute remote audio stream |
|
public |
|
|
public |
|
|
public |
pauseLocalVideo((bool): *) mute local video |
|
public |
pauseRemoteVideo((bool): *) mute remote video |
|
public |
search((string): *): * search P2P channels by id. |
|
public |
sendMessage((string): *) It's only function for P2P communication. send message to peer |
|
public |
setVideoQulity(quility: *) |
|
public |
wait(timeout: *): * |
Public Constructors
public constructor() source
create Remon object with config object and listener object. example: var v = new Remon({config: rtcConfig, listener: rtcListener});
Public Members
public config: * source
public context: * source
public key: * source
public media: * source
public serviceId: * source
public uri: * source
Public Methods
public close(closeType: *) source
close all Remon's resources
Params:
Name | Type | Attribute | Description |
closeType | * |
public async connectCall(args: ...*) source
Params:
Name | Type | Attribute | Description |
args | ...* |
public async connectChannel(args: ...*): * source
Create P2P channel, if there is no P2P channel with the id. Join the P2P channel, if there is P2P channel with the id. example: remon.connectChannel("roomname1");
Params:
Name | Type | Attribute | Description |
args | ...* |
Return:
* |
public async createCast((string): *) source
Create a broadcast room
Params:
Name | Type | Attribute | Description |
(string) | * | roomname name of broadcast room. it is no id but name. You can take a real room id from onCreateChannel event |
public async init() source
public async joinCast((string): *) source
Join a room by room id.
Params:
Name | Type | Attribute | Description |
(string) | * | room id |
public muteLocalAudio(bool: bool) source
mute local audio and mic stream
Params:
Name | Type | Attribute | Description |
bool | bool |
public muteRemoteAudio(bool: *) source
mute remote audio stream
Params:
Name | Type | Attribute | Description |
bool | * |
public onDisconnectSignalConnection() source
public onReconnectSignalConnection() source
public pauseLocalVideo((bool): *) source
mute local video
Params:
Name | Type | Attribute | Description |
(bool) | * |
public pauseRemoteVideo((bool): *) source
mute remote video
Params:
Name | Type | Attribute | Description |
(bool) | * | bool |
public search((string): *): * source
search P2P channels by id.
Params:
Name | Type | Attribute | Description |
(string) | * | id for search. It can be part of full id |
Return:
* |
public sendMessage((string): *) source
It's only function for P2P communication. send message to peer
Params:
Name | Type | Attribute | Description |
(string) | * | userMessage message to peer |
public setVideoQulity(quility: *) source
Params:
Name | Type | Attribute | Description |
quility | * |