Vdocipher/com.vdocipher.aegis.player/VdoInitParams/Builder

Builder

open class Builder

Builder class for constructing instances of VdoInitParams.

The Builder class allows for a flexible configuration of the playback parameters. It includes methods to set the media's token, OTP, playback information, captions language, and various other options related to the playback experience. Note: For online playback, you should either use the setOtp and setPlaybackInfo methods together or use the setVideoId and setToken methods together.

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open fun build(): VdoInitParams
Link copied to clipboard
open fun configureMediaSource(@NonNull mediaUrl: String): VdoInitParams.Builder
Configures the media source using the specified media URL.
open fun configureMediaSource(@NonNull mediaUrl: String, @Nullable licenseUrl: String): VdoInitParams.Builder
Configures the media source with a specified media URL and an optional license URL.
Link copied to clipboard
open fun enableAutoResume(): VdoInitParams.Builder
Enables automatic resume of playback from the last position.
Link copied to clipboard
open fun enableOfflinePlayback(): VdoInitParams.Builder
Allows the player to use locally saved media files for playback.
Link copied to clipboard
open fun setAllowAdbDebugging(allowAdbDebugging: Boolean): VdoInitParams.Builder
Sets whether to allow ADB (Android Debug Bridge) debugging during playback.
Link copied to clipboard
open fun setAutoplay(autoplay: Boolean): VdoInitParams.Builder
Sets whether the player should autoplay when the media is ready.
Link copied to clipboard
open fun setClips(startTimeMs: Int, endTimeMs: Int): VdoInitParams.Builder
open fun setClips(startTimeMs: Int, endTimeMs: Int, showClipping: Boolean): VdoInitParams.Builder
Sets the start and end time for a media clip playback.
Link copied to clipboard
open fun setCustomPlayer(customPlayerId: String): VdoInitParams.Builder
Sets the custom player ID.
Link copied to clipboard
open fun setDisableAnalytics(disableAnalytics: Boolean): VdoInitParams.Builder
Sets whether to disable analytics for playback.
Link copied to clipboard
open fun setForceHighestSupportedBitrate(forceHighestSupportedBitrate: Boolean): VdoInitParams.Builder
Sets whether to force the use of the highest supported bitrate for video playback.
Link copied to clipboard
open fun setForceLowestBitrate(forceLowestBitrate: Boolean): VdoInitParams.Builder
Sets whether to force the use of the lowest bitrate for video playback.
Link copied to clipboard
open fun setMaxVideoBitrateKbps(maxVideoBitrateKbps: Int): VdoInitParams.Builder
Sets the maximum video bitrate in kilobits per second (kbps).
Link copied to clipboard
open fun setOfflinePlayback(mediaId: String): VdoInitParams.Builder
Enables offline playback for a specified media ID.
Link copied to clipboard
open fun setOtp(otp: String): VdoInitParams.Builder
Sets the OTP for online playback.
Link copied to clipboard
open fun setPlaybackInfo(playbackInfo: String): VdoInitParams.Builder
Sets the playback information for online playback.
Link copied to clipboard
open fun setPlayerConfig(customPlayerId: String): VdoInitParams.Builder
Link copied to clipboard
open fun setPlayerLanguage(languageCode: String): VdoInitParams.Builder
Sets the language code for the player.
Link copied to clipboard
open fun setPreferredCaptionsLanguage(preferredCaptionsLanguage: String): VdoInitParams.Builder
Sets the preferred captions language for the media.
Link copied to clipboard
open fun setResumeTime(resumeTimeMs: Int): VdoInitParams.Builder
Sets the player resume time in milliseconds.
Link copied to clipboard
open fun setTechOverride(techOverride: Array<String>): VdoInitParams.Builder
Sets the technology override for playback.
Link copied to clipboard
open fun setToken(token: String): VdoInitParams.Builder
Sets the token for online playback.
Link copied to clipboard
open fun setVdoMediaMetadata(vdoMediaMetadata: VdoMediaMetadata): VdoInitParams.Builder
Sets the media metadata for the Vdo player.
Link copied to clipboard
open fun setVideoId(videoId: String): VdoInitParams.Builder
Sets the video ID for online playback.
Link copied to clipboard
open fun skipMedia3VersionCheck(): VdoInitParams.Builder
Skips the Media3 version check.
Link copied to clipboard