Trait AsyncVideoFileService 

pub trait AsyncVideoFileService<O> {
    type GetPlaylistBody: AsyncWriteBody<O> + 'static + Send;

    // Required methods
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateVideoFileRequest,
    ) -> impl Future<Output = Result<VideoFile, Error>> + Send;
    fn get(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
    ) -> impl Future<Output = Result<VideoFile, Error>> + Send;
    fn batch_get(
        &self,
        auth_: BearerToken,
        video_file_rids: BTreeSet<VideoFileRid>,
    ) -> impl Future<Output = Result<BTreeSet<VideoFile>, Error>> + Send;
    fn list_files_in_video(
        &self,
        auth_: BearerToken,
        video_rid: VideoRid,
    ) -> impl Future<Output = Result<BTreeSet<VideoFile>, Error>> + Send;
    fn list_files_in_video_paginated(
        &self,
        auth_: BearerToken,
        video_rid: ListFilesInVideoRequest,
    ) -> impl Future<Output = Result<ListFilesInVideoResponse, Error>> + Send;
    fn update(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
        request: UpdateVideoFileRequest,
    ) -> impl Future<Output = Result<VideoFile, Error>> + Send;
    fn archive(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn unarchive(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn get_ingest_status(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
    ) -> impl Future<Output = Result<GetIngestStatusResponse, Error>> + Send;
    fn batch_get_ingest_status(
        &self,
        auth_: BearerToken,
        video_file_rids: BTreeSet<VideoFileRid>,
    ) -> impl Future<Output = Result<BTreeMap<VideoFileRid, VideoFileIngestStatus>, Error>> + Send;
    fn update_ingest_status(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
        request: UpdateIngestStatusRequest,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn get_segment_summaries(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
    ) -> impl Future<Output = Result<Vec<SegmentSummary>, Error>> + Send;
    fn get_playlist(
        &self,
        auth_: BearerToken,
        video_file_rid: VideoFileRid,
    ) -> impl Future<Output = Result<Self::GetPlaylistBody, Error>> + Send;
}

The video service manages individual video files and their metadata.

Required Associated Types

type GetPlaylistBody: AsyncWriteBody<O> + 'static + Send

The body type returned by the get_playlist method.

Required Methods

fn create( &self, auth_: BearerToken, request: CreateVideoFileRequest, ) -> impl Future<Output = Result<VideoFile, Error>> + Send

Create and persist a video file entity with the given metadata

fn get( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> impl Future<Output = Result<VideoFile, Error>> + Send

Returns video file metadata associated with a video file RID.

fn batch_get( &self, auth_: BearerToken, video_file_rids: BTreeSet<VideoFileRid>, ) -> impl Future<Output = Result<BTreeSet<VideoFile>, Error>> + Send

Returns all video files and their metadata associated with the given RIDs

fn list_files_in_video( &self, auth_: BearerToken, video_rid: VideoRid, ) -> impl Future<Output = Result<BTreeSet<VideoFile>, Error>> + Send

fn list_files_in_video_paginated( &self, auth_: BearerToken, video_rid: ListFilesInVideoRequest, ) -> impl Future<Output = Result<ListFilesInVideoResponse, Error>> + Send

Returns a paginated list of all video files and their metadata associated with the given video RID.

fn update( &self, auth_: BearerToken, video_file_rid: VideoFileRid, request: UpdateVideoFileRequest, ) -> impl Future<Output = Result<VideoFile, Error>> + Send

Updates the metadata for a video file associated with the given RID.

fn archive( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> impl Future<Output = Result<(), Error>> + Send

Archives a video file, which excludes it from search and hides it from being visible in the UI, but does not permanently delete it. Archived video files can be unarchived.

fn unarchive( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> impl Future<Output = Result<(), Error>> + Send

Unarchive a previously archived video file, exposing it to the UI and search.

fn get_ingest_status( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> impl Future<Output = Result<GetIngestStatusResponse, Error>> + Send

Get the latest ingest status for a given video file by RID.

fn batch_get_ingest_status( &self, auth_: BearerToken, video_file_rids: BTreeSet<VideoFileRid>, ) -> impl Future<Output = Result<BTreeMap<VideoFileRid, VideoFileIngestStatus>, Error>> + Send

Get the latest ingest status for a set of given video files by RID.

fn update_ingest_status( &self, auth_: BearerToken, video_file_rid: VideoFileRid, request: UpdateIngestStatusRequest, ) -> impl Future<Output = Result<(), Error>> + Send

Update the latest ingest status for a given video file by RID.

fn get_segment_summaries( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> impl Future<Output = Result<Vec<SegmentSummary>, Error>> + Send

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

fn get_playlist( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> impl Future<Output = Result<Self::GetPlaylistBody, Error>> + Send

Generate an HLS playlist for a video file with the given RID to enable playback. The HLS playlist will contain links to all of the video segments in the video in sequential order.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors