Interface MediaInfoOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    MediaInfo, MediaInfo.Builder

    public interface MediaInfoOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Duration getMediaProgressDuration()
      The media progress time in seconds, if applicable.
      com.google.protobuf.DurationOrBuilder getMediaProgressDurationOrBuilder()
      The media progress time in seconds, if applicable.
      float getMediaProgressPercentage()
      Media progress should be computed using only the [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.media_progress_duration] relative to the media total length.
      boolean hasMediaProgressDuration()
      The media progress time in seconds, if applicable.
      boolean hasMediaProgressPercentage()
      Media progress should be computed using only the [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.media_progress_duration] relative to the media total length.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • hasMediaProgressDuration

        boolean hasMediaProgressDuration()
         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.
         
        .google.protobuf.Duration media_progress_duration = 1;
        Returns:
        Whether the mediaProgressDuration field is set.
      • getMediaProgressDuration

        com.google.protobuf.Duration getMediaProgressDuration()
         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.
         
        .google.protobuf.Duration media_progress_duration = 1;
        Returns:
        The mediaProgressDuration.
      • getMediaProgressDurationOrBuilder

        com.google.protobuf.DurationOrBuilder getMediaProgressDurationOrBuilder()
         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.
         
        .google.protobuf.Duration media_progress_duration = 1;
      • hasMediaProgressPercentage

        boolean hasMediaProgressPercentage()
         Media progress should be computed using only the
         [media_progress_duration][google.cloud.discoveryengine.v1.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.
         
        optional float media_progress_percentage = 2;
        Returns:
        Whether the mediaProgressPercentage field is set.
      • getMediaProgressPercentage

        float getMediaProgressPercentage()
         Media progress should be computed using only the
         [media_progress_duration][google.cloud.discoveryengine.v1.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.
         
        optional float media_progress_percentage = 2;
        Returns:
        The mediaProgressPercentage.