@nasaspaceflight/atem-connection 3.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Norsk rikskringkasting AS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,146 @@
+# Sofie ATEM Connection Library
+
+[![Node CI](https://github.com/Sofie-Automation/sofie-atem-connection/actions/workflows/node.yaml/badge.svg)](https://github.com/Sofie-Automation/sofie-atem-connection/actions/workflows/node.yaml)
+[![codecov](https://codecov.io/gh/Sofie-Automation/sofie-atem-connection/branch/main/graph/badge.svg)](https://codecov.io/gh/Sofie-Automation/sofie-atem-connection/)
+[![npm](https://img.shields.io/npm/v/atem-connection)](https://www.npmjs.com/package/atem-connection)
+
+This is the _ATEM Connection_ library of the [**Sofie** TV Automation System](https://github.com/Sofie-Automation/Sofie-TV-automation/). The library is used for connecting to Blackmagic Design's ATEM devices.
+
+- [_ATEM-Connection_-specific Developer Info](DEVELOPER.md)
+
+## General Sofie System Information
+
+- [_Sofie_ Documentation](https://sofie-automation.github.io/sofie-core//)
+- [_Sofie_ Releases](https://sofie-automation.github.io/sofie-core//releases)
+- [Contribution Guidelines](CONTRIBUTING.md)
+- [License](LICENSE)
+
+---
+
+## Device support
+
+| Version       | Level of Support                                                  |
+| ------------- | ----------------------------------------------------------------- |
+| v8.0 - Latest | Primary focus. Target for new features                            |
+| v7.2          | Previous focus, should still work well                            |
+| v7.3 - v7.5.2 | Community tested, we may accept PRs but will not be testing these |
+
+Due to the nature of the ATEM firmware and its tendency to break things, it is likely that new firmwares will require updates to the library to be fully supported.
+Additionally any newly unimplemented functionality will generally only be written and tested for the latest firmware, even if it was added in an older firmware.
+
+We have no intention of dropping support for older firmwares, but we may do at some point. If we do this will be done in a major version bump, and will only be for significantly older firmware.
+
+The library is tested on a variety of models spanning every generation, and the aim is to provide support for every model.
+
+Note: USB control of devices is not supported by this library.
+
+## Technology Highlights
+
+- Typescript
+- Jest
+- standard-version
+- codecov
+
+## Installation
+
+For usage by library consumers installation is as easy as:
+
+```sh
+yarn add atem-connection
+```
+
+For library developers installation steps are as following:
+
+```sh
+git clone https://github.com/Sofie-Automation/sofie-atem-connection
+yarn
+yarn build
+```
+
+We welcome any contributions. Please read [our guide](CONTRIBUTING.md) on how to add new commands before raising a PR.
+
+## Usage
+
+```javascript
+const { Atem } = require('atem-connection')
+const myAtem = new Atem()
+myAtem.on('info', console.log)
+myAtem.on('error', console.error)
+
+myAtem.connect('192.168.168.240')
+
+myAtem.on('connected', () => {
+	myAtem.changeProgramInput(3).then(() => {
+		// Fired once the atem has acknowledged the command
+		// Note: the state likely hasnt updated yet, but will follow shortly
+		console.log('Program input set')
+	})
+	console.log(myAtem.state)
+})
+
+myAtem.on('stateChanged', (state, pathToChange) => {
+	console.log(state) // catch the ATEM state.
+})
+```
+
+### Documentation
+
+You can find the generated type docs [here](https://sofie-automation.github.io/sofie-atem-connection/).
+
+### Events
+
+- `error`
+  This event will be fired when an error occurs in the connection. Node requires you to handle these errors, or your application will quit.
+
+- `info`
+  This event will be fired when the connection provides some logging information.
+
+- `debug`
+  This event is not useful for most users. It will emit some messages useful to figure out why some data useful mostly to library developers.
+
+- `connected`
+  This event will be fired once we have connected with the ATEM.
+
+- `disconnected`
+  Whenever the connection to the ATEM fails and does not recover within 5 seconds this is called.
+
+- `stateChanged(state, path)`
+  Whenever a packet from the ATEM is received that changes the state, this event will be fired.
+  The path parameter is a path into the state that represents the change, to allow for filtering of events. eg video.mixEffects.0.programInput
+
+- `receivedCommand(command)`
+  Whenever a packet from the ATEM is received that contains a command, this event will be fired.
+  This should not be relied on in most usage, as the commands can and will have breaking changes in patch releases. This event is needed for some use cases, so if this is used you should likely pin the version down to a specific patch release to ensure nothing breaks.
+
+## Debug
+
+Set `debugBuffers=true` config option in order to see raw packets. This is especially useful for library developers.
+
+```javascript
+const myAtem = new Atem({ debugBuffers: true })
+myAtem.on('info', console.log)
+myAtem.on('debug', console.log)
+myAtem.on('error', console.error)
+```
+
+```sh
+SEND <Buffer 10 14 53 ab 00 00 00 00 00 3a 00 00 01 00 00 00 00 00 00 00>
+SEND <Buffer 80 0c 53 ab 00 00 00 00 00 03 00 00>
+SEND <Buffer 80 0c 53 ab 00 00 00 00 00 03 00 00>
+SEND <Buffer 80 0c 80 0f 00 01 00 00 00 41 00 00>
+RECV <Buffer 00 0c 90 60 5f 76 65 72 00 02 00 10>...
+```
+
+## Test
+
+This module run tests with jest.
+
+```sh
+$ yarn unit
+```
+
+There is a suite of generated serialization tests, using [atem-connection-test-generator](https://github.com/LibAtem/atem-connection-test-generator) as the [LibAtem](https://github.com/LibAtem) project has tests to verify its serialization against the Blackmagic Design's ATEM SDK.
+
+---
+
+_The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS._

package/assets/roboto/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/atem.d.ts

@@ -0,0 +1,280 @@
+/// <reference types="node" />
+import { EventEmitter } from 'eventemitter3';
+import { AtemState, ColorGeneratorState } from './state';
+import { ISerializableCommand, IDeserializedCommand } from './commands/CommandBase';
+import * as Commands from './commands';
+import { MediaPlayer, MediaPlayerSource } from './state/media';
+import { DipTransitionSettings, DVETransitionSettings, MixTransitionSettings, StingerTransitionSettings, SuperSource, TransitionProperties, WipeTransitionSettings } from './state/video';
+import * as USK from './state/video/upstreamKeyers';
+import { InputChannel } from './state/input';
+import { DownstreamKeyerGeneral, DownstreamKeyerMask } from './state/video/downstreamKeyers';
+import * as DT from './dataTransfer';
+import { VideoModeInfo } from './lib/videoMode';
+import * as Enums from './enums';
+import { ClassicAudioMonitorChannel, ClassicAudioMasterChannel, ClassicAudioChannel, ClassicAudioHeadphoneOutputChannel } from './state/audio';
+import { RecordingStateProperties } from './state/recording';
+import { OmitReadonly } from './lib/types';
+import { StreamingServiceProperties } from './state/streaming';
+import { FairlightAudioMonitorChannel, FairlightAudioCompressorState, FairlightAudioLimiterState, FairlightAudioEqualizerBandState, FairlightAudioExpanderState, FairlightAudioRoutingSource, FairlightAudioRoutingOutput, FairlightAudioMonitorSolo } from './state/fairlight';
+import { FairlightDynamicsResetProps } from './commands/Fairlight/common';
+import { MultiViewerPropertiesState, MultiViewerBorderColorState, MultiViewerWindowOverlayPropertiesState } from './state/settings';
+import { FontFace } from '@julusian/freetype2';
+import { TimeInfo } from './state/info';
+import { SomeAtemAudioLevels } from './state/levels';
+import { UploadBufferInfo } from './dataTransfer/dataTransferUploadBuffer';
+export interface AtemOptions {
+    address?: string;
+    port?: number;
+    debugBuffers?: boolean;
+    /**
+     * Maximum size of packets to transmit
+     */
+    maxPacketSize?: number;
+}
+export type AtemEvents = {
+    error: [string];
+    info: [string];
+    debug: [string];
+    connected: [];
+    disconnected: [];
+    stateChanged: [AtemState, string[]];
+    levelChanged: [SomeAtemAudioLevels];
+    receivedCommands: [IDeserializedCommand[]];
+    updatedTime: [TimeInfo];
+};
+export declare enum AtemConnectionStatus {
+    CLOSED = 0,
+    CONNECTING = 1,
+    CONNECTED = 2
+}
+export declare const DEFAULT_PORT = 9910;
+export declare const DEFAULT_MAX_PACKET_SIZE = 1416;
+export declare class BasicAtem extends EventEmitter<AtemEvents> {
+    private readonly socket;
+    protected readonly dataTransferManager: DT.DataTransferManager;
+    private _state;
+    private _sentQueue;
+    private _status;
+    constructor(options?: AtemOptions);
+    private _onInitComplete;
+    get status(): AtemConnectionStatus;
+    get state(): Readonly<AtemState> | undefined;
+    /**
+     * Get the current videomode of the ATEM, if known
+     */
+    get videoMode(): Readonly<VideoModeInfo> | undefined;
+    connect(address: string, port?: number): Promise<void>;
+    disconnect(): Promise<void>;
+    destroy(): Promise<void>;
+    sendCommands(commands: ISerializableCommand[]): Promise<void>;
+    sendUnprioritizedCommands(commands: ISerializableCommand[]): Promise<void>;
+    sendCommand(command: ISerializableCommand): Promise<void>;
+    private _mutateState;
+    private _resolveCommands;
+    private _rejectAllCommands;
+}
+export declare class Atem extends BasicAtem {
+    #private;
+    constructor(options?: AtemOptions);
+    /**
+     * Set the font to use for the multiviewer, or reset to default
+     */
+    setMultiviewerFontFace(font: FontFace | string | null): Promise<void>;
+    /**
+     * Set the scale factor for the multiviewer text. Default is 1
+     */
+    setMultiviewerFontScale(scale: number | null): void;
+    changeProgramInput(input: number, me?: number): Promise<void>;
+    changePreviewInput(input: number, me?: number): Promise<void>;
+    cut(me?: number): Promise<void>;
+    autoTransition(me?: number): Promise<void>;
+    fadeToBlack(me?: number): Promise<void>;
+    setFadeToBlackRate(rate: number, me?: number): Promise<void>;
+    autoDownstreamKey(key?: number, isTowardsOnAir?: boolean): Promise<void>;
+    setDipTransitionSettings(newProps: Partial<DipTransitionSettings>, me?: number): Promise<void>;
+    setDVETransitionSettings(newProps: Partial<DVETransitionSettings>, me?: number): Promise<void>;
+    setMixTransitionSettings(newProps: Pick<MixTransitionSettings, 'rate'>, me?: number): Promise<void>;
+    setTransitionPosition(position: number, me?: number): Promise<void>;
+    previewTransition(on: boolean, me?: number): Promise<void>;
+    setTransitionStyle(newProps: Partial<OmitReadonly<TransitionProperties>>, me?: number): Promise<void>;
+    setStingerTransitionSettings(newProps: Partial<StingerTransitionSettings>, me?: number): Promise<void>;
+    setWipeTransitionSettings(newProps: Partial<WipeTransitionSettings>, me?: number): Promise<void>;
+    setAuxSource(source: number, bus?: number): Promise<void>;
+    setDownstreamKeyTie(tie: boolean, key?: number): Promise<void>;
+    setDownstreamKeyOnAir(onAir: boolean, key?: number): Promise<void>;
+    setDownstreamKeyCutSource(input: number, key?: number): Promise<void>;
+    setDownstreamKeyFillSource(input: number, key?: number): Promise<void>;
+    setDownstreamKeyGeneralProperties(props: Partial<DownstreamKeyerGeneral>, key?: number): Promise<void>;
+    setDownstreamKeyMaskSettings(props: Partial<DownstreamKeyerMask>, key?: number): Promise<void>;
+    setDownstreamKeyRate(rate: number, key?: number): Promise<void>;
+    setTime(hour: number, minute: number, second: number, frame: number): Promise<void>;
+    setTimeMode(mode: Enums.TimeMode): Promise<void>;
+    requestTime(): Promise<void>;
+    macroContinue(): Promise<void>;
+    macroDelete(index?: number): Promise<void>;
+    macroInsertUserWait(): Promise<void>;
+    macroInsertTimedWait(frames: number): Promise<void>;
+    macroRun(index?: number): Promise<void>;
+    macroStop(): Promise<void>;
+    macroStartRecord(index: number, name: string, description: string): Promise<void>;
+    macroStopRecord(): Promise<void>;
+    macroUpdateProperties(props: Commands.MacroPropertiesCommand['properties'], index?: number): Promise<void>;
+    macroSetLoop(loop: boolean): Promise<void>;
+    downloadMacro(index: number): Promise<Buffer>;
+    uploadMacro(index: number, name: string, data: Buffer): Promise<void>;
+    setMultiViewerWindowSource(source: number, mv?: number, window?: number): Promise<void>;
+    setMultiViewerWindowSafeAreaEnabled(safeAreaEnabled: boolean, mv?: number, window?: number): Promise<void>;
+    setMultiViewerWindowVuEnabled(vuEnabled: boolean, mv?: number, window?: number): Promise<void>;
+    setMultiViewerVuOpacity(opacity: number, mv?: number): Promise<void>;
+    setMultiViewerProperties(props: Partial<MultiViewerPropertiesState>, mv?: number): Promise<void>;
+    setMultiViewerBorderColor(color: MultiViewerBorderColorState, mv?: number): Promise<void>;
+    setMultiViewerWindowOverlayProperties(props: Partial<MultiViewerWindowOverlayPropertiesState>, mv?: number, window?: number): Promise<void>;
+    setMultiViewerWindowSafeAreaPattern(safeTitlePattern: Enums.SafeTitlePattern[], mv?: number, window?: number): Promise<void>;
+    setColorGeneratorColour(newProps: Partial<ColorGeneratorState>, index?: number): Promise<void>;
+    setMediaPlayerSettings(newProps: Partial<MediaPlayer>, player?: number): Promise<void>;
+    setMediaPlayerSource(newProps: Partial<MediaPlayerSource>, player?: number): Promise<void>;
+    setMediaClip(index: number, name: string, frames?: number): Promise<void>;
+    clearMediaPoolClip(clipId: number): Promise<void>;
+    clearMediaPoolStill(stillId: number): Promise<void>;
+    captureMediaPoolStill(): Promise<void>;
+    setSuperSourceBoxSettings(newProps: Partial<SuperSource.SuperSourceBox>, box?: number, ssrcId?: number): Promise<void>;
+    setSuperSourceProperties(newProps: Partial<SuperSource.SuperSourceProperties>, ssrcId?: number): Promise<void>;
+    setSuperSourceBorder(newProps: Partial<SuperSource.SuperSourceBorder>, ssrcId?: number): Promise<void>;
+    setInputSettings(newProps: Partial<OmitReadonly<InputChannel>>, input?: number): Promise<void>;
+    setUpstreamKeyerChromaSettings(newProps: Partial<USK.UpstreamKeyerChromaSettings>, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerAdvancedChromaProperties(newProps: Partial<USK.UpstreamKeyerAdvancedChromaProperties>, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerAdvancedChromaSample(newProps: Partial<USK.UpstreamKeyerAdvancedChromaSample>, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerAdvancedChromaSampleReset(flags: Commands.AdvancedChromaSampleResetProps, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerCutSource(cutSource: number, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerFillSource(fillSource: number, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerDVESettings(newProps: Partial<USK.UpstreamKeyerDVESettings>, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerLumaSettings(newProps: Partial<USK.UpstreamKeyerLumaSettings>, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerMaskSettings(newProps: Partial<USK.UpstreamKeyerMaskSettings>, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerPatternSettings(newProps: Partial<USK.UpstreamKeyerPatternSettings>, me?: number, keyer?: number): Promise<void>;
+    setUpstreamKeyerOnAir(onAir: boolean, me?: number, keyer?: number): Promise<void>;
+    runUpstreamKeyerFlyKeyTo(mixEffect: number, upstreamKeyerId: number, keyFrameId: Enums.FlyKeyKeyFrame.A | Enums.FlyKeyKeyFrame.B | Enums.FlyKeyKeyFrame.Full): Promise<void>;
+    runUpstreamKeyerFlyKeyToInfinite(mixEffect: number, upstreamKeyerId: number, direction: Enums.FlyKeyDirection): Promise<void>;
+    storeUpstreamKeyerFlyKeyKeyframe(mixEffect: number, upstreamKeyerId: number, keyframe: number): Promise<void>;
+    setUpstreamKeyerFlyKeyKeyframe(mixEffect: number, upstreamKeyerId: number, keyframe: number, properties: Partial<Omit<USK.UpstreamKeyerFlyKeyframe, 'keyFrameId'>>): Promise<void>;
+    setUpstreamKeyerType(newProps: Partial<USK.UpstreamKeyerTypeSettings>, me?: number, keyer?: number): Promise<void>;
+    /**
+     * Download a frame of a clip from the ATEM media pool
+     *
+     * Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important,
+     * consider using [@atem-connection/image-tools](https://www.npmjs.com/package/@atem-connection/image-tools) to
+     * pre-convert the images with more optimal algorithms
+     * @param clipIndex Clip index to download
+     * @param frameIndex Frame index to download from the clip
+     * @param format The pixel format to return for the downloaded image. 'raw' passes through unchanged, and will be RLE encoded.
+     * @returns Promise which returns the image once downloaded. If the still slot is not in use, this will throw
+     */
+    downloadClipFrame(clipIndex: number, frameIndex: number, format?: 'raw' | 'rgba' | 'yuv'): Promise<Buffer>;
+    /**
+     * Download a still image from the ATEM media pool
+     *
+     * Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important,
+     * consider using [@atem-connection/image-tools](https://www.npmjs.com/package/@atem-connection/image-tools) to
+     * pre-convert the images with more optimal algorithms
+     * @param index Still index to download
+     * @param format The pixel format to return for the downloaded image. 'raw' passes through unchanged, and will be RLE encoded.
+     * @returns Promise which returns the image once downloaded. If the still slot is not in use, this will throw
+     */
+    downloadStill(index: number, format?: 'raw' | 'rgba' | 'yuv'): Promise<Buffer>;
+    /**
+     * Upload a still image to the ATEM media pool
+     *
+     * Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important,
+     * consider using [@atem-connection/image-tools](https://www.npmjs.com/package/@atem-connection/image-tools) to
+     * pre-convert the images with more optimal algorithms
+     * @param index Still index to upload to
+     * @param data a RGBA pixel buffer, or an already YUVA encoded image
+     * @param name Name to give the uploaded image
+     * @param description Description for the uploaded image
+     * @param options Upload options
+     * @returns Promise which resolves once the image is uploaded
+     */
+    uploadStill(index: number, data: Buffer | UploadBufferInfo, name: string, description: string, options?: DT.UploadStillEncodingOptions): Promise<void>;
+    /**
+     * Upload a clip to the ATEM media pool
+     *
+     * Note: This performs colour conversions in JS, which is not very CPU efficient. If performance is important,
+     * consider using [@atem-connection/image-tools](https://www.npmjs.com/package/@atem-connection/image-tools) to
+     * pre-convert the images with more optimal algorithms
+     * @param index Clip index to upload to
+     * @param frames Array or generator of frames. Each frame can be a RGBA pixel buffer, or an already YUVA encoded image
+     * @param name Name to give the uploaded clip
+     * @param options Upload options
+     * @returns Promise which resolves once the clip is uploaded
+     */
+    uploadClip(index: number, frames: Iterable<Buffer> | AsyncIterable<Buffer> | Iterable<UploadBufferInfo> | AsyncIterable<UploadBufferInfo>, name: string, options?: DT.UploadStillEncodingOptions): Promise<void>;
+    /**
+     * Upload clip audio to the ATEM media pool
+     * @param index Clip index to upload to
+     * @param data stereo 48khz 24bit WAV audio data
+     * @param name Name to give the uploaded audio
+     * @returns Promise which resolves once the clip audio is uploaded
+     */
+    uploadAudio(index: number, data: Buffer, name: string): Promise<void>;
+    setClassicAudioMixerInputProps(index: number, props: Partial<OmitReadonly<ClassicAudioChannel>>): Promise<void>;
+    setClassicAudioMixerMasterProps(props: Partial<ClassicAudioMasterChannel>): Promise<void>;
+    setClassicAudioMixerMonitorProps(props: Partial<ClassicAudioMonitorChannel>): Promise<void>;
+    setClassicAudioMixerHeadphonesProps(props: Partial<ClassicAudioHeadphoneOutputChannel>): Promise<void>;
+    setClassicAudioResetPeaks(props: Partial<Commands.ClassicAudioResetPeaks>): Promise<void>;
+    setClassicAudioMixerProps(props: Commands.AudioMixerPropertiesCommand['properties']): Promise<void>;
+    setFairlightAudioMixerMasterProps(props: Partial<Commands.FairlightMixerMasterCommandProperties>): Promise<void>;
+    setFairlightAudioMixerMasterCompressorProps(props: Partial<OmitReadonly<FairlightAudioCompressorState>>): Promise<void>;
+    setFairlightAudioMixerMasterLimiterProps(props: Partial<OmitReadonly<FairlightAudioLimiterState>>): Promise<void>;
+    setFairlightAudioMixerMasterEqualizerBandProps(band: number, props: Partial<OmitReadonly<FairlightAudioEqualizerBandState>>): Promise<void>;
+    setFairlightAudioMixerMasterEqualizerReset(props: Partial<Commands.FairlightMixerMasterEqualizerResetCommand['properties']>): Promise<void>;
+    setFairlightAudioMixerMasterDynamicsReset(props: Partial<FairlightDynamicsResetProps>): Promise<void>;
+    setFairlightAudioMixerResetPeaks(props: Commands.FairlightMixerResetPeakLevelsCommand['properties']): Promise<void>;
+    startFairlightMixerSendLevels(): Promise<void>;
+    stopFairlightMixerSendLevels(): Promise<void>;
+    setFairlightAudioMixerMonitorProps(props: Partial<OmitReadonly<FairlightAudioMonitorChannel>>): Promise<void>;
+    setFairlightAudioMixerMonitorSolo(props: Partial<OmitReadonly<FairlightAudioMonitorSolo>>): Promise<void>;
+    setFairlightAudioMixerInputProps(index: number, props: Commands.FairlightMixerInputCommand['properties']): Promise<void>;
+    setFairlightAudioMixerSourceProps(index: number, source: string, props: Commands.FairlightMixerSourceCommand['properties']): Promise<void>;
+    setFairlightAudioMixerSourceCompressorProps(index: number, source: string, props: Partial<OmitReadonly<FairlightAudioCompressorState>>): Promise<void>;
+    setFairlightAudioMixerSourceLimiterProps(index: number, source: string, props: Partial<OmitReadonly<FairlightAudioLimiterState>>): Promise<void>;
+    setFairlightAudioMixerSourceExpanderProps(index: number, source: string, props: Partial<OmitReadonly<FairlightAudioExpanderState>>): Promise<void>;
+    setFairlightAudioMixerSourceEqualizerBandProps(index: number, source: string, band: number, props: Partial<OmitReadonly<FairlightAudioEqualizerBandState>>): Promise<void>;
+    setFairlightAudioMixerSourceDynamicsReset(index: number, source: string, props: Partial<FairlightDynamicsResetProps>): Promise<void>;
+    setFairlightAudioMixerSourceEqualizerReset(index: number, source: string, props: Partial<Commands.FairlightMixerSourceEqualizerResetCommand['properties']>): Promise<void>;
+    setFairlightAudioMixerSourceResetPeaks(index: number, source: string, props: Commands.FairlightMixerSourceResetPeakLevelsCommand['properties']): Promise<void>;
+    startStreaming(): Promise<void>;
+    stopStreaming(): Promise<void>;
+    requestStreamingDuration(): Promise<void>;
+    setStreamingService(props: Partial<StreamingServiceProperties>): Promise<void>;
+    setStreamingAudioBitrates(lowBitrate: number, highBitrate: number): Promise<void>;
+    startRecording(): Promise<void>;
+    stopRecording(): Promise<void>;
+    requestRecordingDuration(): Promise<void>;
+    switchRecordingDisk(): Promise<void>;
+    setRecordingSettings(props: Partial<RecordingStateProperties>): Promise<void>;
+    setEnableISORecording(enabled: boolean): Promise<void>;
+    saveStartupState(): Promise<void>;
+    clearStartupState(): Promise<void>;
+    listVisibleInputs(mode: 'program' | 'preview', me?: number): number[];
+    setMediaPoolSettings(props: Commands.MediaPoolProps): Promise<void>;
+    requestDisplayClockTime(): Promise<void>;
+    setDisplayClockState(state: Enums.DisplayClockClockState): Promise<void>;
+    setDisplayClockProperties(props: Partial<Commands.DisplayClockPropertiesExt>): Promise<void>;
+    setFairlightAudioRoutingSourceProperties(sourceId: number, props: Partial<OmitReadonly<FairlightAudioRoutingSource>>): Promise<void>;
+    setFairlightAudioRoutingOutputProperties(sourceId: number, props: Partial<OmitReadonly<FairlightAudioRoutingOutput>>): Promise<void>;
+    hasInternalMultiviewerLabelGeneration(): boolean;
+    /**
+     * Write a custom multiviewer label buffer
+     * @param inputId The input id
+     * @param buffer Label buffer
+     * @returns Promise that resolves once upload is complete
+     */
+    writeMultiviewerLabel(inputId: number, buffer: Buffer): Promise<void>;
+    /**
+     * Generate and upload a multiviewer label
+     * @param inputId The input id
+     * @param text Label text
+     * @returns Promise that resolves once upload is complete
+     */
+    drawMultiviewerLabel(inputId: number, text: string): Promise<void>;
+}
+//# sourceMappingURL=atem.d.ts.map