---
url: https://docs.moqtail.dev/ts/api/client/type-aliases/SwitchOptions.md
---
# Type Alias: SwitchOptions

> **SwitchOptions** = `object`

Parameters for [switching](../classes/MOQtailClient.md#switch) an existing SUBSCRIBE to a new track.

## Example

**Switching a subscription to a new track**

```ts
await client.switch({
  switchFromRequestId,
  switchMode: SwitchMode.Soft,
  newSubscribeOptions: {
    fullTrackName: newFullTrackName,
    priority: 0,
    groupOrder: GroupOrder.Original,
    locationFilter: new LocationFilter(LocationFilterType.NextObject)
  }
})
```

## Properties

### newSubscribeOptions

> **newSubscribeOptions**: `Omit`<[`SubscribeOptions`](SubscribeOptions.md), `"forward"`>

New subscription options to switch to. No `forward`: the relay controls forwarding during a switch.

***

### onDrainDecision?

> `optional` **onDrainDecision?**: (`request`) => `boolean`

Called for each object of a superseded subscription that a soft switch left draining.
Returning false ends the drain: that subscription is retired and the new track's
objects, held until then, are released.

#### Parameters

##### request

[`SubscribeRequest`](../classes/SubscribeRequest.md)

#### Returns

`boolean`

***

### switchFromRequestId

> **switchFromRequestId**: `bigint`

The original SUBSCRIBE request id (bigint) being switched from.

***

### switchMode

> **switchMode**: [`SwitchMode`](../../model/enumerations/SwitchMode.md)

[SwitchMode](../../model/enumerations/SwitchMode.md) controlling how the switch is applied.
