# index

URL: https://www.caprid.com/docs/reference/typescript/caprid/relay/index/readme/

## Classes

- [RelayError](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/classes/relayerror/)
- [SubscriptionConnectionClosedError](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/classes/subscriptionconnectionclosederror/)
- [SubscriptionOverflowError](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/classes/subscriptionoverflowerror/)
- [SubscriptionRequestError](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/classes/subscriptionrequesterror/)

## Interfaces

- [ConnectRelayOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/connectrelayoptions/)
- [ConnectRelayPublisherOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/connectrelaypublisheroptions/)
- [ConnectRelaySubscriberOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/connectrelaysubscriberoptions/)
- [ConnectSupervisedPublisherOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/connectsupervisedpublisheroptions/)
- [ConnectSupervisedSubscriberOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/connectsupervisedsubscriberoptions/)
- [Goaway](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/goaway/)
- [KeyValuePair](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/keyvaluepair/)
- [MessageParameters](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/messageparameters/)
- [MoqtObject](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/moqtobject/)
- [MoqTrackSource](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/moqtracksource/)
- [MoqtTransport](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/moqttransport/)
- [NamespaceEvent](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/namespaceevent/)
- [NamespaceEventOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/namespaceeventoptions/)
- [NamespaceEvents](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/namespaceevents/)
- [PublishDone](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/publishdone/)
- [PublisherGeneration](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/publishergeneration/)
- [PublishProperty](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/publishproperty/)
- [RegisterTrackOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/registertrackoptions/)
- [RelayCredential](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaycredential/)
- [RelayGroupWriter](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaygroupwriter/)
- [RelayPublisher](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaypublisher/)
- [RelaySubscriber](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaysubscriber/)
- [RelaySubscription](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaysubscription/)
- [RelaySubscriptionHandlers](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaysubscriptionhandlers/)
- [RelayTrackOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaytrackoptions/)
- [RelayTrackWriter](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/relaytrackwriter/)
- [RequestError](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/requesterror/)
- [SubscribeOk](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/subscribeok/)
- [Subscription](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/subscription/)
- [SubscriptionEventOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/subscriptioneventoptions/)
- [SubscriptionEvents](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/subscriptionevents/)
- [SubscriptionHandlers](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/subscriptionhandlers/)
- [SupervisedPublisher](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/supervisedpublisher/)
- [SupervisedSubscriber](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/supervisedsubscriber/)
- [SupervisionBackoff](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/supervisionbackoff/)
- [SwitchableHandlers](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/switchablehandlers/)
- [SwitchableSubscription](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/switchablesubscription/)
- [SwitchedInfo](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/switchedinfo/)
- [SwitchOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/switchoptions/)
- [WantHandlers](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/wanthandlers/)
- [WantOptions](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/wantoptions/)
- [WantSwitchedInfo](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/wantswitchedinfo/)
- [WantTarget](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/interfaces/wanttarget/)

## Type Aliases

- [LocationFilter](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/locationfilter/)
- [RelayErrorCode](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/relayerrorcode/)
- [RelayErrorPhase](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/relayerrorphase/)
- [RelayTransportFactory](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/relaytransportfactory/)
- [RestartReason](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/restartreason/)
- [SubscriptionEnd](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionend/)
- [SubscriptionEndKind](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionendkind/)
- [SubscriptionEvent](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/subscriptionevent/)
- [SupervisedStatus](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/type-aliases/supervisedstatus/)

## Variables

- [DEFAULT\_ENDPOINT](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/variables/default_endpoint/)

## Functions

- [connectRelayPublisher](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/functions/connectrelaypublisher/)
- [connectRelaySubscriber](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/functions/connectrelaysubscriber/)
- [connectSupervisedPublisher](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/functions/connectsupervisedpublisher/)
- [connectSupervisedSubscriber](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/functions/connectsupervisedsubscriber/)
- [readJSON](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/functions/readjson/)
- [readText](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/functions/readtext/)
- [roomEndpoint](https://www.caprid.com/docs/reference/typescript/caprid/relay/index/functions/roomendpoint/)
