Class CogsVideoPlayer

Constructors

constructor

new CogsVideoPlayer(cogsConnection, parentElement?): CogsVideoPlayer
Parameters
- cogsConnection: CogsConnection<any, Record<never, never>>
- parentElement: HTMLElement = DEFAULT_PARENT_ELEMENT
Returns CogsVideoPlayer
- Defined in src/VideoPlayer.ts:34

Properties

`Private` `Optional` activeClip

activeClip?: {
path: string;
playId: string;
}

Type declaration

path: string
playId: string

`Private` cogsConnection

cogsConnection: CogsConnection<any, Record<never, never>>

`Private` eventTarget

eventTarget: EventTarget = ...

`Private` globalVolume

globalVolume: number = 1

`Private` parentElement

parentElement: HTMLElement

`Private` `Optional` pendingClip

pendingClip?: {
    actionOncePlaying: "pause" | "play" | "stop";
    path: string;
    playId: string;
}

Type declaration

actionOncePlaying: "pause" | "play" | "stop"
path: string
playId: string

`Private` sinkId

sinkId: string = ''

`Private` videoClipPlayers

videoClipPlayers: {
[path: string]: InternalClipPlayer;
} = {}

Type declaration

[path: string]: InternalClipPlayer

Methods

addEventListener

addEventListener<EventName>(type, listener, options?): void
Type Parameters
- EventName extends keyof EventTypes
Parameters
- type: EventName
- listener: ((ev) => void)
  - - (ev): void
    - Parameters
      ev: CustomEvent<EventTypes[EventName]>
      Returns void
- Optional options: boolean | AddEventListenerOptions
Returns void
- Defined in src/VideoPlayer.ts:325

`Private` createClipPlayer

createClipPlayer(path, config): InternalClipPlayer
Parameters
- path: string
- config: {
      ephemeral: boolean;
      fit: MediaObjectFit;
      preload: "auto" | "none" | "metadata";
  }
  - ephemeral: boolean
  - fit: MediaObjectFit
  - preload: "auto" | "none" | "metadata"
Returns InternalClipPlayer
- Defined in src/VideoPlayer.ts:410

`Private` createVideoElement

createVideoElement(path, config, __namedParameters): HTMLVideoElement
Parameters
- path: string
- config: {
      ephemeral: boolean;
      fit: MediaObjectFit;
      preload: "auto" | "none" | "metadata";
  }
  - ephemeral: boolean
  - fit: MediaObjectFit
  - preload: "auto" | "none" | "metadata"
- __namedParameters: {
  volume: number;
  }
  - volume: number
Returns HTMLVideoElement
- Defined in src/VideoPlayer.ts:343

`Private` dispatchEvent

dispatchEvent<EventName>(type, detail): void
Type Parameters
- EventName extends keyof EventTypes
Parameters
- type: EventName
- detail: EventTypes[EventName]
Returns void
- Defined in src/VideoPlayer.ts:339

`Private` handleStoppedClip

handleStoppedClip(path): void
Parameters
- path: string
Returns void
- Defined in src/VideoPlayer.ts:215

`Private` notifyClipStateListeners

notifyClipStateListeners(playId, file, status): void
Parameters
- playId: string
- file: string
- status: MediaStatus
Returns void
- Defined in src/VideoPlayer.ts:320

`Private` notifyStateListeners

notifyStateListeners(): void
Returns void
- Defined in src/VideoPlayer.ts:301

pauseVideoClip

pauseVideoClip(): void
Returns void
- Defined in src/VideoPlayer.ts:150

playVideoClip

playVideoClip(path, __namedParameters): void
Parameters
- path: string
- __namedParameters: {
      fit: MediaObjectFit;
      loop: boolean;
      playId: string;
      volume: number;
  }
  - fit: MediaObjectFit
  - loop: boolean
  - playId: string
  - volume: number
Returns void
- Defined in src/VideoPlayer.ts:114

removeEventListener

removeEventListener<EventName>(type, listener, options?): void
Type Parameters
- EventName extends keyof EventTypes
Parameters
- type: EventName
- listener: ((ev) => void)
  - - (ev): void
    - Parameters
      ev: CustomEvent<EventTypes[EventName]>
      Returns void
- Optional options: boolean | EventListenerOptions
Returns void
- Defined in src/VideoPlayer.ts:332

resetParentElement

resetParentElement(): void
Returns void
- Defined in src/VideoPlayer.ts:102

setAudioSink

setAudioSink(sinkId): void
Parameters
- sinkId: string
Returns void
- Defined in src/VideoPlayer.ts:249

setGlobalVolume

