Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info about change in default flow control value #673

Merged
merged 4 commits into from
Nov 7, 2023
Merged

Add info about change in default flow control value #673

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0d2922
Add info about change in default flow control value
FelonEkonom Nov 6, 2023
774e62e
fix bug in diff
FelonEkonom Nov 6, 2023
c01a191
Swap paragraphs
FelonEkonom Nov 7, 2023
91be1f5
Fix typos
FelonEkonom Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions guides/upgrading/v1.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,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 :output, accepted_format: %MyStruct{field: :value}
+ def_output_pad :output, 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