Class CogsConnection<Manifest>

Type Parameters

Manifest extends CogsPluginManifest

Constructors

constructor

new CogsConnection<Manifest>(manifest, __namedParameters?, initialClientState?): CogsConnection<Manifest>
Type Parameters
- Manifest extends CogsPluginManifest
Parameters
- manifest: Manifest
- __namedParameters: {
  hostname?: string;
  port?: number;
  } = {}
  - Optional hostname?: string
  - Optional port?: number
- initialClientState: undefined | Partial<DistributeObject<{
      [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
          name: Name;
      }>["value"]>
  }>> = undefined
Returns CogsConnection<Manifest>
- Defined in src/CogsConnection.ts:69

Properties

`Private` _selectedAudioOutput

_selectedAudioOutput: string = ''

`Private` _showPhase

_showPhase: ShowPhase = ShowPhase.Setup

`Private` _timerState

_timerState: null | TimerState = null

`Private` audioOutputs

audioOutputs: undefined | MediaDeviceInfo[] = undefined

Cached audio outputs use to look up the device/sink ID when a different device label is requested

`Private` clientSupportsHttp2Assets

clientSupportsHttp2Assets: boolean = false

Track the support for HTTP/2 assets on the client and server side Client side is dictated by the environment we're connecting from (and the media cogs-av-box version) Server side is dictated by the COGS version which added the HTTP/2 assets server itself

`Private` currentConfig

