Interface Presentation

The presentation API.

interface Presentation {
    currentMode: PresentationMode;
    addEventListener<TType extends keyof PresentationEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<PresentationEventMap[TType]>,
    ): void;
    removeEventListener<TType extends keyof PresentationEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<PresentationEventMap[TType]>,
    ): void;
    requestMode(mode: PresentationMode): void;
    supportsMode(mode: PresentationMode): boolean;
}

Hierarchy (View Summary)

EventDispatcher<PresentationEventMap>
- Presentation

Index

Properties

Methods

addEventListener removeEventListener requestMode supportsMode

Properties

`Readonly`currentMode

currentMode: PresentationMode

The active presentation mode of the player.

Default Value

'inline'

Methods

addEventListener

addEventListener<TType extends keyof PresentationEventMap>(
type: TType | readonly TType[],
listener: EventListener<PresentationEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof PresentationEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<PresentationEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

removeEventListener

removeEventListener<TType extends keyof PresentationEventMap>(
type: TType | readonly TType[],
listener: EventListener<PresentationEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof PresentationEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<PresentationEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener

requestMode

requestMode(mode: PresentationMode): void
Change the presentation mode of the player.
Parameters
- mode: PresentationMode
  The requested presentation mode.
Returns void

supportsMode

supportsMode(mode: PresentationMode): boolean
Whether the player supports the provided presentation mode.
Parameters
- mode: PresentationMode
  The presentation mode to verify.
Returns boolean
Whether the player supports mode.