Struct VideoFileServiceClient 

pub struct VideoFileServiceClient<T>(/* private fields */);

The video service manages individual video files and their metadata.

Implementations

impl<T> VideoFileServiceClient<T>

where T: Client,

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

Create and persist a video file entity with the given metadata

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

Returns video file metadata associated with a video file RID.

pub 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

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

👎Deprecated: Returns all video files and their metadata associated with the given video RID.

pub 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.

pub 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.

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

Permanently deletes a video file and all associated segments from the database. This operation cannot be undone.

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

👎Deprecated: 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. This endpoints is deprecated and will be removed on February 1st, 2026. Use delete endpoint instead for permanent removal.

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

👎Deprecated: Unarchive a previously archived video file, exposing it to the UI and search. Unarchiving functionality will be removed on February 1st, 2026.

pub 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.

pub 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.

pub 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.

pub 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.

pub fn get_playlist( &self, auth_: &BearerToken, video_file_rid: &VideoFileRid, ) -> Result<T::ResponseBody, 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.

Trait Implementations

impl<T: Clone> Clone for VideoFileServiceClient<T>

fn clone(&self) -> VideoFileServiceClient<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for VideoFileServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Service<T> for VideoFileServiceClient<T>

where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.