SubscriptionEvent

type SubscriptionEvent =
  | {
  type: "subscribed";
  value: SubscribeOk;
}
  | {
  type: "object";
  value: MoqtObject;
}
  | {
  type: "publisherDone";
  value: PublishDone;
}
  | {
  type: "subgroupEnd";
  value: {
     endOfGroup: boolean;
     groupId: number;
     subgroupId: number;
  };
}
  | {
  type: "subgroupReset";
  value: {
     error: unknown;
     groupId: number;
  };
}
  | {
  type: "stateNotify";
  value: MessageParameters;
}
  | {
  type: "goaway";
  value: Goaway;
}
  | {
  type: "updateOk";
  value: undefined;
};

Defined in: relay-sdks/ts/src/subscription.ts:29

Delivery order is callback arrival order, with no ordering guarantee across streams.

Union Members

Type Literal

{
  type: "subscribed";
  value: SubscribeOk;
}

type

type: "subscribed";

The relay accepted the subscription (SUBSCRIBE_OK).

value

value: SubscribeOk;

The acceptance info onSubscribed receives.

---

Type Literal

{
  type: "object";
  value: MoqtObject;
}

type

type: "object";

One object arrived, including an object that carries only a protocol status.

value

value: MoqtObject;

The object; its payload is uninterpreted bytes.

---

Type Literal

{
  type: "publisherDone";
  value: PublishDone;
}

type

type: "publisherDone";

The publisher finished with the track (PUBLISH_DONE). Not an ending: trailing objects can follow.

value

value: PublishDone;

The done’s status, stream count and reason.

---

Type Literal

{
  type: "subgroupEnd";
  value: {
     endOfGroup: boolean;
     groupId: number;
     subgroupId: number;
  };
}

type

type: "subgroupEnd";

A subgroup stream finished cleanly (FIN); only that subgroup ended.

value

value: object;

Which subgroup ended.

value.endOfGroup

endOfGroup: boolean;

Whether the subgroup’s header marked it as holding the group’s largest object.

value.groupId

groupId: number;

The group the subgroup belongs to.

value.subgroupId

subgroupId: number;

The subgroup that ended.

---

Type Literal

{
  type: "subgroupReset";
  value: {
     error: unknown;
     groupId: number;
  };
}

type

type: "subgroupReset";

A subgroup stream was reset; objects from it may be missing. Delivery continues.

value

value: object;

Which group the reset stream carried, and why it failed.

value.error

error: unknown;

The transport’s stream error, as the runtime reported it.

value.groupId

groupId: number;

The group the reset subgroup belongs to.

---

Type Literal

{
  type: "stateNotify";
  value: MessageParameters;
}

type

type: "stateNotify";

The publisher changed subscription state on its own (PUBLISH_STATE_NOTIFY).

value

value: MessageParameters;

Only the parameters that changed.

---

Type Literal

{
  type: "goaway";
  value: Goaway;
}

type

type: "goaway";

The relay sent GOAWAY on this request. Informational; the SDK does not retry.

value

value: Goaway;

The relay’s suggested new session URI (may be empty) and timeout.

---

Type Literal

{
  type: "updateOk";
  value: undefined;
}

type

type: "updateOk";

The relay acknowledged an update() (REQUEST_OK).

value

value: undefined;

Always undefined; the acknowledgment carries nothing.