UseTimelineClipGroupsResult API

Signature

Interface UseTimelineClipGroupsResult

Name	Signature	Description
`getClipGroup`	`(groupId: string): TimelineClipGroup \| undefined`	Returns one clip group by id.
`getClipGroupClips`	`(groupId: string): TimelineClipEntry<string>[]`	Returns clips contained by a group in group order.
`getClipGroupForClip`	`(clipId: string): TimelineClipGroup \| undefined`	Returns the clip group containing a clip.
`groupClips`	`(clipIds: typeOperator, label?: string): TimelineCommandResult<TimelineClipGroup>`	Groups existing clips.
`groups`	`groups: TimelineClipGroup[]`	Current clip groups.
`selectedGroup`	`selectedGroup: TimelineClipGroup \| null`	Selected clip group, or null when the primary selected clip is ungrouped.
`selectedGroupId`	`selectedGroupId: string \| null`	Selected clip group id, or null when the primary selected clip is ungrouped.
`ungroupClipGroup`	`(groupId: string): TimelineCommandResult`	Removes one clip group.
`ungroupSelectedClips`	`(): TimelineCommandResult`	Removes the current selected group, or groups containing selected clips.