chariot.video package

Submodules

chariot.video.video module

Chariot Video API.

chariot.video.video.create_tracker_request(video_request_id: str, **kwargs) → OutputTrackerRequestResponse | None

Create a tracker request.

chariot.video.video.delete_tracker_request(tracker_request_id: str) → OutputDeleteTrackerRequestResponse | None

Delete a tracker request.

chariot.video.video.delete_video(video_id) → None

Delete a video.

chariot.video.video.delete_video_request(video_request_id: str) → OutputDeleteVideoRequestResponse | None

Delete a video request by id.

chariot.video.video.get_tracker_request(tracker_request_id: str) → OutputTrackerRequestResponse | None

Get a tracker request.

chariot.video.video.get_video_asset(key: str) → HTTPResponse

Get a video asset.

chariot.video.video.get_video_request(video_request_id: str) → OutputGetVideoRequestResponse | None

Get a video request by id.

chariot.video.video.get_video_requests(*, project_id: str, video_id: str) → list[OutputGetVideoRequestResponse] | None

Get video requests within a project or associated to a video.

chariot.video.video.get_videos(*, project_id: str, to_dict: bool = False, **kwargs) → list[dict[str, Any]] | list[OutputGetVideoResponse]

Get videos returns all videos within a project.

chariot.video.video.process_video(video_id: str, **kwargs) → OutputGetVideoRequestResponse | None

Process a video.

chariot.video.video.stream_video(*, project_id: str, name: str, description: str, url: str, **kwargs) → OutputGetVideoResponse | None

Create a streaming video.

chariot.video.video.update_tracker_request(*, tracker_request_id: str, **kwargs) → OutputTrackerRequestResponse | None

Update a tracker request.

chariot.video.video.upload_video(*, project_id: str, name: str, description: str, video_file: str | Path, **kwargs) → OutputGetVideoResponse | None

upload_video uploads the local video located at path video_file with the specified name, description, and project_id

chariot.video.video.wait_for_stream_connection(address: str, max_attempts: int = 6, wait_interval: int = 10) → bool

Wait for a stream to be available.

chariot.video.video.wait_for_tracker_request(*, tracker_request_id: str, wait_interval: int = 5, timeout: int = 60, statuses: list[str] = ['success']) → OutputTrackerRequestResponse

Periodically check if a tracker request has achieved one of statuses provided.

chariot.video.video.wait_for_video_request(*, video_request_id: str, wait_interval: int = 5, timeout: int = 60, statuses: list[str] = ['success']) → OutputGetVideoRequestResponse

Periodically check if a video request has achieved one of statuses provided.

Module contents