Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaMediaInfo

Inherits:

Object

• Object
• Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaMediaInfo

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

Media-specific user event information.

Instance Attribute Summary

• #media_progress_duration ⇒ String

  The media progress time in seconds, if applicable.

• #media_progress_percentage ⇒ Float

  Media progress should be computed using only the media_progress_duration relative to the media total length.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaMediaInfo constructor

  A new instance of GoogleCloudDiscoveryengineV1alphaMediaInfo.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaMediaInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaMediaInfo.

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 660

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#media_progress_duration ⇒ String

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. Corresponds to the JSON property mediaProgressDuration

Returns:

• (String)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 650

def media_progress_duration
  @media_progress_duration
end

#media_progress_percentage ⇒ Float

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. Corresponds to the JSON property mediaProgressPercentage

Returns:

• (Float)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 658

def media_progress_percentage
  @media_progress_percentage
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 665

def update!(**args)
  @media_progress_duration = args[:media_progress_duration] if args.key?(:media_progress_duration)
  @media_progress_percentage = args[:media_progress_percentage] if args.key?(:media_progress_percentage)
end