More docs for v1.2 #923

FelonEkonom · 2024-12-19T16:51:24Z

Closes #872

specs examples, including mermaid graphs visualizing children topology
examples of starting timer with usage of Membrane.Time (Membrane.Time was the problem)
lifecycle of Element / Bin / Pipeline

assets/images/spec_with_audio.svg

guides/components_lifecycle.md

guides/timer.md

guides/components_lifecycle.md

mat-hek · 2025-01-08T14:44:33Z

guides/components_lifecycle.md

+Following `handle_init/2` is `handle_setup/2`, which is executed asynchronously. This is an optimal time to set up resources or perform other intensive operations required for the element to function properly.
+
+## Linking pads
+For components with pads having `availability: :on_request`, the corresponding `handle_pad_added/3` callbacks are called between `handle_setup/2` and `handle_playing/2` if they are linked in the same spec where the component was spawned. Linking the pad in a different spec from the one spawning the element may lead to `handle_pad_added/3` being invoked after `handle_playing/2`.


As we spoke recently, I believe that linking happens only after the child setup is completed, see https://github.com/membraneframework/membrane_core/blob/master/lib/membrane/core/lifecycle_controller.ex#L14 and

membrane_core/lib/membrane/core/parent/child_life_controller.ex

Line 92 in ac6b793

- Wait until all children are initialized and all dependent specs are fully handled. Dependent specs are

mat-hek · 2025-01-08T14:46:12Z

guides/timer.md

@@ -0,0 +1,115 @@
+# Timer usage examples
+Exampls below illustrate how to use `:start_timer`, `:timer_interval` and `:stop_timer` actions on the example of `Membrane.Source`, but the API looks the same for all kinds of the Membrane Components


Suggested change

Exampls below illustrate how to use `:start_timer`, `:timer_interval` and `:stop_timer` actions on the example of `Membrane.Source`, but the API looks the same for all kinds of the Membrane Components

Examples below illustrate how to use `:start_timer`, `:timer_interval` and `:stop_timer` actions on the example of `Membrane.Source`, but the API looks the same for all kinds of the Membrane Components

put that through Grammarly to avoid typos

mat-hek · 2025-01-08T14:48:06Z

mix.exs

@@ -146,7 +148,7 @@ defmodule Membrane.Mixfile do
      {:bunch, "~> 1.6"},
      {:ratio, "~> 3.0 or ~> 4.0"},
      # Development
-      {:ex_doc, "~> 0.28", only: :dev, runtime: false},
+      {:ex_doc, "0.34.2", only: :dev, runtime: false},


why this version?

I will check once again but I searched for a version that generates valid docs

varsill · 2025-01-15T13:07:36Z

lib/membrane/pipeline/action.ex

@@ -56,7 +56,7 @@ defmodule Membrane.Pipeline.Action do
  |> get_child(:webrtc_sink)
  ```

-  will result in having following children topology:
+  will result in having the following children's topology:


Suggested change

will result in having the following children's topology:

will result in the following childrens' topology:

childrens' - are you sure? children is already plural 😛

varsill · 2025-01-15T13:13:44Z

guides/components_lifecycle.md


 ### Events
-Events are one type of item that can be sent via an Element's pads and are managed in `handle_event/4`. Events can travel both upstream and downstream relative to the pad’s direction.
+Events are one type of item that can be sent via an Element's pads and are managed in `handle_event/4`. Events are the only things that can travel both upstream and downstream relative to the pad’s direction - all other types of data sent through pads have to follow the direction of the link.


Suggested change

Events are one type of item that can be sent via an Element's pads and are managed in `handle_event/4`. Events are the only things that can travel both upstream and downstream relative to the pad’s direction - all other types of data sent through pads have to follow the direction of the link.

Events are one type of data that can be sent via an Element's pads and are managed in `handle_event/4`. Events are the only items that can travel both upstream and downstream - all other types of data sent through pads have to follow the direction of the link.

varsill · 2025-01-15T13:15:00Z

lib/membrane/bin/action.ex

@@ -63,7 +63,7 @@ defmodule Membrane.Bin.Action do
  |> get_child(:webrtc_sink)
  ```

-  will result in having following children topology:
+  will result in having the following children's topology:


