import {Display} from '@mixer/cdk'

public class | source

Display

Extends:

eventemitter3~EventEmitter → Display

Display modified the display of interactive controls.

Method Summary

Public Methods
public	getPosition(): IVideoPositionList \| undefined Returns the video position at this moment in time.
public	getSettings(): ISettings \| undefined Returns the current display settings at this instant in time.
public	maximize() Restores previously minimize()'d controls.
public	minimize(message: string) Hides the controls and displays a loading spinner, optionally with a custom message.
public	moveVideo(options: IVideoPositionOptions) Moves the position of the video on the screen.
public	position(): Observable<IVideoPositionList> Returns an observable of the video's current position, relative to the frame's screen.
public	settings(): Observable<ISettings> Returns an observable of the current project settings.

Public Methods

public getPosition(): IVideoPositionList | undefined source

Returns the video position at this moment in time. Returns undefined if the video position hasn't been sent yet. If undefined, you should retry, or listen to the display.position() observable to be notified when it comes in.

Return:

IVideoPositionList | undefined

public getSettings(): ISettings | undefined source

Returns the current display settings at this instant in time. It will be undefined if the settings have not been sent yet. If undefined, you should retry, or listen to the display.settings() observable to be notified when it comes in.

Return:

ISettings | undefined

public maximize() source

Restores previously minimize()'d controls.

public minimize(message: string) source

Hides the controls and displays a loading spinner, optionally with a custom message. This is useful for transitioning. If called while the controls are already minimized, it will update the message.

Params:

Name	Type	Attribute	Description
message	string	optional

public moveVideo(options: IVideoPositionOptions) source

Moves the position of the video on the screen.

Params:

Name	Type	Attribute	Description
options	IVideoPositionOptions

public position(): Observable<IVideoPositionList> source

Returns an observable of the video's current position, relative to the frame's screen. For example, you can use it to set the position of an overlaid div:

mixer.display.position().subscribe(position => {
  videoOverlay.style.top = `${position.top}px`;
  videoOverlay.style.left = `${position.left}px`;
  videoOverlay.style.height = `${position.height}px`;
  videoOverlay.style.width = `${position.width}px`;
});

Return:

Observable<IVideoPositionList>

public settings(): Observable<ISettings> source

Returns an observable of the current project settings.

Return:

Observable<ISettings>