Skip to main content

modules

@auvious/rtc / Exports

@auvious/rtc

Description

Auvious Rtc Api Module Description it is.

Table of contents

Classes

Interfaces

Type Aliases

Type Aliases

ConferenceMetadata

Ƭ ConferenceMetadata: Object

Index signature

[key: string]: IConferenceMetadata


ConferenceMetadataOperation

Ƭ ConferenceMetadataOperation: "SET" | "REMOVE"


ConferenceSessionEvent

Ƭ ConferenceSessionEvent: "connecting" | "accepted" | "endpointJoined" | "endpointMetadataUpdated" | "endpointLeft" | "endpointGotSick" | "endpointRecovered" | "publishStreamFailed" | "streamAdded" | "streamPublished" | "streamMetadataUpdated" | "streamRemoved" | "streamWarning" | "streamFailed" | "streamRecovered" | "trackMuted" | "trackUnmuted" | "holdUpdated" | "ended" | "failed" | "networkQualityReport" | "conferenceMetadataSet" | "conferenceMetadataRemoved"


Metadata

Ƭ Metadata: Object

Metadata is a map with string keys and values can be anything.

Index signature

[key: string]: any


SessionEvent

Ƭ SessionEvent: "connecting" | "ringing" | "accepted" | "streamAdded" | "streamRemoved" | "ended" | "failed"

Session event types.


StreamType

Ƭ StreamType: "mic" | "cam" | "video" | "screen" | "unknown"

Stream types enum.


StringMetadata

Ƭ StringMetadata: Object

Index signature

[key: string]: string


UAEvent

Ƭ UAEvent: "connecting" | "connected" | "disconnected" | "connectionError" | "registered" | "unregistered" | "registrationFailed" | "warning" | "newSession" | "newConferenceSession" | "conferenceCreated" | "createConferenceFailed" | "newMessage"

Auvious User Agent event types.


ViewStreamMetadataProvider

Ƭ ViewStreamMetadataProvider: (stream: IStream) => StringMetadata

Type declaration

▸ (stream): StringMetadata

Parameters
NameType
streamIStream
Returns

StringMetadata