@auvious/rtc / IPublishedStream

Interface: IPublishedStream

publish stream interface, can mute/replace tracks

Hierarchy

• IStream

  ↳ IPublishedStream

Table of contents

Properties

• id
• mediaStream
• originator
• type

Methods

• getMetadata
• isMuted
• mute
• replace
• unmute
• updateMetadata
• updateVideoBitrate

Properties

id

• id: string

streamID or callID

Inherited from

IStream.id

---

mediaStream

• Optional mediaStream: MediaStream

Inherited from

IStream.mediaStream

---

originator

• originator: IEndpoint<{ [key: string]: any; }>

Originator, local or remote

Inherited from

IStream.originator

---

type

• type: StreamType

A [[StreamType]] string

Inherited from

IStream.type

Methods

getMetadata

▸ getMetadata(): Metadata

Returns

Metadata

Inherited from

IStream.getMetadata

---

isMuted

▸ isMuted(kind): boolean

Parameters

Name	Type
kind	"video" | "audio"

Returns

boolean

Inherited from

IStream.isMuted

---

mute

▸ mute(track): Promise<void>

Parameters

Name	Type
track	"video" | "audio"

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	"video" | "audio"
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>