A strip folder provides an interface to consolidate multiple StripGroup that belongs to the same part of a Sequence. As its name implied it act the same way as a folder in a file explorer at the exception that it can contain a variety of different StripGroup.

Additionally, StripSection can also be added which will allow you to group Strip that belongs to one or more StripGroup together. Once connected the whole StripSection can be manipulated independently instead of moving each Strip one by one.

See Also

Static Variables

Name	Description
`sequence`	Parent Sequence where the StripFolder is defined.
Declaration Sequence *sequence
`stripsection_count`	Current amount of StripSection contained in the active StripFolder.
Declaration unsigned char stripsection_count
`stripgroup_count`	Total number of StripGroup maintained by the active StripFolder.
Declaration unsigned short stripgroup_count
`uid`	Unique id to globally identify the active StripFolder.
Declaration unsigned int uid

Variables

Name	Description
`name`	A unique name to identify the StripFolder within its parent Sequence.
Declaration char *name
`open`	Control wheter or not the StripFolder should be open or close (editor only).
Declaration bool open

Functions

Name	Description
`AddStripGroup`	Add a new StripGroup to the active StripFolder.
Declaration StripGroup AddStripGroup( const char name, const StripGroupType type ) Parameters `name`: Specify the name to use for the new StripGroup. `type`: The StripGroupType of the new StripGroup. Return Value Reference to the new StripGroup.
`GetStripGroup`	Retrieve an existing StripGroup reference by name.
Declaration StripGroup GetStripGroup( const char name ) Parameters `name`: Name of the StripGroup reference to retrieve. Return Value `nil` if the name provided does not match any of the StripGroup maintained by the active StripFolder; else return the StripGroup reference for the matching name.
`GetStripGroupAt`	Retrieve a StripGroup by index.
Declaration StripGroup GetStripGroupAt( unsigned short index ) Parameters* `index`: Index of the StripGroup to retrieve. Return Value `nil` if the index provided is invalid; else return the reference of the StripGroup pointed by index.
`GetStripGroupIndex`	Helper to retrieve the internal index of a specific StripGroup.
Declaration int GetStripGroupIndex( const StripGroup group ) Parameters* `group`: Reference to a StripGroup that belongs to the active StripFolder. Return Value `-1` if the reference is invalid; else return the internal index of the StripGroup provided.
`SetStripGroupIndex`	Manually set the internal index of a specific StripGroup maintained by the active StripFolder.
Declaration bool SetStripGroupIndex( StripGroup group, const unsigned short index ) Parameters* `group`: Reference to a valid StripGroup. `index`: The new index where the `group` should be placed. Return Value `false` if either the `group` or `index` is invalid; else return `true` if the operation was successfull.
`GetAction`	Remove a StripGroup from the current StripFolder.
Declaration bool RemoveStripGroup( StripGroup group ) Parameters* `group`: Reference of the StripGroup to remove. Return Value `true` on success; `false` if the `group` reference provided is invalid.
`RemoveStripGroupAt`	Remove a StripGroup from the current StripFolder using its index as key.
Declaration bool RemoveStripGroupAt( int index ) Parameters `index`: Index of the StripGroup to remove. Return Value `true` on success; `false` if the `index` provided is invalid.
`SwapStripGroups`	Exchange the internal location of two StripGroup connected to the active StripFolder.
Declaration bool SwapStripGroups( unsigned short index0, unsigned short index1 ) Parameters `index0`: Index of the first StripGroup to swap (source). `index1`: Index of the location to swap it to (destination). Return Value `true` if the operation is successfull; else return `false` if either of the index provided is invalid.
`AddStripSection`	Add a new StripSection to the active StripFolder.
Declaration StripSection AddStripSection( const char name ) Parameters `name`: A unique name to identify the new StripSection. Return Value Reference to the newly created StripSection.
`GetStripSection`	Retrieve an existing StripSection that belongs to the active StripFolder using its name as key.
Declaration StripSection GetStripSection( const char name ) Parameters `name`: The name of the StripSection to retrieve. Return Value `nil` if none of the StripSection managed by the active StripFolder matches the name received in parameter; else return the reference of the matching StripSection.
`GetStripSectionAt`	Retrieve an existing StripSection using its internal index as key.
Declaration StripSection GetStripSectionAt( unsigned char index ) Parameters* `index`: Index of the StripSection to retrieve. Return Value `nil` if the index provided is invalid; else return the reference of the StripSection pointed by index.
`GetStripSectionIndex`	Retrieve the internal index of an existing StripSection maintained by the active StripFolder.
Declaration int GetStripSectionIndex( const StripSection section ) Parameters* `section`: Reference to a valid StripSection. Return Value `-1` if `section` reference received by the function is invalid; else return its internal index.
`RemoveStripSection`	Remove an existing StripSection.
Declaration bool RemoveStripSection( StripSection section ) Parameters* `section`: Reference to the StripSection to remove. Return Value `true` if the section was removed successfully; else return `false` in the event the reference does not match any of the one maintained by the active StripFolder.
`RemoveStripSectionAt`	Remove a specific StripSection from the active StripFolder using its index as key.
Declaration bool RemoveStripSectionAt( int index ) Parameters `index`: Internal index of the StripSection to remove. Return Value `true` if the index provided is valid; else return `false`.