Class AnnotoPlayer

constructor

• new AnnotoPlayer(logger, widget): AnnotoPlayer

• Parameters

  • logger: ILogger

  • widget: IWidgetService

  Returns AnnotoPlayer

videojs

aspectRatio

• get aspectRatio(): PlayerAspectRatioType

• Returns PlayerAspectRatioType

currentSrc

• get currentSrc(): ISourceObject

• Returns ISourceObject

currentTime

• get currentTime(): number

• Returns number

duration

• get duration(): number

• Returns number

fullscreen

• get fullscreen(): boolean

• Returns boolean

isSetup

• get isSetup(): boolean

• Returns boolean

paused

• get paused(): boolean

• Returns boolean

addTextTrack

• addTextTrack(trackOpts): Promise<void> | Promise<HTMLTrackElement>

• Parameters

  • trackOpts: ITextTrackOptions

  Returns Promise<void> | Promise<HTMLTrackElement>

close

• close(): Promise<void>

• Returns Promise<void>

closeWidget

• closeWidget(): Promise<void>

• Returns Promise<void>

  Deprecated

  Use destroyWidget() instead

destroyWidget

• destroyWidget(): Promise<void>

• Returns Promise<void>

getImplementation

• getImplementation(): Promise<IPlayerImplementation>

• Returns Promise<IPlayerImplementation>

getWidgetApi

• getWidgetApi(): Promise<IAnnotoApi>

• Returns Promise<IAnnotoApi>

layout

• layout(): Promise<ILayoutPlugin>

• Returns Promise<ILayoutPlugin>

loadSrc

• loadSrc(src?, pipSrc?, audioSource?): Promise<AnnotoPlayer>

• Parameters

  • Optional src: ISourceObject

  • Optional pipSrc: ISecondarySourceObject

  • Optional audioSource: AudioSourceType

  Returns Promise<AnnotoPlayer>

loadWidget

• loadWidget(host?): Promise<void>

• Parameters

  • Optional host: HTMLElement

  Returns Promise<void>

off

• off(eventT, cb): Promise<void>

• Parameters

  • eventT: PlayerEventType

  • cb: PlayerEventCallback

  Returns Promise<void>

on

• on(eventT, cb): Promise<void>

• Parameters

  • eventT: PlayerEventType

  • cb: PlayerEventCallback

  Returns Promise<void>

once

• once(eventT, cb): Promise<void>

• Parameters

  • eventT: PlayerEventType

  • cb: PlayerEventCallback

  Returns Promise<void>

pause

• pause(): Promise<VideoJsPlayer>

• Returns Promise<VideoJsPlayer>

pip

• pip(): Promise<IPipPlugin>

• Returns Promise<IPipPlugin>

play

• play(): Promise<void>

• Returns Promise<void>

removeTextTrackKind

• removeTextTrackKind(kind): Promise<void>

• Parameters

  • kind: Kind

  Returns Promise<void>

reset

• reset(): Promise<void>

• Returns Promise<void>

setAspectRatio

• setAspectRatio(ratio): Promise<any>

• Parameters

  • ratio: PlayerAspectRatioType

  Returns Promise<any>

setAutioSource

• setAutioSource(source?): Promise<void>

• Parameters

  • source: AudioSourceType = 'primary'

  Returns Promise<void>

setAutoplay

• setAutoplay(val): void

• Parameters

  • val: boolean

  Returns void

setPipLayout

• setPipLayout(params): Promise<void>

• Parameters

  • params: ILayoutParams

  Returns Promise<void>

setPipUI

• setPipUI(ui): Promise<void>

• Parameters

  • ui: IPipPluginUI

  Returns Promise<void>

setPoster

• setPoster(posterUrl): Promise<void>

• Parameters

  • posterUrl: string

  Returns Promise<void>

setup

• setup(element, options?): Promise<IPlayerImplementation>

• Parameters

  • element: string | Element

  • options: IPlayerOptions = {}

  Returns Promise<IPlayerImplementation>

setupWidget

• setupWidget(config?, bootstrapUrl?, playerParams?): Promise<void>

• Parameters

  • Optional config: Omit<IConfig<IFeatures>, "widgets">

  • Optional bootstrapUrl: string

  • Optional playerParams: Record<string, unknown>

  Returns Promise<void>

timeCut

• timeCut(): Promise<ITimeCutPlugin>

• Returns Promise<ITimeCutPlugin>