Skip to main content

IPublishedStream

@auvious/rtc / Exports / IPublishedStream

Interface: IPublishedStream

publish stream interface, can mute/replace tracks

Hierarchy

Table of contents

Properties

Methods

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

NameType
kind"audio" | "video"

Returns

boolean

Inherited from

IStream.isMuted


mute

mute(track): Promise<void>

Parameters

NameType
track"audio" | "video"

Returns

Promise<void>


replace

replace(track, send): Promise<void>

Parameters

NameType
trackMediaStreamTrack
sendMediaStreamTrack

Returns

Promise<void>


unmute

unmute(kind, track?): Promise<void>

Parameters

NameType
kind"audio" | "video"
track?MediaStreamTrack

Returns

Promise<void>


updateMetadata

updateMetadata(metadata): Promise<void>

Parameters

NameType
metadataMetadata

Returns

Promise<void>


updateVideoBitrate

updateVideoBitrate(bitrate): Promise<void>

Parameters

NameType
bitratenumber

Returns

Promise<void>