Skip to content

Type Alias: SubscribeUpdateOptions ​

SubscribeUpdateOptions = object

Changes applied to an existing SUBSCRIBE via MOQtailClient.subscribeUpdate.

Example ​

Narrowing a live window to groups 200 through 210

ts
await client.subscribeUpdate({
  subscriptionRequestId,
  locationFilter: new LocationFilter(LocationFilterType.AbsoluteStartGroupEnd, 200n, 0n, 210n),
  priority: 16,
  forward: true
})

Properties ​

forward? ​

optional forward?: boolean

Updated direction flag. Omitted, it's not sent and stays unchanged.


locationFilter? ​

optional locationFilter?: LocationFilter

The new LocationFilter. Omitted, the subscription keeps its own.


parameters? ​

optional parameters?: MessageParameter[]

Optional additional parameters; existing parameters persist if omitted.


priority? ​

optional priority?: number

Updated subscriber priority (same constraints as initial subscribe). 0 is highest, 255 is lowest. Omitted, it's not sent and stays unchanged.


subscriptionRequestId ​

subscriptionRequestId: bigint

The original SUBSCRIBE request id (bigint) being updated.