Google Cloud Discovery Engine V1 Client - Class MediaInfo (0.4.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class MediaInfo.

Media-specific user event information.

Generated from protobuf message google.cloud.discoveryengine.v1.MediaInfo

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ media_progress_duration`	`Google\Protobuf\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`	`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.

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.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasMediaProgressDuration

clearMediaProgressDuration

setMediaProgressDuration

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.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`float`

hasMediaProgressPercentage

clearMediaProgressPercentage

setMediaProgressPercentage

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.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`