IPublishedStream
@auvious/rtc / Exports / IPublishedStream
Interface: IPublishedStream
publish stream interface, can mute/replace tracks
Hierarchy
↳
IPublishedStream
Table of contents
Properties
Methods
Properties
id
• id: string
streamID or callID
Inherited from
mediaStream
• Optional
mediaStream: MediaStream
Inherited from
originator
• originator: IEndpoint
<{ [key: string]
: any
; }>
Originator, local or remote
Inherited from
type
• type: StreamType
A StreamType string
Inherited from
Methods
getMetadata
▸ getMetadata(): Metadata
Returns
Inherited from
isMuted
▸ isMuted(kind
): boolean
Parameters
Name | Type |
---|---|
kind | "audio" | "video" |
Returns
boolean
Inherited from
mute
▸ mute(track
): Promise
<void
>
Parameters
Name | Type |
---|---|
track | "audio" | "video" |
Returns
Promise
<void
>
replace
▸ replace(track
, send
): Promise
<void
>
Parameters
Name | Type |
---|---|
track | MediaStreamTrack |
send | MediaStreamTrack |
Returns
Promise
<void
>
unmute
▸ unmute(kind
, track?
): Promise
<void
>
Parameters
Name | Type |
---|---|
kind | "audio" | "video" |
track? | MediaStreamTrack |
Returns
Promise
<void
>
updateMetadata
▸ updateMetadata(metadata
): Promise
<void
>
Parameters
Name | Type |
---|---|
metadata | Metadata |
Returns
Promise
<void
>
updateVideoBitrate
▸ updateVideoBitrate(bitrate
): Promise
<void
>
Parameters
Name | Type |
---|---|
bitrate | number |
Returns
Promise
<void
>