Class VideoRoomPlugin

Hierarchy

VideoRoomPlugin

Index

Constructors

constructor

Accessors

handle

Methods

Constructors

constructor

new VideoRoomPlugin(_transport: ITransport, _client: JanusClient, _session: JanusSession, _handle: PluginHandle): VideoRoomPlugin

- Defined in src/plugins/videoroom/plugin.ts:65
Parameters
- _transport: ITransport
- _client: JanusClient
- _session: JanusSession
- _handle: PluginHandle
Returns VideoRoomPlugin

Accessors

handle

get handle(): PluginHandle

- Defined in src/plugins/videoroom/plugin.ts:71
Returns PluginHandle

Methods

allowed

allowed(req: IAllowedRequest): Promise<IAllowedResponse>

- Defined in src/plugins/videoroom/plugin.ts:92
Parameters
- req: IAllowedRequest
Returns Promise<IAllowedResponse>

configure

configure(req: IConfigureRequest): Promise<boolean>

- Defined in src/plugins/videoroom/plugin.ts:111
Parameters
- req: IConfigureRequest
Returns Promise<boolean>

create

create(req: ICreateRequest): Promise<ICreatedResponse>

- Defined in src/plugins/videoroom/plugin.ts:75
Parameters
- req: ICreateRequest
Returns Promise<ICreatedResponse>

destroy

destroy(req: IDestroyRequest): Promise<IDestroyedResponse>

- Defined in src/plugins/videoroom/plugin.ts:90
Parameters
- req: IDestroyRequest
Returns Promise<IDestroyedResponse>

dispose

dispose(): Promise<void>

- Defined in src/plugins/videoroom/plugin.ts:61
Returns Promise<void>

edit

edit(req: IEditRequest): Promise<IEditedResponse>

- Defined in src/plugins/videoroom/plugin.ts:89
Parameters
- req: IEditRequest
Returns Promise<IEditedResponse>

exists

exists(req: IExistsRequest): Promise<IExistsResponse>

- Defined in src/plugins/videoroom/plugin.ts:91
Parameters
- req: IExistsRequest
Returns Promise<IExistsResponse>

join_publisher

join_publisher(req: IJoinPublisherRequest): Promise<IJoinPublisherResponse>

- Defined in src/plugins/videoroom/plugin.ts:106
Parameters
- req: IJoinPublisherRequest
Returns Promise<IJoinPublisherResponse>

join_subscriber

join_subscriber(req: IJoinSubscriberRequest): Promise<IAttachedResponse>

- Defined in src/plugins/videoroom/plugin.ts:117
Parameters
- req: IJoinSubscriberRequest
Returns Promise<IAttachedResponse>

kick

kick(req: IKickRequest): Promise<boolean>

- Defined in src/plugins/videoroom/plugin.ts:93
Parameters
- req: IKickRequest
Returns Promise<boolean>

leave

leave(): Promise<boolean>

- Defined in src/plugins/videoroom/plugin.ts:115
Returns Promise<boolean>

list

list(req: IListRequest): Promise<IListResponse>

- Defined in src/plugins/videoroom/plugin.ts:94
Parameters
- req: IListRequest
Returns Promise<IListResponse>

listforwarders

listforwarders(req: IListForwardersRequest): Promise<IListForwardersResponse>

- Defined in src/plugins/videoroom/plugin.ts:114
Parameters
- req: IListForwardersRequest
Returns Promise<IListForwardersResponse>

listparticipants

listparticipants(req: IListParticipantsRequest): Promise<IListParticipantsResponse>

- Defined in src/plugins/videoroom/plugin.ts:104
Parameters
- req: IListParticipantsRequest
Returns Promise<IListParticipantsResponse>

onJoining

onJoining(cb: (room: number, id: number, display: string) => void): void

- Defined in src/plugins/videoroom/plugin.ts:124
Parameters
- cb: (room: number, id: number, display: string) => void
  - - (room: number, id: number, display: string): void
    - Parameters
      - room: number
      - id: number
      - display: string
      Returns void
Returns void

onPublish

onPublish(cb: (room: number, publishers: IPublisher[]) => void): void

- Defined in src/plugins/videoroom/plugin.ts:137
Parameters
- cb: (room: number, publishers: IPublisher[]) => void
  - - (room: number, publishers: IPublisher[]): void
    - Parameters
      - room: number
      - publishers: IPublisher[]
      Returns void
Returns void

pause

pause(): Promise<boolean>

- Defined in src/plugins/videoroom/plugin.ts:119
Returns Promise<boolean>

publish

publish(req: IPublishRequest): Promise<boolean>

- Defined in src/plugins/videoroom/plugin.ts:107
Parameters
- req: IPublishRequest
Returns Promise<boolean>

rtp_forward

rtp_forward(req: IRTPForwardRequest): Promise<IRTPForwardResponse>

- Defined in src/plugins/videoroom/plugin.ts:112
Parameters
- req: IRTPForwardRequest
Returns Promise<IRTPForwardResponse>

start

start(): Promise<boolean>

- Defined in src/plugins/videoroom/plugin.ts:118
Returns Promise<boolean>

stop_rtp_forward

stop_rtp_forward(req: IStopRTPForwardRequest): Promise<IStopRTPForwardResponse>

- Defined in src/plugins/videoroom/plugin.ts:113
Parameters
- req: IStopRTPForwardRequest
Returns Promise<IStopRTPForwardResponse>

switch

switch(req: ISwitchRequest): Promise<ISwitchResponse>

- Defined in src/plugins/videoroom/plugin.ts:121
Parameters
- req: ISwitchRequest
Returns Promise<ISwitchResponse>

unpublish

unpublish(): void

- Defined in src/plugins/videoroom/plugin.ts:108
Returns void

Static attach

attach(client: JanusClient, session?: JanusSession): Promise<VideoRoomPlugin>

- Defined in src/plugins/videoroom/plugin.ts:48
Parameters
- client: JanusClient
- Optional session: JanusSession
Returns Promise<VideoRoomPlugin>

Generated using TypeDoc