Search
Preparing search index...
The search index is not available
typed_janus_js
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
typed_janus_js
JanusVideoRoomPlugin
Class JanusVideoRoomPlugin
Hierarchy
JanusPlugin
JanusVideoRoomPlugin
Index
Constructors
constructor
Properties
controllers
detached
handle
id
instance
media
Recorder
plugin
recording
Time
Slice
session
stats
Report
Hook
Timer
token
webrtc
Stuff
Accessors
on
Cleanup
on
Data
on
Data
Open
on
Detached
on
Error
on
Ice
State
on
Local
Track
on
Media
State
on
Message
on
Recording
Data
on
Remote
Track
on
Slow
Link
on
Stat
Reports
on
WebRTCState
recorder
Methods
create
Answer
create
Offer
create
Room
data
detach
dtmf
get
Bitrate
get
Id
get
Plugin
handle
Recording
Setup
handle
Remote
Jsep
handle
Stats
Hook
hangup
is
Audio
Muted
is
Video
Muted
join
Room
As
Publisher
join
Room
As
Subscriber
list
Participants
mute
Audio
mute
Video
publish
As
Publisher
send
start
As
Subscriber
stop
Collecting
Stats
unmute
Audio
unmute
Video
Constructors
constructor
new
Janus
Video
Room
Plugin
(
instance
:
Janus
, session
:
JanusSession
, handle
:
PluginHandle
, controllers
:
Controllers
)
:
JanusVideoRoomPlugin
Parameters
instance:
Janus
session:
JanusSession
handle:
PluginHandle
controllers:
Controllers
Returns
JanusVideoRoomPlugin
Properties
Protected
controllers
controllers
:
Controllers
detached
detached
:
boolean
Protected
handle
handle
:
PluginHandle
id
id
:
string
Protected
instance
instance
:
Janus
Protected
media
Recorder
media
Recorder
:
MediaRecorder
plugin
plugin
:
string
Optional
recording
Time
Slice
recording
Time
Slice
?:
number
Protected
session
session
:
JanusSession
Protected
stats
Report
Hook
Timer
stats
Report
Hook
Timer
:
any
Optional
token
token
?:
string
webrtc
Stuff
webrtc
Stuff
:
WebRTCInfo
Accessors
on
Cleanup
get
onCleanup
(
)
:
Observable
<
void
>
Returns
Observable
<
void
>
on
Data
get
onData
(
)
:
Observable
<
any
>
Returns
Observable
<
any
>
on
Data
Open
get
onDataOpen
(
)
:
Observable
<
void
>
Returns
Observable
<
void
>
on
Detached
get
onDetached
(
)
:
Observable
<
void
>
Returns
Observable
<
void
>
on
Error
get
onError
(
)
:
Observable
<
any
>
Returns
Observable
<
any
>
on
Ice
State
get
onIceState
(
)
:
Observable
<
"connected"
|
"failed"
|
"disconnected"
|
"closed"
>
Returns
Observable
<
"connected"
|
"failed"
|
"disconnected"
|
"closed"
>
on
Local
Track
get
onLocalTrack
(
)
:
Observable
<
{
on
:
boolean
;
track
:
MediaStreamTrack
}
>
Returns
Observable
<
{
on
:
boolean
;
track
:
MediaStreamTrack
}
>
on
Media
State
get
onMediaState
(
)
:
Observable
<
{
medium
:
"audio"
|
"video"
;
mid
:
number
;
recieving
:
boolean
}
>
Returns
Observable
<
{
medium
:
"audio"
|
"video"
;
mid
:
number
;
recieving
:
boolean
}
>
on
Message
get
onMessage
(
)
:
Observable
<
{
jsep
:
JSEP
;
message
:
MessageCallback
}
>
Returns
Observable
<
{
jsep
:
JSEP
;
message
:
MessageCallback
}
>
on
Recording
Data
get
onRecordingData
(
)
:
Observable
<
{
blob
:
Blob
;
chunkNumber
:
number
}
>
Returns
Observable
<
{
blob
:
Blob
;
chunkNumber
:
number
}
>
on
Remote
Track
get
onRemoteTrack
(
)
:
Observable
<
{
mid
:
string
;
on
:
boolean
;
track
:
MediaStreamTrack
}
>
Returns
Observable
<
{
mid
:
string
;
on
:
boolean
;
track
:
MediaStreamTrack
}
>
on
Slow
Link
get
onSlowLink
(
)
:
Observable
<
{
lost
:
number
;
mid
:
string
;
uplink
:
boolean
}
>
Returns
Observable
<
{
lost
:
number
;
mid
:
string
;
uplink
:
boolean
}
>
on
Stat
Reports
get
onStatReports
(
)
:
Observable
<
any
[]
>
Returns
Observable
<
any
[]
>
on
WebRTCState
get
onWebRTCState
(
)
:
Observable
<
boolean
>
Returns
Observable
<
boolean
>
recorder
get
recorder
(
)
:
MediaRecorder
Returns
MediaRecorder
Methods
create
Answer
create
Answer
(
params
:
Omit
<
AnswerParams
,
"success"
|
"error"
>
)
:
Promise
<
RTCSessionDescription
>
Parameters
params:
Omit
<
AnswerParams
,
"success"
|
"error"
>
Returns
Promise
<
RTCSessionDescription
>
create
Offer
create
Offer
(
params
:
Omit
<
OfferParams
,
"success"
|
"error"
>
)
:
Promise
<
RTCSessionDescription
>
Parameters
params:
Omit
<
OfferParams
,
"success"
|
"error"
>
Returns
Promise
<
RTCSessionDescription
>
create
Room
create
Room
(
options
?:
{
allowed
?:
string
[]
;
description
?:
string
;
is_private
?:
boolean
;
permanent
?:
boolean
;
pin
?:
string
;
room
?:
number
;
secret
?:
string
}
)
:
Promise
<
any
>
Parameters
options:
{
allowed
?:
string
[]
;
description
?:
string
;
is_private
?:
boolean
;
permanent
?:
boolean
;
pin
?:
string
;
room
?:
number
;
secret
?:
string
}
= {}
Optional
allowed
?:
string
[]
Optional
description
?:
string
Optional
is_
private
?:
boolean
Optional
permanent
?:
boolean
Optional
pin
?:
string
Optional
room
?:
number
Optional
secret
?:
string
Returns
Promise
<
any
>
data
data
(
params
:
DataParams
)
:
Promise
<
void
>
Parameters
params:
DataParams
Returns
Promise
<
void
>
detach
detach
(
params
?:
DetachOptions
)
:
void
Parameters
Optional
params:
DetachOptions
Returns
void
dtmf
dtmf
(
params
:
any
)
:
void
Parameters
params:
any
Returns
void
get
Bitrate
get
Bitrate
(
)
:
string
Returns
string
get
Id
get
Id
(
)
:
string
Returns
string
get
Plugin
get
Plugin
(
)
:
string
Returns
string
Protected
handle
Recording
Setup
handle
Recording
Setup
(
controllers
:
Controllers
)
:
void
Parameters
controllers:
Controllers
Returns
void
handle
Remote
Jsep
handle
Remote
Jsep
(
params
:
{
jsep
:
JSEP
}
)
:
void
Parameters
params:
{
jsep
:
JSEP
}
jsep
:
JSEP
Returns
void
Protected
handle
Stats
Hook
handle
Stats
Hook
(
plugin
:
PluginHandle
, controllers
:
Controllers
, mediaStreamTrack
?:
MediaStreamTrack
)
:
number
Parameters
plugin:
PluginHandle
controllers:
Controllers
mediaStreamTrack:
MediaStreamTrack
= null
Returns
number
hangup
hangup
(
sendRequest
?:
boolean
)
:
void
Parameters
Optional
sendRequest:
boolean
Returns
void
is
Audio
Muted
is
Audio
Muted
(
)
:
boolean
Returns
boolean
is
Video
Muted
is
Video
Muted
(
)
:
boolean
Returns
boolean
join
Room
As
Publisher
join
Room
As
Publisher
(
roomId
:
string
|
number
, options
:
{
display
?:
string
;
id
?:
string
;
token
?:
string
}
)
:
Promise
<
any
>
Parameters
roomId:
string
|
number
options:
{
display
?:
string
;
id
?:
string
;
token
?:
string
}
Optional
display
?:
string
Optional
id
?:
string
Optional
token
?:
string
Returns
Promise
<
any
>
join
Room
As
Subscriber
join
Room
As
Subscriber
(
room
:
string
|
number
, options
:
{
feed_id
?:
number
;
private_id
?:
number
;
streams
?:
{
feed_id
:
number
;
mid
:
number
}
[]
}
)
:
Promise
<
any
>
Parameters
room:
string
|
number
options:
{
feed_id
?:
number
;
private_id
?:
number
;
streams
?:
{
feed_id
:
number
;
mid
:
number
}
[]
}
Optional
feed_
id
?:
number
Optional
private_
id
?:
number
Optional
streams
?:
{
feed_id
:
number
;
mid
:
number
}
[]
Returns
Promise
<
any
>
list
Participants
list
Participants
(
room
:
string
|
number
)
:
Promise
<
any
>
Parameters
room:
string
|
number
Returns
Promise
<
any
>
mute
Audio
mute
Audio
(
)
:
void
Returns
void
mute
Video
mute
Video
(
)
:
void
Returns
void
publish
As
Publisher
publish
As
Publisher
(
offer
:
RTCSessionDescription
, options
:
{
audio_active_packets
?:
number
;
audio_level_average
?:
number
;
audiocodec
?:
string
;
bitrate
?:
number
;
descriptions
?:
{
description
:
string
;
mid
:
number
}
[]
;
display
?:
string
;
filename
?:
string
;
record
?:
boolean
;
videocodec
?:
string
}
)
:
Promise
<
any
>
Parameters
offer:
RTCSessionDescription
options:
{
audio_active_packets
?:
number
;
audio_level_average
?:
number
;
audiocodec
?:
string
;
bitrate
?:
number
;
descriptions
?:
{
description
:
string
;
mid
:
number
}
[]
;
display
?:
string
;
filename
?:
string
;
record
?:
boolean
;
videocodec
?:
string
}
Optional
audio_
active_
packets
?:
number
Optional
audio_
level_
average
?:
number
Optional
audiocodec
?:
string
Optional
bitrate
?:
number
Optional
descriptions
?:
{
description
:
string
;
mid
:
number
}
[]
Optional
display
?:
string
Optional
filename
?:
string
Optional
record
?:
boolean
Optional
videocodec
?:
string
Returns
Promise
<
any
>
send
send
(
message
:
Omit
<
PluginMessage
,
"success"
|
"error"
>
)
:
Promise
<
any
>
Parameters
message:
Omit
<
PluginMessage
,
"success"
|
"error"
>
Returns
Promise
<
any
>
start
As
Subscriber
start
As
Subscriber
(
answer
:
RTCSessionDescription
)
:
Promise
<
any
>
Parameters
answer:
RTCSessionDescription
Returns
Promise
<
any
>
stop
Collecting
Stats
stop
Collecting
Stats
(
)
:
void
Returns
void
unmute
Audio
unmute
Audio
(
)
:
void
Returns
void
unmute
Video
unmute
Video
(
)
:
void
Returns
void
Exports
Janus
Video
Room
Plugin
constructor
controllers
detached
handle
id
instance
media
Recorder
plugin
recording
Time
Slice
session
stats
Report
Hook
Timer
token
webrtc
Stuff
on
Cleanup
on
Data
on
Data
Open
on
Detached
on
Error
on
Ice
State
on
Local
Track
on
Media
State
on
Message
on
Recording
Data
on
Remote
Track
on
Slow
Link
on
Stat
Reports
on
WebRTCState
recorder
create
Answer
create
Offer
create
Room
data
detach
dtmf
get
Bitrate
get
Id
get
Plugin
handle
Recording
Setup
handle
Remote
Jsep
handle
Stats
Hook
hangup
is
Audio
Muted
is
Video
Muted
join
Room
As
Publisher
join
Room
As
Subscriber
list
Participants
mute
Audio
mute
Video
publish
As
Publisher
send
start
As
Subscriber
stop
Collecting
Stats
unmute
Audio
unmute
Video
Generated using
TypeDoc