setGlobalVolume(globalVolume): void
Parameters
- globalVolume: number
Returns void
- Defined in src/VideoPlayer.ts:106

setParentElement

setParentElement(parentElement): void
Parameters
- parentElement: HTMLElement
Returns void
- Defined in src/VideoPlayer.ts:95

setVideoClipFit

setVideoClipFit(__namedParameters): void
Parameters
- __namedParameters: {
  fit: MediaObjectFit;
  }
  - fit: MediaObjectFit
Returns void
- Defined in src/VideoPlayer.ts:200

setVideoClipVolume

setVideoClipVolume(__namedParameters): void
Parameters
- __namedParameters: {
  volume: number;
  }
  - volume: number
Returns void
- Defined in src/VideoPlayer.ts:179

stopVideoClip

stopVideoClip(): void
Returns void
- Defined in src/VideoPlayer.ts:167

`Private` unloadClip

unloadClip(path): void
Parameters
- path: string
Returns void
- Defined in src/VideoPlayer.ts:421

`Private` updateConfig

updateConfig(newPaths): void
Parameters
- newPaths: {
  [path: string]: Media;
  }
  - [path: string]: Media
Returns void
- Defined in src/VideoPlayer.ts:256

`Private` updateVideoClipPlayer

updateVideoClipPlayer(path, update): void
Parameters
- path: string
- update: ((player) => null | InternalClipPlayer)
  - - (player): null | InternalClipPlayer
    - Parameters
      player: InternalClipPlayer
      Returns null | InternalClipPlayer
Returns void
- Defined in src/VideoPlayer.ts:237

Class CogsVideoPlayer

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

cogsConnection: CogsConnection<any, Record<never, never>>

parentElement: HTMLElement = DEFAULT_PARENT_ELEMENT

Returns CogsVideoPlayer

Properties

Private Optional activeClip

Type declaration

path: string

playId: string

Private cogsConnection

Private eventTarget

Private globalVolume

Private parentElement

Private Optional pendingClip

Type declaration

actionOncePlaying: "pause" | "play" | "stop"

path: string

playId: string

Private sinkId

Private videoClipPlayers

Type declaration

[path: string]: InternalClipPlayer

Methods

addEventListener

Type Parameters

EventName extends keyof EventTypes

Parameters

type: EventName

listener: ((ev) => void)

Parameters

ev: CustomEvent<EventTypes[EventName]>

Returns void

Optional options: boolean | AddEventListenerOptions

Returns void

Private createClipPlayer

Parameters

path: string

config: { ephemeral: boolean; fit: MediaObjectFit; preload: "auto" | "none" | "metadata"; }

ephemeral: boolean

fit: MediaObjectFit

preload: "auto" | "none" | "metadata"

Returns InternalClipPlayer

Private createVideoElement

Parameters

path: string

config: { ephemeral: boolean; fit: MediaObjectFit; preload: "auto" | "none" | "metadata"; }

ephemeral: boolean

fit: MediaObjectFit

preload: "auto" | "none" | "metadata"

__namedParameters: { volume: number; }

volume: number

Returns HTMLVideoElement

Private dispatchEvent

Type Parameters

EventName extends keyof EventTypes

Parameters

type: EventName

detail: EventTypes[EventName]

Returns void

Private handleStoppedClip

Parameters

path: string

Returns void

Private notifyClipStateListeners

Parameters

playId: string

file: string

status: MediaStatus

Returns void

Private notifyStateListeners

Returns void

pauseVideoClip

Returns void

`Private` `Optional` activeClip

`Private` cogsConnection

`Private` eventTarget

`Private` globalVolume

`Private` parentElement

`Private` `Optional` pendingClip

`Private` sinkId

`Private` videoClipPlayers

`Optional` options: boolean | AddEventListenerOptions

`Private` createClipPlayer

config: {
ephemeral: boolean;
fit: MediaObjectFit;
preload: "auto" | "none" | "metadata";
}

`Private` createVideoElement

config: {
ephemeral: boolean;
fit: MediaObjectFit;
preload: "auto" | "none" | "metadata";
}

__namedParameters: {
volume: number;
}

`Private` dispatchEvent

`Private` handleStoppedClip

`Private` notifyClipStateListeners

`Private` notifyStateListeners

__namedParameters: {
fit: MediaObjectFit;
loop: boolean;
playId: string;
volume: number;
}

`Optional` options: boolean | EventListenerOptions

__namedParameters: {
fit: MediaObjectFit;
}

__namedParameters: {
volume: number;
}

`Private` unloadClip

`Private` updateConfig

newPaths: {
[path: string]: Media;
}

`Private` updateVideoClipPlayer