Skip to content

Interface: ClientEvents ​

Every event a MOQtailClient emits, keyed by name, with the listener signature each one calls. Attach with on().

Properties ​

dataevent ​

dataevent: (event) => void

A data stream opened, carried an object (identity and size only), or ended.

Parameters ​

event ​

DataEvent

Returns ​

void


datagramreceived ​

datagramreceived: (data) => void

A datagram arrived.

Parameters ​

data ​

Datagram

Returns ​

void


datagramsent ​

datagramsent: (data) => void

A datagram was written.

Parameters ​

data ​

Datagram

Returns ​

void


datareceived ​

datareceived: (data) => void

A data stream header or object was decoded.

Parameters ​

data ​

FetchHeader | FetchObject | SubgroupObject | SubgroupHeader

Returns ​

void


datasent ​

datasent: (data) => void

A data stream header or object was written.

Parameters ​

data ​

FetchHeader | FetchObject | SubgroupObject | SubgroupHeader

Returns ​

void


forwardstatechange ​

forwardstatechange: (requestId, forward) => void

The peer moved the Forward State of a track this side publishes, in its PUBLISH_OK or a later REQUEST_UPDATE. requestId is the one MOQtailClient.publish returned. A publication that declared FORWARD=0 sends nothing until this reports true.

Parameters ​

requestId ​

bigint

forward ​

boolean

Returns ​

void


goaway ​

goaway: (msg) => void

A GOAWAY arrived: the session is winding down, or a request is moving to a new session.

Parameters ​

msg ​

GoAway

Returns ​

void


messagereceived ​

messagereceived: (msg) => void

A control message arrived, before it is handled.

Parameters ​

msg ​

ControlMessage

Returns ​

void


messagesent ​

messagesent: (msg) => void

A control message was written, on the control stream or a request stream.

Parameters ​

msg ​

ControlMessage

Returns ​

void


namespacepublished ​

namespacepublished: (msg) => void

A PUBLISH_NAMESPACE arrived.

Parameters ​

msg ​

PublishNamespace

Returns ​

void


orderinggap ​

orderinggap: (requestId, from, to) => void

An ordered request stopped waiting for expected locations: from from (inclusive) to to (exclusive), the next object it released. See ObjectOrdering.

Parameters ​

requestId ​

bigint

from ​

Location

to ​

Location

Returns ​

void


peernamespace ​

peernamespace: (prefix, suffix) => void

A NAMESPACE arrived on a SUBSCRIBE_NAMESPACE stream.

Parameters ​

prefix ​

Tuple

suffix ​

Tuple

Returns ​

void


peernamespacedone ​

peernamespacedone: (prefix, suffix) => void

A NAMESPACE_DONE arrived on a SUBSCRIBE_NAMESPACE stream.

Parameters ​

prefix ​

Tuple

suffix ​

Tuple

Returns ​

void


peerpublish ​

peerpublish: (msg, stream) => void

The peer pushed a track. Only one reader can lock stream, so listeners check the track first and only the one that wants it reads it.

Parameters ​

msg ​

Publish

stream ​

ReadableStream<MoqtObject>

Returns ​

void


peerpublishdone ​

peerpublishdone: (msg, requestId) => void

A PUBLISH_DONE arrived. requestId is the request its stream opened: for a pushed track, the requestId of the Publish from peerpublish.

Parameters ​

msg ​

PublishDone

requestId ​

bigint

Returns ​

void


peerpublishskipped ​

peerpublishskipped: (prefix, msg) => void

The peer has a track matching a MOQtailClient.subscribeTracks prefix but no stream to send its PUBLISH on yet (§10.20). prefix is the subscribed prefix.

Parameters ​

prefix ​

Tuple

msg ​

PublishSkipped

Returns ​

void


peersubscribenamespace ​

peersubscribenamespace: (msg) => void

A SUBSCRIBE_NAMESPACE arrived.

Parameters ​

msg ​

SubscribeNamespace

Returns ​

void


peersubscribetracks ​

peersubscribetracks: (msg) => void

A SUBSCRIBE_TRACKS arrived. The PUBLISH sent for each matching track states the request's settings from MessageParameter.publishParametersFor(msg.parameters), and goes without Track Properties when MessageParameter.includesProperties(msg.parameters) is false.

Parameters ​

msg ​

SubscribeTracks

Returns ​

void


sessionterminated ​

sessionterminated: (reason?) => void

The session ended, normally or on error. Fires once, with the reason given to disconnect.

Parameters ​

reason? ​

unknown

Returns ​

void