Skip to content

Commit 3115694

Browse files
committed
Implement suggestion from CR
1 parent b8e23d3 commit 3115694

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

lib/transcoder.ex

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ defmodule Membrane.Transcoder do
8181
8282
Can be either:
8383
* an atom: `:always`, `:if_needed` (default) or `:never`,
84-
* a function that receives the input stream format and returns an atom.
84+
* a function that receives the input stream format and returns either `:always`,
85+
`:if_needed` or `:never`.
8586
8687
If set to `:always`, the input media stream will be decoded and encoded, even
8788
if the input stream format and the output stream format are the same type.
@@ -90,10 +91,13 @@ defmodule Membrane.Transcoder do
9091
stream format and the output stream format are different types.
9192
This is the default behavior.
9293
93-
If set to `:never`, the input media stream won't be neither decoded nor transcoded.
94+
If set to `:never`, the input media stream won't be neither decoded nor encoded.
9495
Changing alignment, encapsulation or stream structure is still possible. This option
9596
is helpful when you want to ensure that #{inspect(__MODULE__)} will not use too much
9697
of resources, e.g. CPU or memory.
98+
99+
If the transition from the input stream format to the output stream format is not
100+
possible without decoding or encoding the stream, an error will be raised.
97101
"""
98102
]
99103

0 commit comments

Comments
 (0)