Struct google_api_proto::google::cloud::discoveryengine::v1alpha::MediaInfo

pub struct MediaInfo {
    pub media_progress_duration: Option<Duration>,
    pub media_progress_percentage: Option<f32>,
}

Media-specific user event information.

Fields

media_progress_duration: Option<Duration>

The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then [MediaInfo.media_progress_duration.seconds][google.protobuf.Duration.seconds] should be set to 90.

media_progress_percentage: Option<f32>

Media progress should be computed using only the [media_progress_duration][google.cloud.discoveryengine.v1alpha.MediaInfo.media_progress_duration] relative to the media total length.

This value must be between \[0, 1.0\] inclusive.

If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.

Implementations

impl MediaInfo

pub fn media_progress_percentage(&self) -> f32

Returns the value of media_progress_percentage, or the default value if media_progress_percentage is unset.

Trait Implementations

impl Clone for MediaInfo

fn clone(&self) -> MediaInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MediaInfo

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

Formats the value using the given formatter.

impl Default for MediaInfo

fn default() -> Self

Returns the “default value” for a type.

impl Message for MediaInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for MediaInfo

fn eq(&self, other: &MediaInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MediaInfo

impl StructuralPartialEq for MediaInfo