Skip to content

Commit

Permalink
Swap paragraphs
Browse files Browse the repository at this point in the history
  • Loading branch information
FelonEkonom committed Nov 7, 2023
1 parent 774e62e commit c01a191
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions guides/upgrading/v1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,29 +51,6 @@ end
end
```

### Adjust to change in default `flow_control` (aka. `mode`/`demand_mode`) value.

Now, if definition of pad in element does specify type of

Now, the default value of `flow_control` option in `def_input_pad` and `def_output_pad` in Elements is `:auto`. Until `v0.12.9`, pads that sepcified neither `flow_control`, `mode` nor `demand_mode` explicitly would have `:manual` `flow_control`. Therefore, `:manual` pads that haven't specified `flow_control` value, now have to do it explicitly.

```diff
- def_output_pad :input, accepted_format: %MyStruct{field: :value}
+ def_output_pad :input, accepted_format: %MyStruct{field: :value}, flow_control: :manual
```

```diff
- def_input_pad :input, accepted_format: %MyStruct{field: :value}, demand_unit: :buffers
+ def_input_pad :input, accepted_format: %MyStruct{field: :value}, demand_unit: :buffers, flow_control: :manual
```

Moreover, you can remove `flow_control: :auto` from the pad definitions, if you want to.

```diff
- def_input_pad :input, accepted_format: %MyStruct{field: :value}, flow_control: :auto
+ def_input_pad :input, accepted_format: %MyStruct{field: :value}
```

### Change `mode` and `demand_mode` options to `flow_control` in pads' definitions in elements

For input pads, change:
Expand Down Expand Up @@ -113,6 +90,29 @@ use Membrane.Filter

Check `t:Membrane.Pad.element_spec/0` for details.

### Adjust to change in default `flow_control` (aka. `mode`/`demand_mode`) value.

Now, if definition of pad in element does specify type of

Now, the default value of `flow_control` option in `def_input_pad` and `def_output_pad` in Elements is `:auto`. Until `v0.12.9`, pads that sepcified neither `flow_control`, `mode` nor `demand_mode` explicitly would have `:manual` `flow_control`. Therefore, `:manual` pads that haven't specified `flow_control` value, now have to do it explicitly.

```diff
- def_output_pad :input, accepted_format: %MyStruct{field: :value}
+ def_output_pad :input, accepted_format: %MyStruct{field: :value}, flow_control: :manual
```

```diff
- def_input_pad :input, accepted_format: %MyStruct{field: :value}, demand_unit: :buffers
+ def_input_pad :input, accepted_format: %MyStruct{field: :value}, demand_unit: :buffers, flow_control: :manual
```

Moreover, you can remove `flow_control: :auto` from the pad definitions, if you want to.

```diff
- def_input_pad :input, accepted_format: %MyStruct{field: :value}, flow_control: :auto
+ def_input_pad :input, accepted_format: %MyStruct{field: :value}
```

### Remove `mode` and `demand_unit` from pads definitions in bins

```diff
Expand Down

0 comments on commit c01a191

Please sign in to comment.