nutrient/com.pspdfkit.media/MediaUri

MediaUri

open class MediaUri : Parcelable

Representation of the parsed URI used for media links.

Types

UriType

enum UriType

Type of the media URI.

Properties

CREATOR

val CREATOR: Parcelable.Creator<MediaUri>

A field that generates the instances of MediaUri class from Parcel.

options

@NonNull

@get:NonNull

val options: String

The options from the pspdfkit:// link, contained within brackets.

type

@NonNull

@get:NonNull

val type: MediaUri.UriType

The type of media URI (local media, YouTube, gallery, web, or other).

uri

@NonNull

@get:NonNull

val uri: String

The URI part of the pspdfkit:// link pointing to the media resource.

Functions

describeContents

open fun describeContents(): Int

Describes the kinds of special objects contained in this Parcelable instance.

equals

open fun equals(obj: Any): Boolean

Compares this MediaUri with another object for equality.

getFileUri

open fun getFileUri(@NonNull context: Context): Uri

Returns URI of the media file that will be played.

getParsedUri

@NonNull

open fun getParsedUri(): Uri

Creates Uri object from the getUri.

getVideoSettingsFromOptions

@NonNull

open fun getVideoSettingsFromOptions(): MediaLinkUtils.VideoSettings

Parses video settings from provided options.

hashCode

open fun hashCode(): Int

Returns a hash code based on the type, options, and URI.

isVideoUri

open fun isVideoUri(): Boolean

Test if media uri is pointing to a video resource.

parse

@NonNull

open fun parse(@NonNull fullUri: String): MediaUri

Parse link media URI.

toString

open fun toString(): String

Returns a string representation of this MediaUri including type, options, and URI.

writeToParcel

open fun writeToParcel(dest: Parcel, flags: Int)

Flattens this object into a Parcel.

MediaUri

See also

Types

Properties

Functions