# MusicVideoEntity

# MusicVideoEntity

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/com/google/android/engage/audio/datamodel/MusicVideoEntity "View this page in Java")  


```
class MusicVideoEntity : Entity
```

<br />

|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                             |||
| ↳ | [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)                      ||
|   | ↳ | [com.google.android.engage.audio.datamodel.MusicVideoEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity) |

*** ** * ** ***

An object representing a music video.

## Summary

|                                                                                                                                            ### Nested types                                                                                                                                            |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[MusicVideoEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity.Builder) Builder class for [MusicVideoEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity). |

|                                                                                                                                               ### Public functions                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                         | [getArtists](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getArtists())`()` Returns the list of artists of the music video.                                     |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                         | [getContentRatings](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getContentRatings())`()` Returns the content ratings of the music video.                       |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getDescription](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getDescription())`()` Returns the description of the audio entity, if available                   |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`!>!`                                                                                                                                     | [getDurationMillis](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getDurationMillis())`()` Returns the duration of the music video.                              |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getEntityId](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getEntityId())`()` Returns the id of the entity.                                                     |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Uri](https://developer.android.com/reference/android/net/Uri.html)`!>!`                                                                                                                                              | [getInfoPageUri](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getInfoPageUri())`()` Returns the info page uri of the music video, if available                  |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`!>!`                                                                                                                                     | [getLastEngagementTimeMillis](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getLastEngagementTimeMillis())`()` Returns the last engagement time in milliseconds. |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!`                                                                                                                                                                                                                               | [getName](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getName())`()` Returns the name of the entity.                                                           |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!>!` | [getPosterImages](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getPosterImages())`()` Returns the poster image of the entity.                                   |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                                                                                                                                       | [getProgressPercentComplete](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getProgressPercentComplete())`()` Returns the percentage progress completed.          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getViewCount](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#getViewCount())`()` Returns the number of views on the music video.                                 |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)                                                                                                                                                                                                                                | [isDownloadedOnDevice](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#isDownloadedOnDevice())`()` Returns whether the music video is downloaded on device or not  |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)                                                                                                                                                                                                                                | [isExplicitContent](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#isExplicitContent())`()` Returns whether the music video has explicit content or not           |

|                         ### Public properties                          |
|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)`!` | [playBackUri](https://developer.android.com/reference/kotlin/com/google/android/engage/audio/datamodel/MusicVideoEntity#playBackUri()) |

|                                                                                                                                                                                                                                                                                         ### Inherited functions                                                                                                                                                                                                                                                                                          |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity) |----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getEntityType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity#getEntityType())`()` | |

## Public functions

### getArtists

```
fun getArtists(): (Mutable)List<String!>!
```

Returns the list of artists of the music video.  

### getContentRatings

```
fun getContentRatings(): (Mutable)List<String!>!
```

Returns the content ratings of the music video.  

### getDescription

```
fun getDescription(): Optional<String!>!
```

Returns the description of the audio entity, if available  

### getDurationMillis

```
fun getDurationMillis(): Optional<Long!>!
```

Returns the duration of the music video.  

### getEntityId

```
fun getEntityId(): Optional<String!>!
```

Returns the id of the entity.  

### getInfoPageUri

```
fun getInfoPageUri(): Optional<Uri!>!
```

Returns the info page uri of the music video, if available  

### getLastEngagementTimeMillis

```
fun getLastEngagementTimeMillis(): Optional<Long!>!
```

Returns the last engagement time in milliseconds.  

### getName

```
fun getName(): String!
```

Returns the name of the entity.  

### getPosterImages

```
fun getPosterImages(): (Mutable)List<Image!>!
```

Returns the poster image of the entity.  

### getProgressPercentComplete

```
fun getProgressPercentComplete(): Optional<Int!>!
```

Returns the percentage progress completed.  

### getViewCount

```
fun getViewCount(): Optional<String!>!
```

Returns the number of views on the music video.  

### isDownloadedOnDevice

```
fun isDownloadedOnDevice(): Boolean
```

Returns whether the music video is downloaded on device or not  

### isExplicitContent

```
fun isExplicitContent(): Boolean
```

Returns whether the music video has explicit content or not  

## Public properties

### playBackUri

```
val playBackUri: Uri!
```