Membrane Core v0.11.3

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

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

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.

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

format(path)

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

Returns formatted string of given path's names.

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()

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

Works the same way as format/1 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.