Struct MediaInfo 

#[non_exhaustive]
pub struct MediaInfo {
    pub media_progress_duration: Option<Duration>,
    pub media_progress_percentage: Option<f32>,
    /* private fields */
}

Available on crate features recommendation-service or user-event-service only.

Media-specific user event information.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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 should be set to 90.

media_progress_percentage: Option<f32>

Media progress should be computed using only the 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 new() -> Self

pub fn set_media_progress_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of media_progress_duration.

Example

use wkt::Duration;
let x = MediaInfo::new().set_media_progress_duration(Duration::default()/* use setters */);

pub fn set_or_clear_media_progress_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of media_progress_duration.

Example

use wkt::Duration;
let x = MediaInfo::new().set_or_clear_media_progress_duration(Some(Duration::default()/* use setters */));
let x = MediaInfo::new().set_or_clear_media_progress_duration(None::<Duration>);

pub fn set_media_progress_percentage<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of media_progress_percentage.

Example

let x = MediaInfo::new().set_media_progress_percentage(42.0);

pub fn set_or_clear_media_progress_percentage<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of media_progress_percentage.

Example

let x = MediaInfo::new().set_or_clear_media_progress_percentage(Some(42.0));
let x = MediaInfo::new().set_or_clear_media_progress_percentage(None::<f32>);

Trait Implementations

impl Clone for MediaInfo

fn clone(&self) -> MediaInfo

Returns a duplicate 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() -> MediaInfo

Returns the “default value” for a type.

impl Message for MediaInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MediaInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MediaInfo