Skip to content

Type Alias: FetchOptions ​

FetchOptions = object

Options for performing a FETCH of Objects already published.

Examples ​

Groups 10 through 12, inclusive

ts
const { requestId, stream } = await client.fetch({
  fullTrackName,
  priority: 64,
  groupOrder: GroupOrder.Original,
  locationFilter: new LocationFilter(LocationFilterType.AbsoluteStartGroupEnd, 10n, 0n, 12n)
})

The current group and the one before it

ts
await client.fetch({
  fullTrackName,
  priority: 32,
  groupOrder: GroupOrder.Original,
  locationFilter: new LocationFilter(LocationFilterType.RelativeStart, 2n)
})

Properties ​

fullTrackName ​

fullTrackName: FullTrackName

Fully qualified track identifier (FullTrackName).


groupOrder ​

groupOrder: GroupOrder

GroupOrder governing sequencing.


locationFilter? ​

optional locationFilter?: LocationFilter

Which Objects to fetch; the end, when the filter has one, is the last Object sent. Without a filter the whole track up to the Largest Object is fetched, and a filter without an end also stops at the Largest Object.


onEndOfRange? ​

optional onEndOfRange?: EndOfRangeHandler

Called for each End of Range marker in the response.


ordering? ​

optional ordering?: ObjectOrdering | "none"

Orders this fetch's objects. Overrides MOQtailClientOptions.ordering.


parameters? ​

optional parameters?: MessageParameter[]

Optional parameters block.


priority ​

priority: number

Request priority (0 = highest, 255 = lowest). Rounded & clamped.