# Interface: PixellotPlayerCore

PixellotPlayer.PixellotPlayerCore

# Hierarchy

PixellotPlayerCore

↳ THEOCorePlayer

↳ PixellotPlayer

# Table of contents

# Properties

# Accessors

# Methods

# Properties

# ads

• ads: PlayerAds

# analytics

• analytics: PlayerAnalytics

# theoPlayer

• Optional theoPlayer: any

# vdjsPlayer

• Optional vdjsPlayer: any

# Accessors

# autoplay

• get autoplay(): boolean

# Returns

boolean

• set autoplay(value): void

# Parameters

Name	Type
`value`	`boolean`

# Returns

void

# controls

• get controls(): boolean

# Returns

boolean

• set controls(value): void

# Parameters

Name	Type
`value`	`boolean`

# Returns

void

# currentTime

• get currentTime(): number

Gets or sets the current time (in seconds)

# Returns

number

• set currentTime(value): void

Gets or sets the current time (in seconds)

# Parameters

Name	Type
`value`	`number`

# Returns

void

# duration

• get duration(): number

# Returns

number

# element

• get element(): HTMLElement

# Returns

HTMLElement

# isFullscreen

• get isFullscreen(): boolean

Check if the player is in fullscreen mode or not

    - false: if not in fullscreen mode
    - true: if in fullscreen mode

const isFullscreen = player.isFullscreen;

# Returns

boolean

# isLive

• get isLive(): boolean

Returns boolean value if player video is in live mode or not

const isLive = player.isLive();

# Returns

boolean

# isMuted

• get isMuted(): boolean

# Returns

boolean

# isPaused

• get isPaused(): boolean

Check if the player is paused or has yet to play

    - false: if the media is currently playing
    - true: if media is not currently playing

const isPaused = player.isPaused();

# Returns

boolean

# poster

• get poster(): string

Gets or sets the poster image source url

# Returns

string

• set poster(src): void

Gets or sets the poster image source url

# Parameters

Name	Type
`src`	`string`

# Returns

void

# rootElement

• get rootElement(): HTMLElement

Returns video duration Normally gets the length in time of the video in seconds;

The duration of the video in seconds when getting

player.getDuration();

# Returns

HTMLElement

# src

• get src(): PlayerSrc

Get or set the video source. This method will set source explicitly to the video tag, so you may miss some of our features related to pano for eg.

# Returns

PlayerSrc

• set src(src): void

Get or set the video source. This method will set source explicitly to the video tag, so you may miss some of our features related to pano for eg.

# Parameters

Name	Type
`src`	`PlayerSrc`

# Returns

void

# userActive

• get userActive(): boolean

# Returns

boolean

• set userActive(state): void

# Parameters

Name	Type
`state`	`boolean`

# Returns

void

# videoElement

• get videoElement(): null | HTMLVideoElement

# Returns

null | HTMLVideoElement

# videoHeight

• get videoHeight(): number

# Returns

number

# videoWidth

• get videoWidth(): number

# Returns

number

# volume

• get volume(): number

Gets or sets current volume of the media

The current volume as a percent when getting

// get
const currentVolume = player.volume;
// set
player.volume = 0.5; // Set volume to half

# Returns

number

• set volume(value): void

Gets or sets current volume of the media

The current volume as a percent when getting

// get
const currentVolume = player.volume;
// set
player.volume = 0.5; // Set volume to half

# Parameters

Name	Type
`value`	`number`

# Returns

void

# Methods

# destroy

▸ destroy(): void

Destroys the video player and does any necessary cleanup

player.destroy();

# Returns

void

# pause

▸ pause(): void

Pauses video playback

player.pause();

# Returns

void

# play

▸ play(): void

Starts playing video playback

player.play();

# Returns

void

# stop

▸ stop(): void

Stops media playback and resets player

player.stop();

# Returns

void

← PixellotPlayer.PixellotPlayerConfigUpdate PixellotPlayer.PixellotPlayerOptions →