Pixellot WebSDK

# Class: Player

WebSDK Player

Base Pixellot WebSDK Player player class from which you can create video player.

# Hierarchy

  • default

    ↳ Player

# Implements

# Table of contents

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new Player(element, options?)

Pixellot Player

const { SDKApi, Player } = window.PixellotWebSDK;

SDKApi.baseUrl('https://my-api-base-url.com');
SDKApi.projectId('test');

const el = document.querySelector("#testVideo");
const brushWrapper = document.querySelector("#brush-wrapper");
const player = new Player(el, { autoplay: true });

# Parameters

Name Type
element HTMLElement
options PixellotPlayerOptions

# Overrides

CorePlayer.constructor

# Properties

# ads

• ads: PlayerAds

# Implementation of

PixellotPlayer.ads

# Inherited from

CorePlayer.ads

# analytics

• analytics: PlayerAnalytics

# Implementation of

PixellotPlayer.analytics

# Inherited from

CorePlayer.analytics

# id

• id: string | number

# Implementation of

PixellotPlayer.id

# Inherited from

CorePlayer.id

# isPlaying

• isPlaying: undefined | boolean

# Inherited from

CorePlayer.isPlaying

# pano

• pano: PlayerPano

# Implementation of

PixellotPlayer.pano

# recorder

• recorder: PlayerRecorder

# Implementation of

PixellotPlayer.recorder

# tags

• tags: PlayerTags

# theoPlayer

• theoPlayer: any = null

# Implementation of

PixellotPlayer.theoPlayer

# Inherited from

CorePlayer.theoPlayer

# thumbnails

• thumbnails: PlayerThumbnails

# Implementation of

PixellotPlayer.thumbnails

# ui

• ui: PlayerUI

# Implementation of

PixellotPlayer.ui

# Inherited from

CorePlayer.ui

# vdjsPlayer

• vdjsPlayer: any

# Implementation of

PixellotPlayer.vdjsPlayer

# Inherited from

CorePlayer.vdjsPlayer

# Accessors

# autoplay

