#[non_exhaustive]pub struct ImageBuilder { /* private fields */ }
Expand description
A builder for Image
.
Implementations§
source§impl ImageBuilder
impl ImageBuilder
sourcepub fn time_stamp(self, input: DateTime) -> Self
pub fn time_stamp(self, input: DateTime) -> Self
An attribute of the Image
object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.
sourcepub fn set_time_stamp(self, input: Option<DateTime>) -> Self
pub fn set_time_stamp(self, input: Option<DateTime>) -> Self
An attribute of the Image
object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.
sourcepub fn get_time_stamp(&self) -> &Option<DateTime>
pub fn get_time_stamp(&self) -> &Option<DateTime>
An attribute of the Image
object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.
sourcepub fn error(self, input: ImageError) -> Self
pub fn error(self, input: ImageError) -> Self
The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:
-
There is no media that exists for the specified
Timestamp
.
-
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.
sourcepub fn set_error(self, input: Option<ImageError>) -> Self
pub fn set_error(self, input: Option<ImageError>) -> Self
The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:
-
There is no media that exists for the specified
Timestamp
.
-
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.
sourcepub fn get_error(&self) -> &Option<ImageError>
pub fn get_error(&self) -> &Option<ImageError>
The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:
-
There is no media that exists for the specified
Timestamp
.
-
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.
sourcepub fn image_content(self, input: impl Into<String>) -> Self
pub fn image_content(self, input: impl Into<String>) -> Self
An attribute of the Image
object that is Base64 encoded.
sourcepub fn set_image_content(self, input: Option<String>) -> Self
pub fn set_image_content(self, input: Option<String>) -> Self
An attribute of the Image
object that is Base64 encoded.
sourcepub fn get_image_content(&self) -> &Option<String>
pub fn get_image_content(&self) -> &Option<String>
An attribute of the Image
object that is Base64 encoded.
Trait Implementations§
source§impl Clone for ImageBuilder
impl Clone for ImageBuilder
source§fn clone(&self) -> ImageBuilder
fn clone(&self) -> ImageBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ImageBuilder
impl Debug for ImageBuilder
source§impl Default for ImageBuilder
impl Default for ImageBuilder
source§fn default() -> ImageBuilder
fn default() -> ImageBuilder
source§impl PartialEq for ImageBuilder
impl PartialEq for ImageBuilder
source§fn eq(&self, other: &ImageBuilder) -> bool
fn eq(&self, other: &ImageBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.