Android SDK - Player states

Guide: How to use Android states

Player states (Android)
StateDescriptionTypeplayerAreControlsEnabledIf the player controls are enabled.booleanplayerAspectRatioThe player current aspect ratio.stringplayerErrorContains information about the last error that occurred in the player, including title, m…

State	Description	Type
`playerAreControlsEnabled`	If the player controls are enabled.	boolean
`playerAspectRatio`	The player current aspect ratio.	string
`playerError`	Contains information about the last error that occurred in the player, including title, message and code. Example: `class Error( val title: String? = null, val message: String? = null )`	object
`playerIsAlertDialogDisplayed`	If the player has the alert dialog displayed.	boolean
`playerIsBuffering`	If the player is loading the media resource.	boolean
`playerIsCriticalPathReady`	If the player is ready to play.	boolean
`playerIsMuted`	If the player is muted.	boolean
`playerIsNavigationEnabled`	If the next and previous controls in the PiP are enabled.	boolean
`playerIsPlaybackAllowed`	If the player is allowed to play, depending on the browser permissions.	boolean
`playerIsPlaying`	If the player is currently playing video or ad content.	boolean
`playerIsReplayScreen`	If the player is in replay screen.	boolean
`playerIsStartScreen`	If the player is in start screen.	boolean
`playerNextVideo`	The id of the video next video in the queue.	string
`playerPlaybackPermissionReason`	The reason why the playback has been allowed or not.	string
`playerPlaybackSpeed`	The current playback speed.	number
`playerPresentationMode`	The current mode where the player is displayed.	string
`playerPrevVideo`	The id of the video previous video which was played.	string
`playerScaleMode`	The player’s current scale mode.	string
`playerVolume`	The current volume level. The volume and mute params operate separately, therefore, you could have a player with full volume, but also muted.	number

States	Description	Type
`videoCreatedTime`	The timestamp that corresponds to the creation of the video.	date
`videoDuration`	The duration time of the video resource in seconds.	number
`videoId`	The unique ID of the video.	string
`videoIsCreatedForKids`	If the video is created for children.	boolean
`videoIsPasswordRequired`	If the video required a password to be read.	boolean
`videoOwnerId`	The id of the owner of the video.	string
`videoOwnerScreenName`	The screen name of the owner of the video.	string
`videoOwnerUsername`	The user name of the owner of the video.	string
`videoQualitiesList`	The video qualities that are available.	string
`videoQuality`	The quality value of the video loaded.	string
`videoSubtitlesList`	The language codes of the subtitle tracks which are available for the current media resource.	string
`videoSubtitles`	The language code of the subtitle track that is currently enabled.	string
`videoTime`	The current playback position of the video in seconds.	number
`videoTitle`	The title of the video loaded.	string

States	Description	Type
`adAdvertiserName`	The advertiser name.	string
`adCompanion`	An array of parsed companion ad creatives. Example: class AdCompanion( val id: String? = null, val adId: String? = null, val sequence: String? = null, val apiFramework: String? = null, val type: String? = null, val adCompanionRequired: Boolean? = null, )	array
`adCreativeAdId`	The universal ad id node from the VAST or the ad id of the creative node from the VAST.	string
`adCreativeId`	The id of the creative node from the VAST.	string
`adDescription`	The description of the ad.	string
`adDuration`	The duration time of the ad resource in seconds.	number
`adEndedReason`	The reason why the last ad ended.	string
`adError`	Contains information about the last error that occurred with the ad.	string
`adId`	The id of the ad.	string
`adIsPlaying`	If an ad resource is running.	boolean
`adIsSkippable`	If the ad can be skipped by the user at this moment.	boolean
`adPosition`	The position of the ad in the video.	string
`adSkipOffset`	The remaining time before the ad can be skipped, or `-1` if no ad is running.	number
`adTime`	The current playback position of an ad in seconds.	number
`adTitle`	The title of the ad.	string

Android SDK - Player states

Player states (Android)

Video states (Android)

Ad states (Android)