VideoFileService

nominal_api::scout::video::video_file_service

Trait VideoFileService 

Source 
pub trait VideoFileService<O> {
    type GetPlaylistBody: WriteBody<O> + 'static;


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

}
Expand description

The video service manages individual video files and their metadata.

Required Associated Types§

Source

type GetPlaylistBody: WriteBody<O> + 'static

The body type returned by the get_playlist method.

Required Methods§

Source

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

Create and persist a video file entity with the given metadata

Source

fn get( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> Result<VideoFile, Error>

Returns video file metadata associated with a video file RID.

Source

fn batch_get( &self, auth_: BearerToken, video_file_rids: BTreeSet<VideoFileRid>, ) -> Result<BTreeSet<VideoFile>, Error>

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

Source

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

Source

fn list_files_in_video_paginated( &self, auth_: BearerToken, video_rid: ListFilesInVideoRequest, ) -> Result<ListFilesInVideoResponse, Error>

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

Source

fn update( &self, auth_: BearerToken, video_file_rid: VideoFileRid, request: UpdateVideoFileRequest, ) -> Result<VideoFile, Error>

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

Source

fn archive( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> Result<(), Error>

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.

Source

fn unarchive( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> Result<(), Error>

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

Source

fn get_ingest_status( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> Result<GetIngestStatusResponse, Error>

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

Source

fn batch_get_ingest_status( &self, auth_: BearerToken, video_file_rids: BTreeSet<VideoFileRid>, ) -> Result<BTreeMap<VideoFileRid, VideoFileIngestStatus>, Error>

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

Source

fn update_ingest_status( &self, auth_: BearerToken, video_file_rid: VideoFileRid, request: UpdateIngestStatusRequest, ) -> Result<(), Error>

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

Source

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

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.

Source

fn get_playlist( &self, auth_: BearerToken, video_file_rid: VideoFileRid, ) -> Result<Self::GetPlaylistBody, Error>

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.

Implementors§