Class Player

To use the SDK, create a new instance of the Player class.

This class contains all the methods and events to interact with the embedded movingimage player.

Example

Given the following embedded movingimage player iframe in your page:

<iframe id='mi-embedded-video' src="//e.video-cdn.net/watch?video-id=123&player-id=123&channel-id=123" allowfullscreen frameborder="0"></iframe>

You can initialize the player SDK like this:

const player = new Player('mi-embedded-video');

Then you can use the player object to interact with the embedded video player. For example:

// Add event handler to know when video is playing
player.on('play', () => {
  console.log('Video play requested!');
})

// Play the video
player.play().then(() => {
  console.log('Video is now playing!');
});

Index

Events

off

off<K extends PlayerEventNames>(
eventName: K,
callback?: EventCallback<PlayerEvents[K]>,
): void
Remove an event listener for the specified event.

If callback is not provided, all listeners for the event will be removed.

See PlayerEvents for a list of available events and their correspondent data.
Type Parameters
- K extends PlayerEventNames
Parameters
- eventName: K
  The name of the event.
- Optionalcallback: EventCallback<PlayerEvents[K]>
  The event callback to remove.
Returns void

on

on<K extends PlayerEventNames>(
eventName: K,
callback: EventCallback<PlayerEvents[K]>,
): void
Add an event listener for the specified event.

See PlayerEvents for a list of available events and their correspondent data.
Type Parameters
- K extends PlayerEventNames
Parameters
- eventName: K
  The name of the event.
- callback: EventCallback<PlayerEvents[K]>
  The event callback.
Returns void

Methods

autoplay

autoplay(mode?: AutoplayMode): Promise<void>
Attempts to autoplay the video.

By default, the player uses the 'any' mode. The video starts playing if the browser allows it. If not, the video is muted and autoplay is retried.
Parameters
- mode: AutoplayMode = 'any'
  The autoplay mode to use.
Returns Promise<void>
A promise that resolves when the video is playing.

destroy

destroy(): Promise<void>
Disposes this player instance and removes the player iframe from the DOM.

Returns Promise<void>
Remarks
After calling this method, the player instance is no longer usable, and a new one must be created.

getChannelId

getChannelId(): undefined | string
Gets the channel id of the channel this video belongs to.

Returns undefined | string
The channel id.

getCurrentTime

getCurrentTime(): Promise<number>
Gets the current playback position in seconds.

Returns Promise<number>
A promise that resolves with the current time in seconds.

getDuration

getDuration(): Promise<number>
Get the duration of the video in seconds.

Returns Promise<number>
A promise that resolves with the video duration in seconds.

getPlayerId

getPlayerId(): string
Gets the player id of the player configuration being used.

Returns string
The player id.

getVideoId

getVideoId(): string
Gets the video id of the video being played.

Returns string
The video id.

getVolume

getVolume(): Promise<number>
Gets the volume level between 0 and 1 of the video.

Returns Promise<number>
A promise that resolves with the volume level.

isMuted

isMuted(): Promise<boolean>
Gets the muted state of the video.

Returns Promise<boolean>
A promise that resolves with the muted state.

mute

mute(): Promise<void>
Mutes the video.

Returns Promise<void>
A promise that resolves when the video is muted.

pause

pause(): Promise<void>
Pauses the video if it's playing.

Returns Promise<void>
A promise that resolves when the video is paused.

play

play(): Promise<void>
Plays the video if it’s paused.

Returns Promise<void>
A promise that resolves when the video is playing.

Remarks
In some scenarios, playing unmuted video is not allowed. See Autoplay guide for media and Web Audio APIs for more info.

setAnalytics

setAnalytics(mode: AnalyticsMode): Promise<void>
Sets the analytics mode. By default, the player uses the 'minimal' mode.
Parameters
- mode: AnalyticsMode
  The analytics mode to set.
Returns Promise<void>

setColors

setColors(colors: ColorSettings): Promise<void>
Sets the player's colors.
Parameters
- colors: ColorSettings
  The color settings to override. If a color is not provided, the player will use the color defined in the Player Configuration (in VideoManager Pro).
Returns Promise<void>
A promise that resolves when the color settings are applied.

setCurrentTime

setCurrentTime(time: number): Promise<void>
Sets the current playback position in seconds.
Parameters
- time: number
  The time in seconds to seek to.
Returns Promise<void>
A promise that resolves when the media is seeked.

setLanguage

setLanguage(language: string): Promise<void>
Sets the player's language.
Parameters
- language: string
  The language code (ex: 'en' or 'de').
Returns Promise<void>
A promise that resolves when the language is set.

setVolume

setVolume(volume: number): Promise<void>
Sets the volume of the video.
Parameters
- volume: number
  The volume level between 0 and 1.
Returns Promise<void>
A promise that resolves when the volume is set.

unmute

unmute(): Promise<void>
Unmutes the video.

Returns Promise<void>
A promise that resolves when the video is unmuted.

Other

constructor

new Player(element: string | Element, options?: PlayerParameters): Player
Create a new Player SDK instance, and connect it to the movingimage embedded player. If options are provided, it will create a new embedded player inside the element.
Parameters
- element: string | Element
  The id or iframe HTML element, to bind the SDK to. If options are provided, this should be the parent element instead.
- Optionaloptions: PlayerParameters
  Optional parameters to create the embedded player.
Returns Player

`Static`allPlayers

allPlayers(): Player[]
Finds all the players in the entire page and connects the SDK to them.

Returns Player[]
An array of all the players found in the page.

Class Player

Example

Index

Events

Methods

Other

Events

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Methods

autoplay

Parameters

Returns Promise<void>

destroy

Returns Promise<void>

Remarks

getChannelId

Returns undefined | string

getCurrentTime

Returns Promise<number>

getDuration

Returns Promise<number>

getPlayerId

Returns string

getVideoId

Returns string

getVolume

Returns Promise<number>

isMuted

Returns Promise<boolean>

mute

Returns Promise<void>

pause

Returns Promise<void>

play

Returns Promise<void>

Remarks

setAnalytics

Parameters

Returns Promise<void>

setColors

Parameters

Returns Promise<void>

setCurrentTime

Parameters

Returns Promise<void>

setLanguage

Parameters

Returns Promise<void>

setVolume

Parameters

Returns Promise<void>

unmute

Returns Promise<void>

Other

constructor

Parameters

Returns Player

StaticallPlayers

Returns Player[]

Settings

On This Page

`Static`allPlayers