ColorGroup

class pybmd.color_group.ColorGroup(color_group)

Bases: object

docstring for ColorGroup.

Methods

__init__(color_group)
get_clips_in_timeline(timeline)	Returns a list of TimelineItem that are in colorGroup in the given Timeline.
get_name()	Returns the name (string) of the ColorGroup.
get_post_clip_node_graph()	Returns the ColorGroup Post-clip graph.
get_pre_clip_node_graph()	Returns the ColorGroup Pre-clip graph.
set_name(group_name)	Renames ColorGroup to groupName (string).

get_name() → str

Returns the name (string) of the ColorGroup.

Returns:

name of the ColorGroup.

Return type:

str

set_name(group_name: str) → bool

Renames ColorGroup to groupName (string).

Parameters:

group_name (str) – color group name

Returns:

Returns True if successful, False otherwise.

Return type:

bool

get_clips_in_timeline(timeline: Timeline) → List[TimelineItem]

Returns a list of TimelineItem that are in colorGroup in the given Timeline.

Parameters:

timeline (Timeline) – Timeline is Current Timeline by default.

Returns:

a list of TimelineItem that are in colorGroup in the given Timeline.

Return type:

List[TimelineItem]

get_pre_clip_node_graph() → Graph

Returns the ColorGroup Pre-clip graph.

Returns:

ColorGroup Pre-clip graph

Return type:

Graph

get_post_clip_node_graph() → Graph

Returns the ColorGroup Post-clip graph.

Returns:

ColorGroup Post-clip graph

Return type:

Graph