Web SDK - Player states

adAdvertiserName

The advertiser name or null.

adCompanion

An array of parsed companion ad creatives.

adCreativeAdId

The universal ad id node from the VAST or the ad id of the creative node from the VAST.

adCreativeId

The id of the creative node from the VAST.

adDescription

The description of the ad or null.

adDuration

The duration time of the ad resource in seconds.

adEndedReason

The reason why the last ad ended.

Possible values: error stopped skipped interrupted or null

adError

Contains information about the last ad error that occurred in the Player, including message and code.

object

adId

The id of the ad.

adIsPlaying

Whether an ad resource is running.

adIsSkippable

Whether the ad can be skipped by the user at this moment.

adPosition

The position of the ad in the video, or null if no ad is running.

Possible values: preroll midroll postroll or null

adSkipOffset

The remaining time (in seconds) before the ad can be skipped, or -1 if no ad is running.

adTime

The current playback position of an ad in seconds.

adTitle

The title of the ad, or null.

playerAspectRatio

The Player current aspect ratio.

Possible values: inherit, 16:9, 4:3, 1:1, 3:4, 9:16

playerError

Contains information about the last error that occurred in the player, including title, message and code.

object

playerInstanceI

Contains a unique identifier generated for each player instance.
Format: uuid V4

A player instance is generated each time a player is created, with either dailymotion.createPlayer or the Player Embed Script.

Player instance ≠ player configuration, i.e when loading on the same page 3 players using the same player configuration, 3 unique player instances will be generated.

playerIsAlertDialogDisplayed

If the Player has the alert dialog displayed.

playerIsBuffering

If the Player is loading the media resource.

playerIsCriticalPathReady

If the Player is ready to play.

playerIsMuted

If the Player is muted.

playerIsNavigationEnabled

If the next and previous controls in the PiP are enabled.

playerIsPipNativeSupported

If the Player does support the native PiP.

playerIsPlaybackAllowed

If the Player is allowed to play, depending on the browser permissions.

playerIsPlaying

If the Player is currently playing video or ad content.

playerIsStartScreen

If the Player is in start screen.

playerIsReplayScreen

If the Player is in replay screen.

playerIsViewable

If the Player is within the viewability threshold.

playerNextVideo

The ID of the next video in the queue.

playerPipDisplay

The current display mode of PiP, whether it is displayed on a larger/smaller screen.

Possible values: largeViewport or smallViewport

playerPipStatus

The current PiP feature status.

Possible values: enabled disabled or closed

playerPipIsExpanded

If the mobile sticky PiP is expanded.

playerPlaybackPermissionReason

The reason why the playback has been allowed or not.

Possible values: allowedFallbackMuted allowed rejectedInactiveTab or rejectedByBrowser

playerPlaybackSpeed

The player current playback speed.

**Possible values: **[0.25, 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2]

playerPresentationMode

The current mode where the Player is displayed.

Possible values: inline nativePip pip or fullscreen

playerPrevVideo

The id of the previously played video.

playerScaleMode

The Player’s current scale mode.

Possible values: fit fill fillLeft fillRight fillTop or fillBottom

playerVolume

The current volume level. The volume and mute params operate separately, therefore, you could have a player with full volume, but also muted.

Possible values: Between 0.0 and 1.0

recommendedVideoDisplayed

Information about the recommended videos currently displayed.

Example: [{index: 0, xid: 'xid1'}, {index: 1, xid: 'xid2'}]

object

videoCreatedTime

The timestamp that corresponds to the creation of the video

videoAspectRatio

Number representing the aspect ratio of the video (e.g., 1.777 for 16:9)

videoDuration

The duration time of the video resource in seconds.

videoId

The unique ID of the video.

videoIsCreatedForKids

If the video is created for children.

videoIsPasswordRequired

If the video requires a password to be read.

videoLoadedFrom

The origin of a video load.

Possible values: playback_button, replay_button, reload_button, previous_button, next_button, auto_skip, auto_next, carousel_card, password, api, programmatic

videoOwnerAvatars

Contains the avatar of the video owner, including the height of the image in pixels and its URL.

object

videoOwnerId

The id of the owner of the video.

videoOwnerScreenname

The screen name of the owner of the video.

videoOwnerUsername

The user name of the owner of the video.

videoPosters

Contains the thumbnail of the video, including the height of the image in pixels and its URL.

object

videoQualitiesList

The video qualities that are available.

videoQuality

The quality value of the video loaded.

videoSubtitles

The language code of the subtitle track that is currently enabled.

videoSubtitlesList

The language codes of the subtitle tracks which are available for the current media resource.

videoTime

The current playback position of the video in seconds.

videoTitle

The title of the video loaded.

videoViewId

Contains a unique identifier generated each time a video is loaded in the Player.

Format: 19 random characters based on timestamp