Stay organized with collections
Save and categorize content based on your preferences.
class MediaItem.SubtitleConfiguration.Builder
Builder for SubtitleConfiguration instances.
Summary
Public constructors |
|
Constructs an instance.
|
Public constructors
Builder(uri: Uri!)
Constructs an instance.
| Parameters |
uri: Uri! |
The Uri to the subtitle file.
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-05-15 UTC.
[null,null,["Last updated 2025-05-15 UTC."],[],[],null,["# MediaItem.SubtitleConfiguration.Builder\n=======================================\n\nArtifact: [androidx.media3:media3-common](/jetpack/androidx/releases/media3) \n[View Source](https://cs.android.com/search?q=file:androidx/media3/common/MediaItem.java+class:androidx.media3.common.MediaItem.SubtitleConfiguration.Builder)\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder \"View this page in Java\")\n\n\n```\nclass MediaItem.SubtitleConfiguration.Builder\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nBuilder for [SubtitleConfiguration](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration) instances.\n\nSummary\n-------\n\n| ### Public constructors |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#Builder(android.net.Uri))`(uri: `[Uri](https://developer.android.com/reference/android/net/Uri.html)`!)` Constructs an instance. |\n\n| ### Public functions |\n|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [MediaItem.SubtitleConfiguration](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration)`!` | [build](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#build())`()` Creates a [SubtitleConfiguration](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration) from the values of this builder. |\n| [MediaItem.SubtitleConfiguration.Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setId](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#setId(java.lang.String))`(id: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Sets the optional ID for this subtitle track. |\n| [MediaItem.SubtitleConfiguration.Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setLabel](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#setLabel(java.lang.String))`(label: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Sets the optional label for this subtitle track. |\n| [MediaItem.SubtitleConfiguration.Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setLanguage](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#setLanguage(java.lang.String))`(language: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Sets the optional language of the subtitle file. |\n| [MediaItem.SubtitleConfiguration.Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setMimeType](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#setMimeType(java.lang.String))`(mimeType: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Sets the MIME type. |\n| [MediaItem.SubtitleConfiguration.Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setRoleFlags](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#setRoleFlags(int))`(@`[C.RoleFlags](/reference/kotlin/androidx/media3/common/C.RoleFlags)` roleFlags: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Sets the role flags. |\n| [MediaItem.SubtitleConfiguration.Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setSelectionFlags](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#setSelectionFlags(int))`(@`[C.SelectionFlags](/reference/kotlin/androidx/media3/common/C.SelectionFlags)` selectionFlags: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Sets the flags used for track selection. |\n| [MediaItem.SubtitleConfiguration.Builder](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setUri](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder#setUri(android.net.Uri))`(uri: `[Uri](https://developer.android.com/reference/android/net/Uri.html)`!)` Sets the [Uri](https://developer.android.com/reference/android/net/Uri.html) to the subtitle file. |\n\nPublic constructors\n-------------------\n\n### Builder\n\n```\nBuilder(uri: Uri!)\n```\n\nConstructs an instance. \n\n| Parameters |\n|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|\n| `uri: `[Uri](https://developer.android.com/reference/android/net/Uri.html)`!` | The [Uri](https://developer.android.com/reference/android/net/Uri.html) to the subtitle file. |\n\nPublic functions\n----------------\n\n### build\n\n```\nfun build(): MediaItem.SubtitleConfiguration!\n```\n\nCreates a [SubtitleConfiguration](/reference/kotlin/androidx/media3/common/MediaItem.SubtitleConfiguration) from the values of this builder. \n\n### setId\n\n```\n@CanIgnoreReturnValue\nfun setId(id: String?): MediaItem.SubtitleConfiguration.Builder!\n```\n\nSets the optional ID for this subtitle track. \n\n### setLabel\n\n```\n@CanIgnoreReturnValue\nfun setLabel(label: String?): MediaItem.SubtitleConfiguration.Builder!\n```\n\nSets the optional label for this subtitle track. \n\n### setLanguage\n\n```\n@CanIgnoreReturnValue\nfun setLanguage(language: String?): MediaItem.SubtitleConfiguration.Builder!\n```\n\nSets the optional language of the subtitle file. \n\n### setMimeType\n\n```\n@CanIgnoreReturnValue\nfun setMimeType(mimeType: String?): MediaItem.SubtitleConfiguration.Builder!\n```\n\nSets the MIME type. \n\n### setRoleFlags\n\n```\n@CanIgnoreReturnValue\nfun setRoleFlags(@C.RoleFlags roleFlags: Int): MediaItem.SubtitleConfiguration.Builder!\n```\n\nSets the role flags. These are used for track selection. \n\n### setSelectionFlags\n\n```\n@CanIgnoreReturnValue\nfun setSelectionFlags(@C.SelectionFlags selectionFlags: Int): MediaItem.SubtitleConfiguration.Builder!\n```\n\nSets the flags used for track selection. \n\n### setUri\n\n```\n@CanIgnoreReturnValue\nfun setUri(uri: Uri!): MediaItem.SubtitleConfiguration.Builder!\n```\n\nSets the [Uri](https://developer.android.com/reference/android/net/Uri.html) to the subtitle file."]]
