Class MediaInfo (0.38.0)

public final class MediaInfo extends GeneratedMessageV3 implements MediaInfoOrBuilder

Media-specific user event information.

Protobuf type google.cloud.discoveryengine.v1.MediaInfo

Implements

MediaInfoOrBuilder

Static Fields

MEDIA_PROGRESS_DURATION_FIELD_NUMBER

public static final int MEDIA_PROGRESS_DURATION_FIELD_NUMBER
Field Value
Type Description
int

MEDIA_PROGRESS_PERCENTAGE_FIELD_NUMBER

public static final int MEDIA_PROGRESS_PERCENTAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MediaInfo getDefaultInstance()
Returns
Type Description
MediaInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MediaInfo.Builder newBuilder()
Returns
Type Description
MediaInfo.Builder

newBuilder(MediaInfo prototype)

public static MediaInfo.Builder newBuilder(MediaInfo prototype)
Parameter
Name Description
prototype MediaInfo
Returns
Type Description
MediaInfo.Builder

parseDelimitedFrom(InputStream input)

public static MediaInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MediaInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MediaInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MediaInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MediaInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MediaInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MediaInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MediaInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MediaInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MediaInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MediaInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MediaInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MediaInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MediaInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MediaInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MediaInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MediaInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MediaInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MediaInfo> parser()
Returns
Type Description
Parser<MediaInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public MediaInfo getDefaultInstanceForType()
Returns
Type Description
MediaInfo

getMediaProgressDuration()

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

.google.protobuf.Duration media_progress_duration = 1;

Returns
Type Description
Duration

The mediaProgressDuration.

getMediaProgressDurationOrBuilder()

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

.google.protobuf.Duration media_progress_duration = 1;

Returns
Type Description
DurationOrBuilder

getMediaProgressPercentage()

public float getMediaProgressPercentage()

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.

optional float media_progress_percentage = 2;

Returns
Type Description
float

The mediaProgressPercentage.

getParserForType()

public Parser<MediaInfo> getParserForType()
Returns
Type Description
Parser<MediaInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMediaProgressDuration()

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

.google.protobuf.Duration media_progress_duration = 1;

Returns
Type Description
boolean

Whether the mediaProgressDuration field is set.

hasMediaProgressPercentage()

public boolean hasMediaProgressPercentage()

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.

optional float media_progress_percentage = 2;

Returns
Type Description
boolean

Whether the mediaProgressPercentage field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MediaInfo.Builder newBuilderForType()
Returns
Type Description
MediaInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MediaInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MediaInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MediaInfo.Builder toBuilder()
Returns
Type Description
MediaInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException