Struct VideoServiceClient 

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

The video service manages videos and video metadata.

Implementations

impl<T> VideoServiceClient<T>

where T: Client,

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

Returns video metadata associated with a video rid.

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

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

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

Returns metadata about videos that match a given query.

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

Creates and persists a video entity with the given metadata.

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

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

👎Deprecated: Replaced by per-file updateIngestStatus. Will be removed after April 15th.

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

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

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

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

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

Unarchives a previously archived video.

pub fn get_playlist( &self, auth_: &BearerToken, video_rid: &VideoRid, ) -> Result<T::ResponseBody, Error>

👎Deprecated: Replaced by getPlaylistInBounds. Will be removed after April 15th.

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

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

👎Deprecated: Replaced by getSegmentSummariesInBounds. Will be removed after April 15th.

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

pub fn get_playlist_in_bounds( &self, auth_: &BearerToken, video_rid: &VideoRid, request: &GetPlaylistInBoundsRequest, ) -> Result<T::ResponseBody, 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.

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

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

Trait Implementations

impl<T: Clone> Clone for VideoServiceClient<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for VideoServiceClient<T>

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

Formats the value using the given formatter.

impl<T> Service<T> for VideoServiceClient<T>

where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.