Skip to content

Commit 46aff14

Browse files
chrisjkhanchrisjkhan
committed
Improved documentation for video_start_time in ingestion_models
1 parent f6955ac commit 46aff14

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

‎cdp_backend/pipeline/ingestion_models.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,15 @@ class Session(IngestionModel, DataClassJsonMixin):
134134
"""
135135
A session is a working period for an event.
136136
For example, an event could have a morning and afternoon session.
137+
138+
Notes
139+
-----
140+
video_start_time is a duration relative to the beginning of the video in
141+
HH:MM:SS format. It does not affect nor is relative to session_datetime
142+
or any other datetime. If the portion of the video relavent to the session
143+
begins 37m50s into the full video, video_start_time will be "37:50".
144+
An absent start time is equivalent to the beginning of the video, and an
145+
absent end time is equivalent to the end of the video, so either can be omitted.
137146
"""
138147

139148
session_datetime: datetime

0 commit comments

Comments
 (0)