Trait VideoService 

pub trait VideoService<I, O> {
    type GetPlaylistBody: WriteBody<O> + 'static;
    type GetPlaylistInBoundsBody: WriteBody<O> + 'static;
    type GetPlaylistInBoundsForChannelBody: WriteBody<O> + 'static;
    type GetPlaylistForChannelBody: WriteBody<O> + 'static;

    // Required methods
    fn get(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> Result<Video, Error>;
    fn batch_get(
        &self,
        auth_: BearerToken,
        request: GetVideosRequest,
    ) -> Result<GetVideosResponse, Error>;
    fn search(
        &self,
        auth_: BearerToken,
        request: SearchVideosRequest,
    ) -> Result<SearchVideosResponse, Error>;
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateVideoRequest,
    ) -> Result<Video, Error>;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
        request: UpdateVideoMetadataRequest,
    ) -> Result<Video, Error>;
    fn update_ingest_status(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
        request: UpdateIngestStatus,
    ) -> Result<(), Error>;
    fn get_ingest_status(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> Result<DetailedIngestStatus, Error>;
    fn batch_get_ingest_status(
        &self,
        auth_: BearerToken,
        video_rids: BTreeSet<VideoRid>,
    ) -> Result<BTreeMap<VideoRid, DetailedIngestStatus>, Error>;
    fn get_enriched_ingest_status(
        &self,
        auth_: BearerToken,
        request: GetEnrichedVideoIngestStatusRequest,
    ) -> Result<Option<EnrichedVideoIngestStatus>, Error>;
    fn archive(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> Result<(), Error>;
    fn unarchive(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> Result<(), Error>;
    fn get_playlist(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
        start: Option<String>,
        end: Option<String>,
    ) -> Result<Self::GetPlaylistBody, Error>;
    fn get_segment_summaries(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> Result<Vec<SegmentSummary>, Error>;
    fn get_playlist_in_bounds(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
        request: GetPlaylistInBoundsRequest,
    ) -> Result<Self::GetPlaylistInBoundsBody, Error>;
    fn get_playlist_in_bounds_for_channel(
        &self,
        auth_: BearerToken,
        request: GetPlaylistInBoundsForChannelRequest,
    ) -> Result<Self::GetPlaylistInBoundsForChannelBody, Error>;
    fn get_playlist_for_channel(
        &self,
        auth_: BearerToken,
        data_source_rid: Option<DataSourceRid>,
        asset_rid: Option<AssetRid>,
        data_scope_name: Option<String>,
        channel: String,
        tags: Option<String>,
        start: String,
        end: String,
    ) -> Result<Self::GetPlaylistForChannelBody, Error>;
    fn get_segment_summaries_in_bounds(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
        request: GetSegmentSummariesInBoundsRequest,
    ) -> Result<Vec<SegmentSummary>, Error>;
    fn get_segment_summaries_in_bounds_for_channel(
        &self,
        auth_: BearerToken,
        request: GetSegmentSummariesInBoundsForChannelRequest,
    ) -> Result<Vec<SegmentSummary>, Error>;
    fn get_file_summaries(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
        request: GetFileSummariesRequest,
    ) -> Result<GetFileSummariesResponse, Error>;
    fn generate_whip_stream(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> Result<GenerateWhipStreamResponse, Error>;
    fn generate_whep_stream(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> Result<Option<GenerateWhepStreamResponse>, Error>;
    fn upload_segment_from_media_mtx(
        &self,
        auth_: BearerToken,
        stream_path: String,
        file_path: String,
        duration: String,
        content_length: SafeLong,
        body: I,
    ) -> Result<(), Error>;
}

The video service manages videos and video metadata.

Required Associated Types

type GetPlaylistBody: WriteBody<O> + 'static

The body type returned by the get_playlist method.

type GetPlaylistInBoundsBody: WriteBody<O> + 'static

The body type returned by the get_playlist_in_bounds method.

type GetPlaylistInBoundsForChannelBody: WriteBody<O> + 'static

The body type returned by the get_playlist_in_bounds_for_channel method.

type GetPlaylistForChannelBody: WriteBody<O> + 'static

The body type returned by the get_playlist_for_channel method.

Required Methods

fn get(&self, auth_: BearerToken, video_rid: VideoRid) -> Result<Video, Error>

Returns video metadata associated with a video rid.

fn batch_get( &self, auth_: BearerToken, request: GetVideosRequest, ) -> Result<GetVideosResponse, Error>

Returns video metadata about each video given a set of video rids.

fn search( &self, auth_: BearerToken, request: SearchVideosRequest, ) -> Result<SearchVideosResponse, Error>

Returns metadata about videos that match a given query.

fn create( &self, auth_: BearerToken, request: CreateVideoRequest, ) -> Result<Video, Error>

Creates and persists a video entity with the given metadata.

fn update_metadata( &self, auth_: BearerToken, video_rid: VideoRid, request: UpdateVideoMetadataRequest, ) -> Result<Video, Error>

Updates the metadata for a video associated with the given video rid.

fn update_ingest_status( &self, auth_: BearerToken, video_rid: VideoRid, request: UpdateIngestStatus, ) -> Result<(), Error>

fn get_ingest_status( &self, auth_: BearerToken, video_rid: VideoRid, ) -> Result<DetailedIngestStatus, Error>

fn batch_get_ingest_status( &self, auth_: BearerToken, video_rids: BTreeSet<VideoRid>, ) -> Result<BTreeMap<VideoRid, DetailedIngestStatus>, Error>

fn get_enriched_ingest_status( &self, auth_: BearerToken, request: GetEnrichedVideoIngestStatusRequest, ) -> Result<Option<EnrichedVideoIngestStatus>, Error>

fn archive(&self, auth_: BearerToken, video_rid: VideoRid) -> Result<(), Error>

Archives a video, which excludes it from search and hides it from being publicly visible, but does not permanently delete it. Archived videos can be unarchived.

fn unarchive( &self, auth_: BearerToken, video_rid: VideoRid, ) -> Result<(), Error>

Unarchives a previously archived video.

fn get_playlist( &self, auth_: BearerToken, video_rid: VideoRid, start: Option<String>, end: Option<String>, ) -> Result<Self::GetPlaylistBody, Error>

Generates an HLS playlist for a video within optional time bounds. Uses GET with query parameters for HLS.js compatibility. The HLS playlist will contain links to all of the segments in the video that overlap with the given bounds, or all segments if no bounds are provided.

Note: The start and end parameters must either both be provided or both be omitted. Providing only one will result in a MissingTimestampBoundPair error.

fn get_segment_summaries( &self, auth_: BearerToken, video_rid: VideoRid, ) -> Result<Vec<SegmentSummary>, Error>

Returns the min and max absolute and media timestamps for each segment in a video. To be used during frame-timestamp mapping.

fn get_playlist_in_bounds( &self, auth_: BearerToken, video_rid: VideoRid, request: GetPlaylistInBoundsRequest, ) -> Result<Self::GetPlaylistInBoundsBody, Error>

Generates an HLS playlist for a video with the given video rid to enable playback within an optional set of bounds. The HLS playlist will contain links to all of the segments in the video that overlap with the given bounds. playlist will be limited to the given bounds.

fn get_playlist_in_bounds_for_channel( &self, auth_: BearerToken, request: GetPlaylistInBoundsForChannelRequest, ) -> Result<Self::GetPlaylistInBoundsForChannelBody, Error>

Generates an HLS playlist for a video channel series (identified by channel + tags) within an optional set of bounds then generates a playlist for all matching video segments.

fn get_playlist_for_channel( &self, auth_: BearerToken, data_source_rid: Option<DataSourceRid>, asset_rid: Option<AssetRid>, data_scope_name: Option<String>, channel: String, tags: Option<String>, start: String, end: String, ) -> Result<Self::GetPlaylistForChannelBody, Error>

Generates an HLS playlist for a video channel series within time bounds. Specify either dataSourceRid OR (assetRid + dataScopeName) to identify the channel source.

Note: Both start and end parameters are required and must be provided together.

fn get_segment_summaries_in_bounds( &self, auth_: BearerToken, video_rid: VideoRid, request: GetSegmentSummariesInBoundsRequest, ) -> Result<Vec<SegmentSummary>, Error>

Returns the min and max absolute and media timestamps for each segment in a video that overlap with an optional set of bounds.

fn get_segment_summaries_in_bounds_for_channel( &self, auth_: BearerToken, request: GetSegmentSummariesInBoundsForChannelRequest, ) -> Result<Vec<SegmentSummary>, Error>

Returns the min and max absolute and media timestamps for each segment matching a video channel series (identified by channel + tags) within the specified bounds.

fn get_file_summaries( &self, auth_: BearerToken, video_rid: VideoRid, request: GetFileSummariesRequest, ) -> Result<GetFileSummariesResponse, Error>

Returns the min and max absolute timestamps from non-archived video files associated with a given video that overlap with an optional set of bounds. The files on the edges of the bounds will be truncated to segments that are inside or overlap with the bounds.

fn generate_whip_stream( &self, auth_: BearerToken, video_rid: VideoRid, ) -> Result<GenerateWhipStreamResponse, Error>

Generates a stream ID scoped to a video and returns a WHIP URL with a MediaMTX JWT and ICE servers. Enforces write permission on the video.

fn generate_whep_stream( &self, auth_: BearerToken, video_rid: VideoRid, ) -> Result<Option<GenerateWhepStreamResponse>, Error>

Returns WHEP URL, ICE servers, and token for playing back the active stream. Returns empty if there is no active stream. Enforces read permission on the video.

fn upload_segment_from_media_mtx( &self, auth_: BearerToken, stream_path: String, file_path: String, duration: String, content_length: SafeLong, body: I, ) -> Result<(), Error>

MediaMTX segment upload endpoint. Receives video segments from MediaMTX hooks. Validates JWT and logs session. Future: create video segments from uploaded files.

Implementors