Preparing search index...
The search index is not available
Fishjam Web SDK - v0.12.0
Fishjam Web SDK
@fishjam-cloud/ts-client
FishjamTrackContext
Interface FishjamTrackContext
interface
FishjamTrackContext
{
encoding
?:
Variant
;
encodingReason
?:
EncodingReason
;
endpoint
:
Endpoint
;
maxBandwidth
?:
TrackBandwidthLimit
;
metadata
?:
TrackMetadata
;
simulcastConfig
?:
SimulcastConfig
;
stream
:
null
|
MediaStream
;
track
:
null
|
MediaStreamTrack
;
trackId
:
string
;
vadStatus
:
VadStatus
;
addListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
;
emit
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
...
args
:
Parameters
<
TrackContextEvents
[
E
]
>
,
)
:
boolean
;
eventNames
()
:
(
string
|
symbol
)
[]
;
getMaxListeners
()
:
number
;
listenerCount
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
)
:
number
;
listeners
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
)
:
TrackContextEvents
[
E
]
[]
;
off
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
;
on
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
;
once
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
;
prependListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
;
prependOnceListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
;
rawListeners
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
)
:
TrackContextEvents
[
E
]
[]
;
removeAllListeners
<
E
extends
keyof
TrackContextEvents
>
(
event
?:
E
)
:
this
;
removeListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
;
setMaxListeners
(
maxListeners
:
number
)
:
this
;
}
Hierarchy
TypedEventEmitter
<
TrackContextEvents
>
FishjamTrackContext
Index
Properties
encoding?
encoding
Reason?
endpoint
max
Bandwidth?
metadata?
simulcast
Config?
stream
track
track
Id
vad
Status
Methods
add
Listener
emit
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Max
Listeners
Properties
Optional
Readonly
encoding
encoding
?:
Variant
Optional
Readonly
encoding
Reason
encodingReason
?:
EncodingReason
Readonly
endpoint
endpoint
:
Endpoint
Optional
Readonly
max
Bandwidth
maxBandwidth
?:
TrackBandwidthLimit
Optional
Readonly
metadata
metadata
?:
TrackMetadata
Optional
Readonly
simulcast
Config
simulcastConfig
?:
SimulcastConfig
Readonly
stream
stream
:
null
|
MediaStream
Readonly
track
track
:
null
|
MediaStreamTrack
Readonly
track
Id
trackId
:
string
Readonly
vad
Status
vadStatus
:
VadStatus
Methods
add
Listener
addListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
listener
:
TrackContextEvents
[
E
]
Returns
this
emit
emit
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
...
args
:
Parameters
<
TrackContextEvents
[
E
]
>
,
)
:
boolean
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
...
args
:
Parameters
<
TrackContextEvents
[
E
]
>
Returns
boolean
event
Names
eventNames
()
:
(
string
|
symbol
)
[]
Returns (
string
|
symbol
)
[]
get
Max
Listeners
getMaxListeners
()
:
number
Returns
number
listener
Count
listenerCount
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
)
:
number
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
Returns
number
listeners
listeners
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
)
:
TrackContextEvents
[
E
]
[]
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
Returns
TrackContextEvents
[
E
]
[]
off
off
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
listener
:
TrackContextEvents
[
E
]
Returns
this
on
on
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
listener
:
TrackContextEvents
[
E
]
Returns
this
once
once
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
listener
:
TrackContextEvents
[
E
]
Returns
this
prepend
Listener
prependListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
listener
:
TrackContextEvents
[
E
]
Returns
this
prepend
Once
Listener
prependOnceListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
listener
:
TrackContextEvents
[
E
]
Returns
this
raw
Listeners
rawListeners
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
)
:
TrackContextEvents
[
E
]
[]
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
Returns
TrackContextEvents
[
E
]
[]
remove
All
Listeners
removeAllListeners
<
E
extends
keyof
TrackContextEvents
>
(
event
?:
E
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
Optional
event
:
E
Returns
this
remove
Listener
removeListener
<
E
extends
keyof
TrackContextEvents
>
(
event
:
E
,
listener
:
TrackContextEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
TrackContextEvents
Parameters
event
:
E
listener
:
TrackContextEvents
[
E
]
Returns
this
set
Max
Listeners
setMaxListeners
(
maxListeners
:
number
)
:
this
Parameters
maxListeners
:
number
Returns
this
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
encoding
encoding
Reason
endpoint
max
Bandwidth
metadata
simulcast
Config
stream
track
track
Id
vad
Status
Methods
add
Listener
emit
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Max
Listeners
Fishjam Web SDK - v0.12.0
Loading...