Class VdoInitParams
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class VdoInitParams implements 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
VdoInitParams.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.
-
Field Summary
Fields Modifier and Type Field Description public final String
token
public final String
otp
public final String
playbackInfo
public final String
preferredCaptionsLanguage
public final boolean
offlinePlayback
public final String
mediaId
public final int
startTimeMs
public final int
endTimeMs
public final int
resumeTimeMs
public final boolean
autoplay
public final boolean
forceLowestBitrate
public final boolean
forceHighestSupportedBitrate
public final int
maxVideoBitrateKbps
public final Array<String>
techOverride
public final boolean
disableAnalytics
public final boolean
allowAdbDebugging
public final boolean
isAutoResumeEnabled
public HashMap<String, Object>
configMap
public final String
customPlayerId
public final VdoMediaMetadata
vdoMediaMetadata
public final boolean
skipMedia3VersionCheck
public final String
languageCode
public final static Parcelable.Creator<VdoInitParams>
CREATOR
-
Method Summary
Modifier and Type Method Description boolean
equals(Object o)
int
hashCode()
static VdoInitParams
createParamsWithOtp(String otp, String playbackInfo)
static VdoInitParams
createParamsWithToken(String token, String videoId)
Create VdoInitParams with otp and playbackInfo. static VdoInitParams
createParamsForOffline(String mediaId, boolean autoResumePosition)
static VdoInitParams
createParamsForOffline(String mediaId)
VdoInitParams.Builder
getBuilder()
Create a new Builder with the initial values from this VdoInitParams instance. int
describeContents()
void
writeToParcel(Parcel dest, int flags)
-
-
Method Detail
-
hashCode
int hashCode()
-
createParamsWithOtp
@Deprecated() static VdoInitParams createParamsWithOtp(String otp, String playbackInfo)
- Parameters:
otp
- otpplaybackInfo
- playbackInfo- Returns:
a VdoInitParams object
-
createParamsWithToken
static VdoInitParams createParamsWithToken(String token, String videoId)
Create VdoInitParams with otp and playbackInfo.
- Parameters:
token
- tokenvideoId
- videoId- Returns:
a VdoInitParams object
-
createParamsForOffline
static VdoInitParams createParamsForOffline(String mediaId, boolean autoResumePosition)
-
createParamsForOffline
static VdoInitParams createParamsForOffline(String mediaId)
-
getBuilder
VdoInitParams.Builder getBuilder()
Create a new Builder with the initial values from this VdoInitParams instance.
-
describeContents
int describeContents()
-
writeToParcel
void writeToParcel(Parcel dest, int flags)
-
-
-
-