Membrane Core v0.10.2

View Source Membrane.ComponentPath (Membrane Core v0.10.2)

Traces element's path inside a pipeline. Path is a list consisted of following pipeline/bin/element names down the assembled pipeline. Information is being stored in a process dictionary and can be set/appended to.

Link to this section Summary

Types

path_t()

Functions

append(name)

Appends given name to the current path.

format(path, separator \\ "/")

Returns formatted string of given path's names joined with separator.

get()

Returns currently stored path.

get_formatted(separator \\ "/")

Works the same as format/2 but uses currently stored path

set(path)

Sets current path.

set_and_append(path, name)

Convenient combination of set/1 and append/1.

Link to this section Types

Link to this type

path_t()

View Source 
@type path_t() :: [String.t()]

Link to this section Functions

Link to this function

append(name)

View Source 
@spec append(String.t()) :: :ok

Appends given name to the current path.

If path has not been previously set then creates new one with given name.

Link to this function

format(path, separator \\ "/")

View Source 
@spec format(path_t(), String.t()) :: String.t()

Returns formatted string of given path's names joined with separator.

Link to this function

get()

View Source 
@spec get() :: [String.t()]

Returns currently stored path.

If path has not been set, empty list is returned.

Link to this function

get_formatted(separator \\ "/")

View Source 
@spec get_formatted(String.t()) :: String.t()

Works the same as format/2 but uses currently stored path

Link to this function

set(path)

View Source 
@spec set(path_t()) :: :ok

Sets current path.

If path had already existed then replaces it.

Link to this function

set_and_append(path, name)

View Source 
@spec set_and_append(path_t(), String.t()) :: :ok

Convenient combination of set/1 and append/1.