Migrate the guide to the getting started tutorial #82
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Noarkhh
approved these changes
Sep 14, 2023
FelonEkonom
requested changes
Sep 27, 2023
|
|
||
| ### Membrane packages | ||
|
|
||
| To embrace modularity, Membrane is delivered to you in multiple packages, including plugins, formats, core and standalone libraries. The complete list of all the Membrane packages maintained by the Membrane team is available [here](https://github.com/membraneframework/membrane_core/Membrane-packages). |
There was a problem hiding this comment.
| The callback is called whenever a buffer arrives on a pad, and receives four arguments: | ||
| - the pad where the buffer arrived, | ||
| - the [Membrane.Buffer](https://hexdocs.pm/membrane_core/Membrane.Buffer.html) structure carrying the stream data, | ||
| - [Membrane.Element.CallbackContext](https://hexdocs.pm/membrane_core/Membrane.Element.CallbackContext.html), providing some useful information about the element, |
There was a problem hiding this comment.
Suggested change
| - [Membrane.Element.CallbackContext](https://hexdocs.pm/membrane_core/Membrane.Element.CallbackContext.html), providing some useful information about the element, | |
| - [Membrane.Element.CallbackContext.t()](https://hexdocs.pm/membrane_core/Membrane.Element.CallbackContext.html#t:t/0), providing some useful information about the element, |
There was a problem hiding this comment.
is there any difference?
There was a problem hiding this comment.
Especially this typespec describes a map, not a structure
Comment on lines
+9
to
+11
| ## Bin's pads | ||
|
|
||
| Bin's pads are defined and linked similarly to element's pads. However, their role is limited to proxy the stream to other elements and bins inside (inputs) or outside (outputs). To achieve that, each input pad of a bin needs to be linked to both an output pad from the outside of a bin and an input pad of its child inside. Accordingly, each bin's output should be linked to output inside and input outside of the bin. |
There was a problem hiding this comment.
It would be nice to have an example showing how to link bin's pad from inside, using bin_input/1 and bin_output/2
There was a problem hiding this comment.
I'll do that in a separate PR
|
|
||
| ```elixir | ||
| import Config | ||
| config :membrane_core, :logger, verbose: true |
There was a problem hiding this comment.
I would notice, that it is necessary to recompile modules after changing this config
Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>
Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>
FelonEkonom
reviewed
Oct 4, 2023
| * `:auto` - Membrane automatically manages the flow control. It works under the assumption that the element does not need to block or slow down the processing rate, it just processes or consumes the stream as it flows. This option is not available for `Source` elements. | ||
| * `:manual` - You need to manually control the flow control by using the `demand` action on `input` pads and implementing the `handle_demand` callback for `output` pads. | ||
| * `:push` - It's a simple mode where an element producing data pushes it right away through the `output` pad. An `input` pad in this mode should be always ready to process that data. | ||
| * `demand_unit` - Either `:bytes` or `:buffers`, specifies what unit will be used to request or receive demands. Must be specified if `flow_control` is set to `:manual`. |
|
|
||
| * `accepted_format` - a pattern for a stream format expected on the pad, for example `%Membrane.RawAudio{channels: 2}`. It serves documentation purposes and is validated in runtime. | ||
| * `flow_control` - configures how back pressure should be handled on the pad. You can choose from the following options: | ||
| * `auto` - Membrane automatically manages the flow control. It works under the assumption that the element does not need to block or slow down the processing rate, it just processes or consumes the stream as it flows. This option is not available for `Source` elements. |
There was a problem hiding this comment.
Comment above is still valid
FelonEkonom
approved these changes
Oct 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TODO:
Getting Startedtutorial