Skip to content
Caprid
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Getting started
Overview
Quickstart
Core concepts
Build with AI agents
Guides
Switchboard
Organizations and Namespaces
Credentials
Prod and staging
AI agents
Running a Self-hosted relay
SDKs
TypeScript
Overview
Guide
@caprid/relay-quic
@caprid/relay-websocket
@caprid/moq-media
@caprid/moq-mediabunny
@caprid/moq-core
Changelog
Python
Overview
Guide
caprid-moq-media
caprid-moq-core
Changelog
API reference
Overview
HTTP APIs
Account API
Overview
Account
Overview
Show a signup in progress
Create an Account
Sign in with WorkOS
Log in
Finish signing in with WorkOS
Log out
Get the caller
Organizations
Overview
List your Organizations
Create an Organization
Get an Organization
Rename an Organization
Members
Overview
List an Organization's Members
Remove a Member, or leave
Change a Member's role
Invitations
Overview
List an Organization's pending Invitations
Invite someone
Revoke an Invitation
List the Invitations to your email
Accept an Invitation
Namespaces
Overview
List an Organization's Namespaces
Create a Namespace
Get a Namespace
Delete a Namespace
Change a Namespace's settings
API keys
Overview
List API keys
Create an API key
Revoke an API key
Signing keys
Overview
List Signing keys
Create a Signing key
Get a Signing key
Delete a Signing key
Client tokens
Overview
Mint a Client token
Check a Client token
Self-hosted relays
Overview
List pending enrollments
Create a Relay enrollment token
Revoke a pending enrollment
List your Nodes
Delete a Node
Before Organizations
Overview
Change the Namespace's settings
List API keys
Create an API key
Revoke an API key
List Signing keys
Create a Signing key
Get a Signing key
Delete a Signing key
Mint a Client token
Check a Client token
List pending enrollments
Create a Relay enrollment token
Revoke a pending enrollment
List your Nodes
Delete a Node
Agents
Overview
Instructions for an Agent
Where an Agent registers
Health
Overview
Health check
Relay plane API
Overview
Enrollment
Overview
Exchange a Relay enrollment token for a Node key
Peer discovery
Overview
Get the relay's peers
Admission
Overview
Decide whether a session may start
Health
Overview
Health check
SDKs
TypeScript
Overview
@caprid/moq-core
Overview
index
wire
@caprid/moq-media
Overview
Interfaces
AudioCutRange
AudioInputClock
AudioInputJoinPhases
AudioInputOptions
AudioInputStats
AudioPlayer
AudioPlayerContext
AudioPlayerGainNode
AudioPlayerInput
AudioPlayerJoinPhases
AudioPlayerNode
AudioPlayerOptions
AudioTrackInfo
BroadcastClock
BroadcastClockOptions
ChunkToLocFrameOptions
ComposeMoqSourceOptions
DataTrackInfo
EchoCancellationContext
EchoCancellationLoopback
EchoCancellationLoopbackOptions
FrameHold
FrameHoldStats
FrameSequencer
FrameSequencerOptions
FrameSequencerStats
Interrupt
InterruptInput
LocFrame
LocPropertiesOptions
LocTimestampOptions
MediaTimeline
MediaTimelineEntry
MediaTimelineEntryInput
MediaTimelineOptions
MediaTimelineTrackInfo
MissingGroups
MsfCatalog
MsfCatalogInput
MsfCatalogTrack
MsfEndCatalogInput
MsfTrackGroup
ParseMsfCatalogOptions
PlayoutClock
PlayoutClockOptions
PlayoutDrop
PlayoutShow
PlayoutWait
RenderClock
RenderClockOptions
RenderObservation
SampleTimeline
SampleTimelineOptions
SequencedFrame
SequencerPoll
SourceTimeline
SourceTimelineOptions
TimestampPlayoutOptions
Transcript
TranscriptCutRange
TranscriptLine
TranscriptSegment
TranscriptSegmentInput
VideoTrackInfo
WarmAudioPlayerOptions
Type Aliases
AudioPlayerFrame
FrameDiscontinuity
MediaTrackInfo
MicrosecondClock
PlayoutDecision
PlayoutMode
Variables
AUDIO_ONLY_TARGET_LATENCY_US
AUDIO_TRACK
CATALOG_TRACK
INTERRUPT_TRACK
LOC_AUDIO_CONFIG
LOC_DOCUMENT
LOC_TIMESCALE
LOC_TIMESTAMP
LOC_VIDEO_CONFIG
MEDIA_TIMELINE_TRACK
MICROSECONDS_PER_SECOND
MSF_CATALOG_VERSION
MSF_DOCUMENT
TRANSCRIPT_TRACK
VIDEO_TRACK
Functions
audioDecoderConfigFromTrack
audioTrackFromDecoderConfig
avcCodecString
buildInterrupt
buildMediaTimeline
buildMsfCatalog
buildMsfEndCatalog
buildTranscriptSegment
chunkToLocFrame
composeMoqSource
createAudioPlayer
createBroadcastClock
createEchoCancellationLoopback
createFrameHold
createFrameSequencer
createMediaTimeline
createPlayoutClock
createRenderClock
createTranscript
encodeNameComponent
encodeNamespaceName
findReplacementTrack
groupMsfTracks
locProperties
locTimestampUs
locTrackProperties
mediaTimelineEntry
opusPacketDurationUs
parseInterrupt
parseMediaTimeline
parseMsfCatalog
parseTranscriptSegment
videoTrackFromDecoderConfig
warmAudioPlayer
@caprid/moq-mediabunny
Overview
Interfaces
LocFrame
PacketToLocFrameOptions
Functions
audioTrackFromDecoderConfig
packetToLocFrame
videoTrackFromDecoderConfig
@caprid/relay
Overview
index
media
node
References
ConnectRelayOptions
ConnectRelayPublisherOptions
ConnectRelaySubscriberOptions
ConnectSupervisedPublisherOptions
ConnectSupervisedSubscriberOptions
DEFAULT_ENDPOINT
Goaway
KeyValuePair
LocationFilter
MessageParameters
MoqtObject
MoqTrackSource
MoqtTransport
NamespaceEvent
NamespaceEventOptions
NamespaceEvents
PublishDone
PublisherGeneration
PublishProperty
readJSON
readText
RegisterTrackOptions
RelayCredential
RelayError
RelayErrorCode
RelayErrorPhase
RelayGroupWriter
RelayPublisher
RelaySubscriber
RelaySubscription
RelaySubscriptionHandlers
RelayTrackOptions
RelayTrackWriter
RelayTransportFactory
RequestError
RestartReason
roomEndpoint
SubscribeOk
Subscription
SubscriptionConnectionClosedError
SubscriptionEnd
SubscriptionEndKind
SubscriptionEvent
SubscriptionEventOptions
SubscriptionEvents
SubscriptionHandlers
SubscriptionOverflowError
SubscriptionRequestError
SupervisedPublisher
SupervisedStatus
SupervisedSubscriber
SupervisionBackoff
SwitchableHandlers
SwitchableSubscription
SwitchedInfo
SwitchOptions
WantHandlers
WantOptions
WantSwitchedInfo
WantTarget
@caprid/relay-quic
Overview
Interfaces
CertificateHash
NativeQuicConnection
NativeQuicMoqtTransport
NativeQuicTransportOptions
Type Aliases
NativeQuicTransportFactory
Functions
nativeQuicTransport
@caprid/relay-websocket
Overview
Classes
WebSocketSessionError
Interfaces
CloseInfo
FallbackConnection
FallbackTransport
WebSocketConnection
WebSocketFallbackOptions
WebSocketMoqtTransport
Type Aliases
FallbackCarrier
FallbackTransportFactory
WebSocketTransportFactory
Functions
createWebSocketTransport
withWebSocketFallback
Python
caprid_relay
caprid_relay.media
caprid_relay.quic
moq_core
moq_media
moq_media.opus
SDK specification
Overview
Behavior contract
Vocabulary
Transport adapters
Relay interoperability
Publisher recovery
Media layer (proposal)
Test vectors
GitHub
Select theme
Dark
Light
Auto
TypeScript API reference
Copy as Markdown
View .md
Open in Claude
Open in ChatGPT
Packages
Section titled “Packages”
@caprid/moq-core
@caprid/moq-media
@caprid/moq-mediabunny
@caprid/relay
@caprid/relay-quic
@caprid/relay-websocket