Module api

Module api 

Source

Modules§

bounds
create_segment
create_segments_request
create_segments_response
create_video_file_request
create_video_request
detailed_ingest_status
enriched_video_ingest_status
error_ingest_status
error_type
file_summary
get_enriched_video_ingest_status_request
get_file_summaries_request
get_file_summaries_response
get_ingest_status_response
get_playlist_in_bounds_request
get_segment_by_timestamp_request
get_segment_summaries_in_bounds_request
get_videos_request
get_videos_response
ingest_error
invalid_file_shift_scale_request
invalid_shift_scale_request
invalid_source_video
list_files_in_video_request
list_files_in_video_response
mcap_timestamp_manifest
no_timestamp_manifest
scale_parameter
search_videos_query
search_videos_request
search_videos_response
segment
segment_conflict
segment_not_found
segment_summary
segment_timestamps
sort_field
sort_options
success_ingest_status
timestamp_mappings
update_ingest_status
update_ingest_status_request
update_video_file_request
update_video_metadata_request
video
video_all_segments_metadata
video_file
video_file_ingest_not_complete
video_file_ingest_status
video_file_not_found
video_file_origin_metadata
video_file_segments_metadata
video_file_timestamp_manifest
video_ingest_not_complete
video_ingest_status
video_not_found
video_origin_metadata
video_timestamp_manifest

Structs§

Bounds
CreateSegment
CreateSegmentsRequest
CreateSegmentsResponse
CreateVideoFileRequest
Request to create and persist a video file
CreateVideoRequest
EnrichedVideoIngestStatus
ErrorIngestStatus
ErrorType
FileSummary
GetEnrichedVideoIngestStatusRequest
GetFileSummariesRequest
GetFileSummariesResponse
GetIngestStatusResponse
GetPlaylistInBoundsRequest
GetSegmentByTimestampRequest
GetSegmentSummariesInBoundsRequest
GetVideosRequest
GetVideosResponse
IngestError
InvalidFileShiftScaleRequest
Attempting to shift or scale the timestamps of a video with a timestamp manifest.
InvalidShiftScaleRequest
Attempting to shift or scale the timestamps of a video file with a timestamp manifest, or scale a multi-file video.
InvalidSourceVideo
Attempting to segment a file that does not contain any video streams.
ListFilesInVideoRequest
ListFilesInVideoResponse
McapTimestampManifest
Timestamps are derived from the mcap file containing the video frames.
NoTimestampManifest
these values will not be updated after ingest time, to allow for resetting. The updated values are stored implicitly through the segment timestamps.
SearchVideosRequest
SearchVideosResponse
Segment
SegmentConflict
Attempting to create multiple segments with overlapping timestamps
SegmentNotFound
unable to find segment at the requested timestamp.
SegmentSummary
Bounding timestamps for the frames within a segment. For non-frame-mapped videos, the min and max media timestamps will be empty.
SortOptions
SuccessIngestStatus
TimestampMappings
contains 2 equal-length lists, which contain the video media time and user-provided absolute time for the frame at each index. Enables frame-mapping on the front-end.
UpdateIngestStatusRequest
UpdateVideoFileRequest
Request to update metadata for a given video file.
UpdateVideoMetadataRequest
Video
VideoAllSegmentsMetadata
VideoFile
Representation of a single user-provided video file.
VideoFileIngestNotComplete
Attempting to access per-file segment information before video segmentation has finished.
VideoFileNotFound
Accessing a video file by RID that does not exist or that you do not have permission to access.
VideoFileOriginMetadata
Metadata about the origin of the video file. This includes the original source of the video file and additional timestamp metadata used to time-sync the video file.
VideoFileSegmentsMetadata
High-level metadata about the segments comprising a video file post-segmentation.
VideoIngestNotComplete
VideoNotFound
VideoOriginMetadata

Enums§

DetailedIngestStatus
ScaleParameter
SearchVideosQuery
SegmentTimestamps
SortField
UpdateIngestStatus
VideoFileIngestStatus
VideoFileTimestampManifest
VideoIngestStatus
VideoTimestampManifest