Interface Endpoint<EndpointMetadata, TrackMetadata>

Interface describing Endpoint.

interface Endpoint<EndpointMetadata, TrackMetadata> {
    id: string;
    metadata?: EndpointMetadata;
    metadataParsingError?: any;
    rawMetadata: any;
    tracks: Map<string, TrackContext<EndpointMetadata, TrackMetadata>>;
    type: string;
}

Type Parameters

EndpointMetadata
TrackMetadata

Index

Properties

id metadata? metadataParsingError? rawMetadata tracks type

Properties

id

id: string

Endpoint's id. It is assigned by user in custom logic that use backend API.

`Optional` metadata

metadata?: EndpointMetadata

Any information that was provided in WebRTCEndpoint.connect.

`Optional` metadataParsingError

metadataParsingError?: any

rawMetadata

rawMetadata: any

tracks

tracks: Map<string, TrackContext<EndpointMetadata, TrackMetadata>>

List of tracks that are sent by the endpoint.

type

type: string

Type of the endpoint, e.g. "webrtc", "hls" or "rtsp".