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

Jump to bottom

Update actions docs #580

Merged
merged 3 commits into from
Jul 19, 2023
Merged

Update actions docs #580

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb5b8d9
Update actions docs
FelonEkonom Jul 18, 2023
240fb7c
Update lib/membrane/element/action.ex
FelonEkonom Jul 19, 2023
708b8e8
Merge remote-tracking branch 'origin/master' into update-actions-docs
FelonEkonom Jul 19, 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
25 changes: 14 additions & 11 deletions lib/membrane/element/action.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ defmodule Membrane.Element.Action do

@typedoc """
Executes `c:Membrane.Element.WithOutputPads.handle_demand/5` callback
for the given pad if its demand is greater than 0.
for those given pads, that have demand greater than 0.
FelonEkonom marked this conversation as resolved.
Show resolved Hide resolved

The pad must have output direction and work in pull mode.

Expand Down Expand Up @@ -123,26 +123,29 @@ defmodule Membrane.Element.Action do
## Usage limitations
Allowed only when playback is playing.
"""
@type redemand :: {:redemand, Pad.ref()}
@type redemand :: {:redemand, Pad.ref() | [Pad.ref()]}

@typedoc """
Sends buffers/stream format/event to all output pads of element (or to input pads when
event occurs on the output pad).
Sends buffers/stream format/event/end of stream to all output pads of element (or to input
pads when event occurs on the output pad).

Used by default implementations of
`c:Membrane.Element.WithInputPads.handle_stream_format/4` and
`c:Membrane.Element.Base.handle_event/4` callbacks in filter.
`c:Membrane.Element.WithInputPads.handle_stream_format/4`,
`c:Membrane.Element.Base.handle_event/4` and
`c:Membrane.Element.WithInputPads.handle_end_of_stream/3` callbacks in filter.

Allowed only when _all_ below conditions are met:
- element is filter,
- callback is `c:Membrane.WithInputPads.handle_buffers_batch/4`,
`c:Membrane.Element.WithInputPads.handle_stream_format/4`
or `c:Membrane.Element.Base.handle_event/4`,
- callback is `c:Membrane.Element.WithInputPads.handle_buffers_batch/4`,
`c:Membrane.Element.WithInputPads.handle_buffer/4`,
`c:Membrane.Element.WithInputPads.handle_stream_format/4`,
`c:Membrane.Element.Base.handle_event/4` or `c:Membrane.Element.WithInputPads.handle_end_of_stream/3`
- playback is `playing`

Keep in mind that `c:Membrane.WithInputPads.handle_buffers_batch/4` can only
forward buffers, `c:Membrane.Element.WithInputPads.handle_stream_format/4` - stream formats
and `c:Membrane.Element.Base.handle_event/4` - events.
forward buffers, `c:Membrane.Element.WithInputPads.handle_stream_format/4` - stream formats.
`c:Membrane.Element.Base.handle_event/4` - events and
`c:Membrane.Element.WithInputPads.handle_end_of_stream/3` - ends of streams.
"""
@type forward ::
{:forward, Buffer.t() | [Buffer.t()] | StreamFormat.t() | Event.t() | :end_of_stream}
Expand Down
Loading