Skip to content

ScheduleConfig

Source code in docs_src/capo_kinesis_video/types/schedule_config.py
class ScheduleConfig(TypedDict, closed=True):
    schedule_expression: (
        "capo_kinesis_video.types.schedule_expression.ScheduleExpression"
    )
    """<p>The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the <code>ScheduleExpression</code> is not provided for the <code>RecorderConfig</code>, then the Edge Agent will always be set to recording mode.</p> <p>For more information about Quartz, refer to the <a href="https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html"> <i>Cron Trigger Tutorial</i> </a> page to understand the valid expressions and its use.</p>"""
    duration_in_seconds: (
        "capo_kinesis_video.types.duration_in_seconds.DurationInSeconds"
    )
    """<p>The total duration to record the media. If the <code>ScheduleExpression</code> attribute is provided, then the <code>DurationInSeconds</code> attribute should also be specified.</p>"""

duration_in_seconds instance-attribute

duration_in_seconds: DurationInSeconds

The total duration to record the media. If the ScheduleExpression attribute is provided, then the DurationInSeconds attribute should also be specified.

schedule_expression instance-attribute

schedule_expression: ScheduleExpression

The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig, then the Edge Agent will always be set to recording mode.

For more information about Quartz, refer to the Cron Trigger Tutorial page to understand the valid expressions and its use.