View Source Membrane.ComponentPath (Membrane Core v1.1.2)

A list consisting of following pipeline/bin/element names down the assembled pipeline.

It traces element's path inside a pipeline. Information is being stored in a process dictionary and can be set/appended to.

Link to this section Summary

path()

A list consisting of following pipeline/bin/element names down the assembled pipeline.

format(path)

Returns formatted string of given path's names.

get()

Returns currently stored path.

get_formatted()

Works the same way as format/1 but uses currently stored path.

set(path)

Sets current path.

@type path() :: [String.t()]

A list consisting of following pipeline/bin/element names down the assembled pipeline.

It traces element's path inside a pipeline. Information is being stored in a process dictionary and can be set/appended to.

@spec format(path()) :: String.t()

Returns formatted string of given path's names.

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

Returns currently stored path.

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

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

Works the same way as format/1 but uses currently stored path.

@spec set(path()) :: :ok

Sets current path.

If path had already existed then replaces it.