This class defines the structure for a clip object. A clip object describes a portion of a video (or other media) file.

Clip contains the following public methods:

Method Description

GetTranscriptWithoutTimeCodes() Returns a copy of the Transcript Text with the Time Code information removed.

db_load_by_name() Load a record by ID / Name.

db_load_by_num() Load a record by record number.

db_save() Save the record to the database using Insert or Update as appropriate.

db_delete() Delete this object record from the database.

lock_record() Override the DataObject Lock Method

unlock_record() Override the DataObject Unlock Method

duplicate() No description

clear_keywords() Clear the keyword list.

refresh_keywords() Clear the keyword list and refresh it from the database.

add_keyword() Add a keyword to the keyword list.

remove_keyword() Remove a keyword from the keyword list. The value returned by this function can be: 0 Keyword NOT deleted. (probably overridden by the user) 1 Keyword deleted, but it was NOT a Keyword Example 2 Keyword deleted, and it WAS a Keyword Example.

has_keyword() Determines if the Episode has a given keyword assigned

get_note_nums() Get a list of Note numbers that belong to this Object.

get_episode_nums() Get a list of Episode numbers that belong to this Series.

clear() Clear all properties, resetting them to default values.

Method	Description
`GetTranscriptWithoutTimeCodes()`	Returns a copy of the Transcript Text with the Time Code information removed.
`db_load_by_name()`	Load a record by ID / Name.
`db_load_by_num()`	Load a record by record number.
`db_save()`	Save the record to the database using Insert or Update as appropriate.
`db_delete()`	Delete this object record from the database.
`lock_record()`	Override the DataObject Lock Method
`unlock_record()`	Override the DataObject Unlock Method
`duplicate()`	No description
`clear_keywords()`	Clear the keyword list.
`refresh_keywords()`	Clear the keyword list and refresh it from the database.
`add_keyword()`	Add a keyword to the keyword list.
`remove_keyword()`	Remove a keyword from the keyword list. The value returned by this function can be: 0 Keyword NOT deleted. (probably overridden by the user) 1 Keyword deleted, but it was NOT a Keyword Example 2 Keyword deleted, and it WAS a Keyword Example.
`has_keyword()`	Determines if the Episode has a given keyword assigned
`get_note_nums()`	Get a list of Note numbers that belong to this Object.
`get_episode_nums()`	Get a list of Episode numbers that belong to this Series.
`clear()`	Clear all properties, resetting them to default values.

Clip contains the following public properties:

Property Description

collection_num Collection number to which the clip belongs.

episode_num Number of episode from which this Clip was taken.

transcript_num Number of the transcript from which this Clip was taken.

clip_transcript_num Number of the Clip's transcript record in the Transcript Table.

media_filename The name (including path) of the media file.

clip_start Starting position of the Clip in the media file.

clip_stop Ending position of the Clip in the media file.

sort_order Sort Order position within the parent Collection.

keyword_list The list of keywords that have been applied to the Clip.

series_id ID for the Series from which this Clip was created, if the (bridge) Episode still exists

episode_id ID for the Episode from which this Clip was created, if it still exists

comment Description of the Object.

id ID or Name (required).

isLocked Object Is Locked?

lock_time Time of the last record lock (Read only).

number Record number (auto-incremented database field).

record_lock Username of person who has locked the record (Read only).

Property	Description
`collection_num`	Collection number to which the clip belongs.
`episode_num`	Number of episode from which this Clip was taken.
`transcript_num`	Number of the transcript from which this Clip was taken.
`clip_transcript_num`	Number of the Clip's transcript record in the Transcript Table.
`media_filename`	The name (including path) of the media file.
`clip_start`	Starting position of the Clip in the media file.
`clip_stop`	Ending position of the Clip in the media file.
`sort_order`	Sort Order position within the parent Collection.
`keyword_list`	The list of keywords that have been applied to the Clip.
`series_id`	ID for the Series from which this Clip was created, if the (bridge) Episode still exists
`episode_id`	ID for the Episode from which this Clip was created, if it still exists
`comment`	Description of the Object.
`id`	ID or Name (required).
`isLocked`	Object Is Locked?
`lock_time`	Time of the last record lock (Read only).
`number`	Record number (auto-incremented database field).
`record_lock`	Username of person who has locked the record (Read only).