Class RoomsAPI

Hierarchy

ServerAPI
- RoomsAPI

Constructors

constructor

new RoomsAPI(client: SignalingClient): RoomsAPI
Parameters
- client: SignalingClient
Returns RoomsAPI
Overrides ServerAPI.constructor
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:23

Properties

`Protected` client

client: SignalingClient

muteChange$

muteChange$: Observable<{
    muted: boolean;
    roomId: string;
    userId: string;
}>

muteRequest$

muteRequest$: Observable<{
muted: boolean;
roomId: string;
}>

Methods

addRoomParticipants

addRoomParticipants(id: string, participants: string[]): Promise<unknown>
Add participants to a room

Throws
if server returns an error

Returns
resolved on success with server response.
Parameters
- id: string
  
  room identifier
- participants: string[]
  
  list of user names to add to the room
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:97

answer

answer(type: string, id: string, payload: Body): Promise<Record<string, any>>
Send an answer to server with given data.

Throws
if server returns an error
Parameters
- type: string
  
  response type, i.e: 'invitation',...
- id: string
  
  request id
- payload: Body
  
  response data.
Returns Promise<Record<string, any>>
Inherited from ServerAPI.answer
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:48

answerWaitingResponse

answerWaitingResponse(type: string, id: string, payload: Record<string, any>): Promise<Record<string, any>>
Parameters
- type: string
- id: string
- payload: Record<string, any>
Returns Promise<Record<string, any>>
Inherited from ServerAPI.answerWaitingResponse
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:57

cancel

cancel(type: string, id: string, payload: Body): Promise<Record<string, any>>
Cancel a previous request.

Throws
if server returns an error
Parameters
- type: string
  
  response type, i.e: 'invitation',...
- id: string
  
  request id
- payload: Body
Returns Promise<Record<string, any>>
Inherited from ServerAPI.cancel
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:33

cleanPendingWithId

cleanPendingWithId(id: string): void
Parameters
- id: string
Returns void
Inherited from ServerAPI.cleanPendingWithId
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:74

createRoom

createRoom(record?: boolean): Promise<RoomDto>
Request a room creation on server and returns a Room instance

Throws
if server returns an error

Returns
resolved on success.
Parameters
- record: boolean = false
  
  indicate if room should be recorded
Returns Promise<RoomDto>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:60

getRooms

getRooms(): Promise<unknown[]>
Get any room from server where user participates and return a list of Room instances

Throws
if server returns an error

Returns
resolved with server response.

Returns Promise<unknown[]>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:49

joinMeeting

joinMeeting(id: string, meetingId: string, password?: string): Promise<RoomDto>
Join a meeting
Parameters
- id: string
- meetingId: string
- Optional password: string
Returns Promise<RoomDto>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:68

joinQuickConference

joinQuickConference(id: string, quickConferenceId: string): Promise<RoomDto>
Join a quick conference
Parameters
- id: string
- quickConferenceId: string
Returns Promise<RoomDto>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:81

leaveRoom

leaveRoom(id: string): Promise<unknown>
Close a room

Throws
if server returns an error

Returns
resolved on success with server response.
Parameters
- id: string
  
  room identifier
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:166

mute

mute(roomId: string, userId: string, muted?: boolean): Promise<unknown>
Indicates users has mute/unmute themselves

Returns
raw server response
Parameters
- roomId: string
  
  The UUID of the room where the user is being un/muted.
- userId: string
  
  The ID of the user being un/muted.
- muted: boolean = true
  
  Whether the user is being muted (true) or unmuted (false)
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:212

muteRequest

muteRequest(room: string, to: string, requestedBy: string, muted?: boolean): Promise<unknown>
Request a remote participant to be muted.

Returns
raw server response
Parameters
- room: string
  
  The UUID of the room where the conference is taking place.
- to: string
  
  The ID of the user to be un/muted.
- requestedBy: string
  
  The ID of the user doing the request.
- muted: boolean = true
  
  if true requests user to be muted, if false to be unmuted
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:191

removeRoomParticipants

removeRoomParticipants(id: string, participants: string[]): Promise<unknown>
Remove participants from a room

Throws
if server returns an error

Returns
resolved on success with server response.
Parameters
- id: string
  
  room identifier
- participants: string[]
  
  list of user names to remove from the room
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:116

request

request(type: string, id: string, body: Body, retry?: number): Promise<Record<string, any>>
Send a request to server with given data.

Throws
if server returns an error

Returns
resolved with server response.
Parameters
- type: string
  
  request type, i.e: 'createRoom', 'invitation',...
- id: string
  
  request id
- body: Body
  
  requested body.
- Optional retry: number
  
  if specified and an id is provided, when an answer is not received for this requested id, message will be send again periodically.
Returns Promise<Record<string, any>>
Inherited from ServerAPI.request
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:18

sendDtmf

sendDtmf(sipUri: string, dtmf: Dtmf): Promise<unknown>
Send a DTMF tone
Parameters
- sipUri: string
- dtmf: Dtmf
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:177

startRecordingRoom

startRecordingRoom(id: string): Promise<unknown>
Start recording a room

Throws
if server returns an error

Returns
resolved on success with server response.
Parameters
- id: string
  
  room identifier
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:134

stopRecordingRoom

stopRecordingRoom(id: string): Promise<unknown>
Stop recording a room

Throws
if server returns an error

Returns
resolved on success with server response.
Parameters
- id: string
  
  room identifier
Returns Promise<unknown>
- Defined in src/wac-proxy/stacks/Janus/signaling/RoomsAPI.ts:150

waitAnserWithId

waitAnserWithId(id: string): Promise<Record<string, any>>
Parameters
- id: string
Returns Promise<Record<string, any>>
Inherited from ServerAPI.waitAnserWithId
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:66

waitAnswerWithInviteId

waitAnswerWithInviteId(id: string): Promise<Record<string, any>>
Parameters
- id: string
Returns Promise<Record<string, any>>
Inherited from ServerAPI.waitAnswerWithInviteId
- Defined in src/wac-proxy/stacks/Janus/signaling/ServerAPI.ts:70

Class RoomsAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: SignalingClient

Returns RoomsAPI

Properties

Protected client

muteChange$

muteRequest$

Methods

addRoomParticipants

Throws

Returns

Parameters

id: string

participants: string[]

Returns Promise<unknown>

answer

Throws

Parameters

type: string

id: string

payload: Body

Returns Promise<Record<string, any>>

answerWaitingResponse

Parameters

type: string

id: string

payload: Record<string, any>

Returns Promise<Record<string, any>>

cancel

Throws

Parameters

type: string

id: string

payload: Body

Returns Promise<Record<string, any>>

cleanPendingWithId

Parameters

id: string

Returns void

createRoom

Throws

Returns

Parameters

record: boolean = false

Returns Promise<RoomDto>

getRooms

Throws

Returns

Returns Promise<unknown[]>

joinMeeting

Parameters

id: string

meetingId: string

Optional password: string

Returns Promise<RoomDto>

joinQuickConference

Parameters

id: string

quickConferenceId: string

Returns Promise<RoomDto>

leaveRoom

Throws

Returns

Parameters

id: string

Returns Promise<unknown>

mute

Returns

Parameters

roomId: string

userId: string

muted: boolean = true

`Protected` client

`Optional` password: string

`Optional` retry: number