Modules§
- bounds
- create_
segment - create_
segments_ request - create_
segments_ response - create_
segments_ v2_ request - create_
segments_ v2_ response - create_
video_ file_ request - create_
video_ request - detailed_
ingest_ status - end_
stream_ response - enriched_
video_ ingest_ status - error_
ingest_ status - error_
type - file_
summary - generate_
whep_ stream_ response - generate_
whip_ stream_ response - get_
enriched_ video_ ingest_ status_ request - get_
file_ summaries_ request - get_
file_ summaries_ response - get_
ingest_ status_ response - get_
playlist_ in_ bounds_ for_ channel_ request - get_
playlist_ in_ bounds_ request - get_
segment_ at_ or_ after_ timestamp_ request - get_
segment_ by_ timestamp_ request - get_
segment_ by_ timestamp_ v2_ request - get_
segment_ metadata_ for_ channel_ request - get_
segment_ summaries_ in_ bounds_ for_ channel_ request - get_
segment_ summaries_ in_ bounds_ request - get_
streams_ in_ bounds_ request - get_
streams_ in_ bounds_ response - get_
videos_ request - get_
videos_ response - ice_
server - ingest_
error - 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_
summary - segment_
summary_ v2 - segment_
timestamps - segment_
v2 - 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_
asset_ channel - video_
channel_ segments_ metadata - video_
channel_ series - video_
data_ source_ channel - video_
file - video_
file_ ingest_ status - video_
file_ origin_ metadata - video_
file_ segments_ metadata - video_
file_ timestamp_ manifest - video_
ingest_ status - video_
origin_ metadata - video_
stream - video_
timestamp_ manifest
Structs§
- Bounds
- Create
Segment - Create
Segments Request - Create
Segments Response - Create
Segments V2Request - Request to create video segments for channel-based ingestion. Internal use only.
- Create
Segments V2Response - Response for creating V2 segments. Internal use only.
- Create
Video File Request - Request to create and persist a video file
- Create
Video Request - EndStream
Response - Response payload for ending an active stream session.
- Enriched
Video Ingest Status - Error
Ingest Status - Error
Type - File
Summary - Generate
Whep Stream Response - Response with WHEP URL, ICE servers, and token for playback
- Generate
Whip Stream Response - Response with WHIP URL and ICE servers for publishing
- GetEnriched
Video Ingest Status Request - GetFile
Summaries Request - GetFile
Summaries Response - GetIngest
Status Response - GetPlaylist
InBounds ForChannel Request - Request to get playlist for a video channel series. Uses channel + tags to resolve to video series metadata within the specified video.
- GetPlaylist
InBounds Request - GetSegment
AtOr After Timestamp Request - Request to get a segment containing the given timestamp, or the closest segment starting after it.
- GetSegment
ByTimestamp Request - GetSegment
ByTimestamp V2Request - Request to get a segment by timestamp for a video series.
- GetSegment
Metadata ForChannel Request - Request to get aggregated segment metadata for a video channel series. Uses channel + tags to resolve to video series metadata. Optionally filter by time bounds.
- GetSegment
Summaries InBounds ForChannel Request - Request to get segment summaries for a video channel series. Uses channel + tags to resolve to video series metadata within the specified bounds.
- GetSegment
Summaries InBounds Request - GetStreams
InBounds Request - GetStreams
InBounds Response - GetVideos
Request - GetVideos
Response - IceServer
- WebRTC ICE server configuration
- Ingest
Error - List
Files InVideo Request - List
Files InVideo Response - Mcap
Timestamp Manifest - Timestamps are derived from the mcap file containing the video frames.
- NoTimestamp
Manifest - these values will not be updated after ingest time, to allow for resetting. The updated values are stored implicitly through the segment timestamps.
- Search
Videos Request - Search
Videos Response - Segment
- Segment
Summary - Bounding timestamps for the frames within a segment. For non-frame-mapped videos, the min and max media timestamps will be empty.
- Segment
Summary V2 - Bounding timestamps for the frames within a segment. Includes datasetFileId for V2 channel-based API.
- Segment
V2 - Segment for V2 channel-based video API (without videoRid).
- Sort
Options - Success
Ingest Status - Timestamp
Mappings - 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.
- Update
Ingest Status Request - Update
Video File Request - Request to update metadata for a given video file.
- Update
Video Metadata Request - Video
- Video
AllSegments Metadata - Video
Asset Channel - Reference a video channel via an Asset’s data scope
- Video
Channel Segments Metadata - Aggregated segment metadata for a video channel series
- Video
Data Source Channel - Reference a video channel directly from a datasource/dataset
- Video
File - Representation of a single user-provided video file.
- Video
File Origin Metadata - 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.
- Video
File Segments Metadata - High-level metadata about the segments comprising a video file post-segmentation.
- Video
Origin Metadata - Video
Stream - Metadata for a single video stream session.