Struct ObjectTrackingAnnotation 

#[non_exhaustive]
pub struct ObjectTrackingAnnotation {
    pub entity: Option<Entity>,
    pub confidence: f32,
    pub frames: Vec<ObjectTrackingFrame>,
    pub version: String,
    pub track_info: Option<TrackInfo>,
    /* private fields */
}

Annotations corresponding to one tracked object.

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.

entity: Option<Entity>

Entity to specify the object category that this track is labeled as.

confidence: f32

Object category’s labeling confidence of this track.

frames: Vec<ObjectTrackingFrame>

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

version: String

Feature version.

track_info: Option<TrackInfo>

Different representation of tracking info in non-streaming batch and streaming modes.

Implementations

impl ObjectTrackingAnnotation

pub fn new() -> Self

Creates a new default instance.

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

where T: Into<Entity>,

Sets the value of entity.

Example

use google_cloud_videointelligence_v1::model::Entity;
let x = ObjectTrackingAnnotation::new().set_entity(Entity::default()/* use setters */);

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

where T: Into<Entity>,

Sets or clears the value of entity.

Example

use google_cloud_videointelligence_v1::model::Entity;
let x = ObjectTrackingAnnotation::new().set_or_clear_entity(Some(Entity::default()/* use setters */));
let x = ObjectTrackingAnnotation::new().set_or_clear_entity(None::<Entity>);

pub fn set_confidence<T: Into<f32>>(self, v: T) -> Self

Sets the value of confidence.

Example

let x = ObjectTrackingAnnotation::new().set_confidence(42.0);

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

where T: IntoIterator<Item = V>, V: Into<ObjectTrackingFrame>,

Sets the value of frames.

Example

use google_cloud_videointelligence_v1::model::ObjectTrackingFrame;
let x = ObjectTrackingAnnotation::new()
    .set_frames([
        ObjectTrackingFrame::default()/* use setters */,
        ObjectTrackingFrame::default()/* use (different) setters */,
    ]);

pub fn set_version<T: Into<String>>(self, v: T) -> Self

Sets the value of version.

Example

let x = ObjectTrackingAnnotation::new().set_version("example");

pub fn set_track_info<T: Into<Option<TrackInfo>>>(self, v: T) -> Self

Sets the value of track_info.

Note that all the setters affecting track_info are mutually exclusive.

Example

use google_cloud_videointelligence_v1::model::object_tracking_annotation::TrackInfo;
let x = ObjectTrackingAnnotation::new().set_track_info(Some(TrackInfo::TrackId(42)));

pub fn segment(&self) -> Option<&Box<VideoSegment>>

The value of track_info if it holds a Segment, None if the field is not set or holds a different branch.

pub fn set_segment<T: Into<Box<VideoSegment>>>(self, v: T) -> Self

Sets the value of track_info to hold a Segment.

Note that all the setters affecting track_info are mutually exclusive.

Example

use google_cloud_videointelligence_v1::model::VideoSegment;
let x = ObjectTrackingAnnotation::new().set_segment(VideoSegment::default()/* use setters */);
assert!(x.segment().is_some());
assert!(x.track_id().is_none());

pub fn track_id(&self) -> Option<&i64>

The value of track_info if it holds a TrackId, None if the field is not set or holds a different branch.

pub fn set_track_id<T: Into<i64>>(self, v: T) -> Self

Sets the value of track_info to hold a TrackId.

Note that all the setters affecting track_info are mutually exclusive.

Example

let x = ObjectTrackingAnnotation::new().set_track_id(42);
assert!(x.track_id().is_some());
assert!(x.segment().is_none());

Trait Implementations

impl Clone for ObjectTrackingAnnotation

fn clone(&self) -> ObjectTrackingAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectTrackingAnnotation

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

Formats the value using the given formatter.

impl Default for ObjectTrackingAnnotation

fn default() -> ObjectTrackingAnnotation

Returns the “default value” for a type.

impl Message for ObjectTrackingAnnotation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ObjectTrackingAnnotation

fn eq(&self, other: &ObjectTrackingAnnotation) -> 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 ObjectTrackingAnnotation