Suggested change

will result in having the following children's topology:

will result the following children's topology:

FelonEkonom requested a review from varsill December 19, 2024 16:51

FelonEkonom self-assigned this Dec 19, 2024

Add timer usage examples WiP

2eeb21e

FelonEkonom force-pushed the more-docs branch from 8f882c1 to 2eeb21e Compare December 19, 2024 16:52

FelonEkonom added 3 commits December 20, 2024 14:49

lifecycle guide wip

01e330e

Fix typos

262a31c

Add new guide to mix.exs

3c11ae9

FelonEkonom added the no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md label Dec 23, 2024

FelonEkonom added 6 commits December 30, 2024 14:19

Merge remote-tracking branch 'origin/master' into more-docs

53a8b68

Improve timer guide

a16e2c4

Add mermaid graphs visualising specs WiP

c1e023b

Set version of ex_doc, upgrade timer example

684fa5d

Add svg images visualizing pipeline topology

379711d

Copy spec action doc from bin to pipeline

7362714

FelonEkonom marked this pull request as ready for review January 2, 2025 13:06

FelonEkonom requested a review from mat-hek as a code owner January 2, 2025 13:06

FelonEkonom removed the request for review from varsill January 2, 2025 13:06

FelonEkonom mentioned this pull request Dec 20, 2024

Release v1.2.0 #875

Open

10 tasks

varsill requested changes Jan 8, 2025

View reviewed changes

mat-hek reviewed Jan 8, 2025

View reviewed changes

FelonEkonom added 4 commits January 14, 2025 12:29

Implement suggestion from CR

8c85b6f

Apply grammarly

4c44322

Some upgrades

792bf15

grammarly

f946fdc

FelonEkonom requested review from varsill and mat-hek January 14, 2025 12:01

FelonEkonom added 3 commits January 14, 2025 13:04

Remove unnecessary raise

45acb1d

Upgrade timer demo

09c3cec

Fix typos

e3b02f9

varsill reviewed Jan 15, 2025

View reviewed changes

Apply CR

899b9f7

FelonEkonom requested a review from varsill January 15, 2025 17:44

FelonEkonom added 5 commits January 15, 2025 18:58

Add drawio schemes

dca6e27

Add one more example about specs

d25ddcc

Fix typo

d2d25ca

Add small comment

56a72bd

Merge remote-tracking branch 'origin/master' into more-docs

856b0de

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More docs for v1.2 #923

More docs for v1.2 #923

FelonEkonom commented Dec 19, 2024 •

edited

Loading

mat-hek Jan 8, 2025

mat-hek Jan 8, 2025

mat-hek Jan 8, 2025

FelonEkonom Jan 8, 2025

varsill Jan 15, 2025

FelonEkonom Jan 15, 2025

varsill Jan 15, 2025

varsill Jan 15, 2025

		@@ -0,0 +1,115 @@
		# Timer usage examples
		Exampls below illustrate how to use `:start_timer`, `:timer_interval` and `:stop_timer` actions on the example of `Membrane.Source`, but the API looks the same for all kinds of the Membrane Components

	Exampls below illustrate how to use `:start_timer`, `:timer_interval` and `:stop_timer` actions on the example of `Membrane.Source`, but the API looks the same for all kinds of the Membrane Components
	Examples below illustrate how to use `:start_timer`, `:timer_interval` and `:stop_timer` actions on the example of `Membrane.Source`, but the API looks the same for all kinds of the Membrane Components

	will result in having the following children's topology:
	will result in the following childrens' topology:

	Events are one type of item that can be sent via an Element's pads and are managed in `handle_event/4`. Events are the only things that can travel both upstream and downstream relative to the pad’s direction - all other types of data sent through pads have to follow the direction of the link.
	Events are one type of data that can be sent via an Element's pads and are managed in `handle_event/4`. Events are the only items that can travel both upstream and downstream - all other types of data sent through pads have to follow the direction of the link.

	will result in having the following children's topology:
	will result the following children's topology:

More docs for v1.2 #923

Are you sure you want to change the base?

More docs for v1.2 #923

Conversation

FelonEkonom commented Dec 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FelonEkonom commented Dec 19, 2024 •

edited

Loading