pub struct VideoFileServiceClient<T>(/* private fields */);
Expand description
The video service manages individual video files and their metadata.
Implementations§
Source§impl<T> VideoFileServiceClient<T>where
T: Client,
impl<T> VideoFileServiceClient<T>where
T: Client,
Sourcepub fn create(
&self,
auth_: &BearerToken,
request: &CreateVideoFileRequest,
) -> Result<VideoFile, Error>
pub fn create( &self, auth_: &BearerToken, request: &CreateVideoFileRequest, ) -> Result<VideoFile, Error>
Create and persist a video file entity with the given metadata
Sourcepub fn get(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
) -> Result<VideoFile, Error>
pub fn get( &self, auth_: &BearerToken, video_file_rid: &VideoFileRid, ) -> Result<VideoFile, Error>
Returns video file metadata associated with a video file RID.
Sourcepub fn batch_get(
&self,
auth_: &BearerToken,
video_file_rids: &BTreeSet<VideoFileRid>,
) -> Result<BTreeSet<VideoFile>, Error>
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>
Sourcepub fn list_files_in_video_paginated(
&self,
auth_: &BearerToken,
video_rid: &ListFilesInVideoRequest,
) -> Result<ListFilesInVideoResponse, Error>
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.
Sourcepub fn update(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
request: &UpdateVideoFileRequest,
) -> Result<VideoFile, Error>
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.
Sourcepub fn archive(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
) -> Result<(), Error>
pub 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.
Sourcepub fn unarchive(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
) -> Result<(), Error>
pub fn unarchive( &self, auth_: &BearerToken, video_file_rid: &VideoFileRid, ) -> Result<(), Error>
Unarchive a previously archived video file, exposing it to the UI and search.
Sourcepub fn get_ingest_status(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
) -> Result<GetIngestStatusResponse, Error>
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.
Sourcepub fn batch_get_ingest_status(
&self,
auth_: &BearerToken,
video_file_rids: &BTreeSet<VideoFileRid>,
) -> Result<BTreeMap<VideoFileRid, VideoFileIngestStatus>, Error>
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.
Sourcepub fn update_ingest_status(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
request: &UpdateIngestStatusRequest,
) -> Result<(), Error>
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.
Sourcepub fn get_segment_summaries(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
) -> Result<Vec<SegmentSummary>, Error>
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.
Sourcepub fn get_playlist(
&self,
auth_: &BearerToken,
video_file_rid: &VideoFileRid,
) -> Result<T::ResponseBody, Error>
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§
Source§impl<T: Clone> Clone for VideoFileServiceClient<T>
impl<T: Clone> Clone for VideoFileServiceClient<T>
Source§fn clone(&self) -> VideoFileServiceClient<T>
fn clone(&self) -> VideoFileServiceClient<T>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<T: Debug> Debug for VideoFileServiceClient<T>
impl<T: Debug> Debug for VideoFileServiceClient<T>
Auto Trait Implementations§
impl<T> Freeze for VideoFileServiceClient<T>where
T: Freeze,
impl<T> RefUnwindSafe for VideoFileServiceClient<T>where
T: RefUnwindSafe,
impl<T> Send for VideoFileServiceClient<T>where
T: Send,
impl<T> Sync for VideoFileServiceClient<T>where
T: Sync,
impl<T> Unpin for VideoFileServiceClient<T>where
T: Unpin,
impl<T> UnwindSafe for VideoFileServiceClient<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request