currentConfig: DistributeObject<{
    [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["config"]>[number]>, {
        name: Name;
    }>["value"]>
}> = ...

`Private` currentState

currentState: DistributeObject<{
    [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
        name: Name;
    }>["value"]>
}> = ...

`Private` eventTarget

eventTarget: EventTarget = ...

`Readonly` manifest

manifest: Manifest

`Private` serverSupportsHttp2Assets

serverSupportsHttp2Assets: boolean = false

`Private` urlParams

urlParams: URLSearchParams

URL parameters use for the websocket connection and asset URLs

`Private` websocket

websocket: WebSocket | default

Accessors

config

get config(): DistributeObject<{
    [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["config"]>[number]>, {
        name: Name;
    }>["value"]>
}>
Returns DistributeObject<{
    [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["config"]>[number]>, {
        name: Name;
    }>["value"]>
}>
- Defined in src/CogsConnection.ts:17

isConnected

get isConnected(): boolean
Returns boolean
- Defined in src/CogsConnection.ts:178

selectedAudioOutput

get selectedAudioOutput(): string
Returns string
- Defined in src/CogsConnection.ts:60

showPhase

get showPhase(): ShowPhase
Returns ShowPhase
- Defined in src/CogsConnection.ts:27

state

get state(): DistributeObject<{
    [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
        name: Name;
    }>["value"]>
}>
Returns DistributeObject<{
    [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
        name: Name;
    }>["value"]>
}>
- Defined in src/CogsConnection.ts:22

supportsHttp2Assets

get supportsHttp2Assets(): boolean
Returns boolean
- Defined in src/CogsConnection.ts:43

timerState

get timerState(): null | TimerState
Returns null | TimerState
- Defined in src/CogsConnection.ts:32

Methods

addEventListener

addEventListener<EventType>(type, listener, options?): void
Type Parameters
- EventType extends "open" | "message" | "close" | "config" | "state" | "event"
Parameters
- type: EventType
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: CogsConnectionEvent<Manifest> & {
      _cogsConnectionEventType: EventType;
      }
      Returns void
- Optional options: boolean | AddEventListenerOptions
Returns void
- Defined in src/CogsConnection.ts:245

close

close(): void
Returns void
- Defined in src/CogsConnection.ts:182

`Private` dispatchEvent

dispatchEvent<Event>(event): void
Type Parameters
- Event extends CogsConnectionOpenEvent | CogsConnectionCloseEvent | CogsMessageEvent | CogsConfigChangedEvent<DistributeObject<{
      [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["config"]>[number]>, {
          name: Name;
      }>["value"]>
  }>> | CogsStateChangedEvent<Partial<DistributeObject<{
      [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
          name: Name;
      }>["value"]>
  }>>> | CogsIncomingEvent<PluginManifestEventJson> | CogsIncomingEvent<{
      name: string;
      value?: {
          type: "string";
      } | {
          integer?: true;
          max?: number;
          min?: number;
          type: "number";
      } | {
          type: "boolean";
      } | {
          options: readonly string[];
          type: "option";
      };
  }>
Parameters
- event: Event
Returns void
- Defined in src/CogsConnection.ts:259

getAssetUrl

getAssetUrl(path): string
Return asset URLs using the information about the client and server support for HTTP/2
Parameters
- path: string
Returns string
- Defined in src/CogsConnection.ts:50

getAudioSinkId

getAudioSinkId(audioOutput): undefined | string
Parameters
- audioOutput: string
Returns undefined | string
- Defined in src/CogsConnection.ts:211

removeEventListener

removeEventListener<EventType>(type, listener, options?): void
Type Parameters
- EventType extends "open" | "message" | "close" | "config" | "state" | "event"
Parameters
- type: EventType
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: Extract<CogsConnectionOpenEvent, {
          _cogsConnectionEventType: EventType;
      }> | Extract<CogsConnectionCloseEvent, {
          _cogsConnectionEventType: EventType;
      }> | Extract<CogsMessageEvent, {
          _cogsConnectionEventType: EventType;
      }> | Extract<CogsConfigChangedEvent<DistributeObject<{
          [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["config"]>[number]>, {
              name: Name;
          }>["value"]>
      }>>, {
          _cogsConnectionEventType: EventType;
      }> | Extract<CogsStateChangedEvent<Partial<DistributeObject<{
          [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
              name: Name;
          }>["value"]>
      }>>>, {
          _cogsConnectionEventType: EventType;
      }> | Extract<CogsIncomingEventTypes<EventFromCogs<Manifest>>, {
          _cogsConnectionEventType: EventType;
      }>
      Returns void
- Optional options: boolean | EventListenerOptions
Returns void
- Defined in src/CogsConnection.ts:252

sendAudioOutputs

sendAudioOutputs(audioOutputs): void
Parameters
- audioOutputs: MediaDeviceInfo[]
Returns void
- Defined in src/CogsConnection.ts:227

sendEvent

sendEvent<EventName>(eventName, ...__namedParameters): void
Type Parameters
- EventName extends string
Parameters
- eventName: EventName
- Rest ...__namedParameters: DistributeObject<{
          [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<EventToCogs<Manifest>>, {
              name: Name;
          }>["value"]>
      }>[EventName] extends undefined
      ? []
      : [DistributeObject<{
          [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<EventToCogs<Manifest>>, {
              name: Name;
          }>["value"]>
      }>[EventName]]
Returns void
- Defined in src/CogsConnection.ts:186

sendInitialMediaClipStates

sendInitialMediaClipStates(allMediaClipStates): void
Parameters
- allMediaClipStates: default
Returns void
- Defined in src/CogsConnection.ts:215

sendMediaClipState

sendMediaClipState(mediaClipState): void
Parameters
- mediaClipState: MediaClipStateMessage
Returns void
- Defined in src/CogsConnection.ts:221

setPluginWindowVisible

setPluginWindowVisible(visible): void
Show or hide the plugin window.
Parameters
- visible: boolean
  Whether to show or hide the window This is only relevant for plugins, not for Media Master content.
Returns void
- Defined in src/CogsConnection.ts:238

setState

setState(values): void
Parameters
- values: Partial<DistributeObject<{
      [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
          name: Name;
      }>["value"]>
  }>>
Returns void
- Defined in src/CogsConnection.ts:204

Class CogsConnection<Manifest>

Type Parameters

Manifest extends CogsPluginManifest

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Manifest extends CogsPluginManifest

Parameters

manifest: Manifest

__namedParameters: { hostname?: string; port?: number; } = {}

Optional hostname?: string

Optional port?: number

initialClientState: undefined | Partial<DistributeObject<{ [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, { name: Name; }>["value"]>}>> = undefined

Returns CogsConnection<Manifest>

Properties

Private _selectedAudioOutput

Private _showPhase

Private _timerState

Private audioOutputs

Private clientSupportsHttp2Assets

Private currentConfig

Private currentState

Private eventTarget

Readonly manifest

Private serverSupportsHttp2Assets

Private urlParams

Private websocket

Accessors

config

Returns DistributeObject<{ [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["config"]>[number]>, { name: Name; }>["value"]>}>

isConnected

Returns boolean

selectedAudioOutput

Returns string

showPhase

Returns ShowPhase

state

Returns DistributeObject<{ [Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, { name: Name; }>["value"]>}>

supportsHttp2Assets

Returns boolean

timerState

Returns null | TimerState

Methods

addEventListener

Type Parameters

EventType extends "open" | "message" | "close" | "config" | "state" | "event"

Parameters

type: EventType

listener: ((event) => void)

Parameters

event: CogsConnectionEvent<Manifest> & { _cogsConnectionEventType: EventType; }

Returns void

Optional options: boolean | AddEventListenerOptions

Returns void

close

Returns void

Private dispatchEvent

Type Parameters

Parameters

event: Event

Returns void

getAssetUrl

Parameters

path: string

Returns string

getAudioSinkId

Parameters

audioOutput: string

Returns undefined | string

removeEventListener

Type Parameters

EventType extends "open" | "message" | "close" | "config" | "state" | "event"

Parameters

type: EventType

listener: ((event) => void)

__namedParameters: {
hostname?: string;
port?: number;
} = {}

`Optional` hostname?: string

`Optional` port?: number

initialClientState: undefined | Partial<DistributeObject<{
[Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
name: Name;
}>["value"]>
}>> = undefined

`Private` _selectedAudioOutput

`Private` _showPhase

`Private` _timerState

`Private` audioOutputs

`Private` clientSupportsHttp2Assets

`Private` currentConfig

`Private` currentState

`Private` eventTarget

`Readonly` manifest

`Private` serverSupportsHttp2Assets

`Private` urlParams

`Private` websocket

Returns DistributeObject<{
[Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["config"]>[number]>, {
name: Name;
}>["value"]>
}>

Returns DistributeObject<{
[Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
name: Name;
}>["value"]>
}>

event: CogsConnectionEvent<Manifest> & {
_cogsConnectionEventType: EventType;
}

`Optional` options: boolean | AddEventListenerOptions

`Private` dispatchEvent

`Optional` options: boolean | EventListenerOptions

values: Partial<DistributeObject<{
[Name in string]: TypeFromCogsValueType<Extract<DeepMutable<NonNullable<Manifest["state"]>[number]>, {
name: Name;
}>["value"]>
}>>