Class CogsConnection<Manifest, DataT>

constructor

• new CogsConnection<Manifest, DataT>(manifest, __namedParameters?, initialClientState?, initialDataStoreData?): CogsConnection<Manifest, DataT>

• Type Parameters

  • Manifest extends CogsPluginManifest

  • DataT extends {
        [key: string]: unknown;
    } = Record<never, never>

  Parameters

  • manifest: Manifest

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

    • Optional hostname?: string

    • Optional port?: number

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

  • Optional initialDataStoreData: DataT

  Returns CogsConnection<Manifest, DataT>

Readonly manifest

store

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"]>
  }>

isConnected

• get isConnected(): boolean

• Returns boolean

selectedAudioOutput

• get selectedAudioOutput(): string

• Returns string

showPhase

• get showPhase(): ShowPhase

• Returns ShowPhase

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"]>
  }>

timerState

• get timerState(): null | TimerState

• Returns null | TimerState

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

close

• close(): void

• Returns void

getAssetUrl

• getAssetUrl(path): string

• Return asset URLs using the information about the client and server support for HTTP/2

  Parameters

  • path: string

  Returns string

getAudioSinkId

• getAudioSinkId(audioOutput): undefined | string

• Parameters

  • audioOutput: string

  Returns undefined | string

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

sendAudioOutputs

• sendAudioOutputs(audioOutputs): void

• Parameters

  • audioOutputs: MediaDeviceInfo[]

  Returns void

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

sendInitialMediaClipStates

• sendInitialMediaClipStates(allMediaClipStates): void

• Parameters

  • allMediaClipStates: default

  Returns void

sendMediaClipState

• sendMediaClipState(mediaClipState): void

• Parameters

  • mediaClipState: MediaClipStateMessage

  Returns void

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

setState

• setState(values): void

• Parameters

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

  Returns void