Vdocipher/com.vdocipher.aegis.player/VdoInitParams

VdoInitParams

class VdoInitParams : Parcelable

VdoInitParams is a final class that encapsulates the initialization parameters required to load a media into a VdoPlayer for playback. This class includes various configurations and options such as the media's token, OTP, playback information, captions language, and more. These parameters can be specified for either online or offline playback.

Instances of VdoInitParams can be created using the Builder class.

VdoInitParams implements the Parcelable interface to allow it to be passed between Android components.

Note: For online playback, you should either use the setOtp and setPlaybackInfo methods together or use the setVideoId and setToken methods together.

Types

open class Builder

Builder class for constructing instances of VdoInitParams.

Properties

allowAdbDebugging

val allowAdbDebugging: Boolean

Whether to allow ADB (Android Debug Bridge) debugging during playback.

val autoplay: Boolean

Whether autoplay is enabled.

open var configMap: HashMap<String, Any>

val CREATOR: Parcelable.Creator<VdoInitParams>

val customPlayerId: String

The custom player ID for identifying a specific player configuration.

disableAnalytics

val disableAnalytics: Boolean

Whether to disable analytics tracking.

val endTimeMs: Long

The end time in milliseconds for video playback.

forceHighestSupportedBitrate

val forceHighestSupportedBitrate: Boolean

Whether to force the use of the highest supported bitrate.

forceLowestBitrate

val forceLowestBitrate: Boolean

Whether to force the use of the lowest bitrate available.

isAutoResumeEnabled

val isAutoResumeEnabled: Boolean

Indicates whether automatic resume functionality is enabled.

val languageCode: String

The language code for the player.

val licenseUrl: String

maxVideoBitrateKbps

val maxVideoBitrateKbps: Int

The maximum video bitrate in kilobits per second.

val mediaId: String

The media ID for offline playback.

val mediaUrl: String

offlinePlayback

val offlinePlayback: Boolean

Whether offline playback is enabled.

val otp: String

The OTP for secure playback.

val playbackInfo: String

The playback information used for secure playback.

preferredCaptionsLanguage

val preferredCaptionsLanguage: String

The preferred captions language for video playback.

val resumeTimeMs: Int

The resume time in milliseconds for resuming playback.

val showClipping: Boolean

The showClipping in boolean to clip the video from given startTime and endTime.

skipMedia3VersionCheck

val skipMedia3VersionCheck: Boolean

Whether to skip the Media3 version check.

val startTimeMs: Long

The start time in milliseconds for video playback.

val techOverride: Array<String>

The technology override for media playback.

val token: String

The token used for authentication.

vdoMediaMetadata

val vdoMediaMetadata: VdoMediaMetadata

Metadata associated with the media content.

Functions

createParamsForOffline

open fun createParamsForOffline(mediaId: String): VdoInitParams

open fun createParamsForOffline(mediaId: String, autoResumePosition: Boolean): VdoInitParams

createParamsWithOtp

open fun ~~createParamsWithOtp~~(otp: String, playbackInfo: String): VdoInitParams

createParamsWithToken

open fun createParamsWithToken(token: String, videoId: String): VdoInitParams

Create VdoInitParams with otp and playbackInfo.

describeContents

open fun describeContents(): Int

open fun equals(o: Any): Boolean

open fun getBuilder(): VdoInitParams.Builder

Create a new Builder with the initial values from this VdoInitParams instance.

open fun hashCode(): Int

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