• get autoplay(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.autoplay

# Inherited from

CorePlayer.autoplay

• set autoplay(autoplay): void

# Parameters

Name Type
autoplay boolean

# Returns

void

# Implementation of

PixellotPlayer.autoplay

# Inherited from

CorePlayer.autoplay

# bandwidth

• get bandwidth(): number

# Returns

number

# Inherited from

CorePlayer.bandwidth

# config

• get config(): PixellotPlayerConfig

# Returns

PixellotPlayerConfig

# Implementation of

PixellotPlayer.config

• set config(options): void

# Parameters

Name Type
options PixellotPlayerConfigUpdate

# Returns

void

# Implementation of

PixellotPlayer.config

# controls

• get controls(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.controls

# Inherited from

CorePlayer.controls

• set controls(controls): void

# Parameters

Name Type
controls boolean

# Returns

void

# Implementation of

PixellotPlayer.controls

# Inherited from

CorePlayer.controls

# currentTime

• get currentTime(): number

# Returns

number

# Implementation of

PixellotPlayer.currentTime

# Inherited from

CorePlayer.currentTime

• set currentTime(time): void

# Parameters

Name Type
time number

# Returns

void

# Implementation of

PixellotPlayer.currentTime

# Inherited from

CorePlayer.currentTime

# duration

• get duration(): number

# Returns

number

# Implementation of

PixellotPlayer.duration

# Inherited from

CorePlayer.duration

# element

• get element(): HTMLElement

# Returns

HTMLElement

# Implementation of

PixellotPlayer.element

# Inherited from

CorePlayer.element

# hasStarted

• get hasStarted(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.hasStarted

# Inherited from

CorePlayer.hasStarted

# isFullscreen

• get isFullscreen(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.isFullscreen

# Inherited from

CorePlayer.isFullscreen

# isLive

• get isLive(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.isLive

# Inherited from

CorePlayer.isLive

# isMuted

• get isMuted(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.isMuted

# Inherited from

CorePlayer.isMuted

# isPaused

• get isPaused(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.isPaused

# Inherited from

CorePlayer.isPaused

# mode

• get mode(): PlayerMode

# Returns

PlayerMode

# Implementation of

PixellotPlayer.mode

• set mode(mode): void

# Parameters

Name Type
mode PlayerMode

# Returns

void

# Implementation of

PixellotPlayer.mode

# poster

• get poster(): string

# Returns

string

# Implementation of

PixellotPlayer.poster

# Inherited from

CorePlayer.poster

• set poster(poster): void

# Parameters

Name Type
poster string

# Returns

void

# Implementation of

PixellotPlayer.poster

# Inherited from

CorePlayer.poster

# readyState

• get readyState(): READY_STATE

# Returns

READY_STATE

# Implementation of

PixellotPlayer.readyState

# Inherited from

CorePlayer.readyState

# rootElement

• get rootElement(): HTMLElement

# Returns

HTMLElement

# Implementation of

PixellotPlayer.rootElement

# Inherited from

CorePlayer.rootElement

# src

• get src(): string

# Returns

string

# Implementation of

PixellotPlayer.src

# Inherited from

CorePlayer.src

• set src(src): void

# Parameters

Name Type
src string

# Returns

void

# Implementation of

PixellotPlayer.src

# Inherited from

CorePlayer.src

# userActive

• get userActive(): boolean

# Returns

boolean

# Implementation of

PixellotPlayer.userActive

# Inherited from

CorePlayer.userActive

• set userActive(state): void

# Parameters

Name Type
state boolean

# Returns

void

# Implementation of

PixellotPlayer.userActive

# Inherited from

CorePlayer.userActive

# videoElement

• get videoElement(): null | HTMLVideoElement

# Returns

null | HTMLVideoElement

# Implementation of

PixellotPlayer.videoElement

# Inherited from

CorePlayer.videoElement

# videoHeight

• get videoHeight(): number

# Returns

number

# Implementation of

PixellotPlayer.videoHeight

# Inherited from

CorePlayer.videoHeight

# videoWidth

• get videoWidth(): number

# Returns

number

# Implementation of

PixellotPlayer.videoWidth

# Inherited from

CorePlayer.videoWidth

# views

• get views(): null | number

# Returns

null | number

# Implementation of

PixellotPlayer.views

• set views(value): void

# Parameters

Name Type
value null | number

# Returns

void

# Implementation of

PixellotPlayer.views

# volume

• get volume(): number

# Returns

number

# Implementation of

PixellotPlayer.volume

# Inherited from

CorePlayer.volume

• set volume(volume): void

# Parameters

Name Type
volume number

# Returns

void

# Implementation of

PixellotPlayer.volume

# Inherited from

CorePlayer.volume

# Methods

# destroy

▸ destroy(): void

Destroys the video player and does any necessary cleanup

player.destroy();

# Returns

void

# Implementation of

PixellotPlayer.destroy

# Inherited from

CorePlayer.destroy

# emit

▸ emit(eventName, args): void

# Parameters

Name Type
eventName string
args any

# Returns

void

# Implementation of

PixellotPlayer.emit

# exitFullscreen

▸ exitFullscreen(): void

Return the video to its normal size after having been in full screen mode

player.exitFullscreen();

# Returns

void

# Implementation of

PixellotPlayer.exitFullscreen

# Inherited from

CorePlayer.exitFullscreen

# getRendition

▸ getRendition(): string

# Returns

string

# off

▸ off(eventName, callback): void

# Parameters

Name Type
eventName string
callback any

# Returns

void

# Implementation of

PixellotPlayer.off

# on

▸ on(eventName, callback): void

# Parameters

Name Type
eventName string
callback any

# Returns

void

# Implementation of

PixellotPlayer.on

# once

▸ once(eventName, callback): void

# Parameters

Name Type
eventName string
callback any

# Returns

void

# Implementation of

PixellotPlayer.once

# pause

▸ pause(): Promise<void>

Pauses video playback

player.pause();

# Returns

Promise<void>

# Implementation of

PixellotPlayer.pause

# Inherited from

CorePlayer.pause

# play

▸ play(): Promise<void>

Starts playing video playback

player.play();

# Returns

Promise<void>

# Implementation of

PixellotPlayer.play

# Inherited from

CorePlayer.play

# playTime

▸ playTime(startTime, endTime): void

Method to play provided time range. Play from start and pause at the end.

# Parameters

Name Type Description
startTime number start time of the range
endTime number end time of the range player.playTime(120, 125);

# Returns

void

# Implementation of

PixellotPlayer.playTime

# requestFullscreen

▸ requestFullscreen(): void

Increase the size of the video to full screen

player.requestFullscreen();

# Returns

void

# Implementation of

PixellotPlayer.requestFullscreen

# Inherited from

CorePlayer.requestFullscreen

# setMeta

▸ setMeta(metadata): void

# Parameters

Name Type
metadata PlayerMetadata

# Returns

void

# Implementation of

PixellotPlayer.setMeta

# setSrc

▸ setSrc(src, mode?): void

Set video source(s) to the player

# Parameters

Name Type Description
src string | PlayerSource The player video source(s)
mode? PlayerMode Player mode. 'hd' by default player.setSrc('https://cdn.theoplayer.com/video/big_buck_bunny/big_buck_bunny.m3u8'); // or set both hd and pano // pano in the end will set player to the pano source from beginning player.setSrc({ hd: '/hd-source.mp4', pano: '/pano-source.m3u8' }, 'pano');

# Returns

void

# Implementation of

PixellotPlayer.setSrc

# stop

▸ stop(): void

Stops media playback and resets player

player.stop();

# Returns

void

# Implementation of

PixellotPlayer.stop

# Inherited from

CorePlayer.stop

← AdSource →