atem-connection/dist/state/video/upstreamKeyers.d.ts

Typescript Node.js library for connecting with an ATEM switcher.

import * as Enum from '../../enums';
export interface UpstreamKeyerBase extends UpstreamKeyerTypeSettings {
    readonly upstreamKeyerId: number;
    readonly canFlyKey: boolean;
    fillSource: number;
    cutSource: number;
}
export interface UpstreamKeyerTypeSettings {
    mixEffectKeyType: Enum.MixEffectKeyType;
    flyEnabled: boolean;
}
export interface UpstreamKeyerMaskSettings {
    maskEnabled: boolean;
    maskTop: number;
    maskBottom: number;
    maskLeft: number;
    maskRight: number;
}
export interface UpstreamKeyerDVEBase extends UpstreamKeyerMaskSettings {
    sizeX: number;
    sizeY: number;
    positionX: number;
    positionY: number;
    rotation: number;
    borderOuterWidth: number;
    borderInnerWidth: number;
    borderOuterSoftness: number;
    borderInnerSoftness: number;
    borderBevelSoftness: number;
    borderBevelPosition: number;
    borderOpacity: number;
    borderHue: number;
    borderSaturation: number;
    borderLuma: number;
    lightSourceDirection: number;
    lightSourceAltitude: number;
}
export interface UpstreamKeyerDVESettings extends UpstreamKeyerDVEBase {
    borderEnabled: boolean;
    shadowEnabled: boolean;
    borderBevel: Enum.BorderBevel;
    rate: number;
}
export interface UpstreamKeyerFlyKeyframe extends Omit<UpstreamKeyerDVEBase, 'maskEnabled'> {
    readonly keyFrameId: number;
}
export interface UpstreamKeyerChromaSettings {
    hue: number;
    gain: number;
    ySuppress: number;
    lift: number;
    narrow: boolean;
}
export interface UpstreamKeyerAdvancedChromaSettings {
    properties?: UpstreamKeyerAdvancedChromaProperties;
    sample?: UpstreamKeyerAdvancedChromaSample;
}
export interface UpstreamKeyerAdvancedChromaProperties {
    foregroundLevel: number;
    backgroundLevel: number;
    keyEdge: number;
    spillSuppression: number;
    flareSuppression: number;
    brightness: number;
    contrast: number;
    saturation: number;
    red: number;
    green: number;
    blue: number;
}
export interface UpstreamKeyerAdvancedChromaSample {
    enableCursor: boolean;
    preview: boolean;
    cursorX: number;
    cursorY: number;
    cursorSize: number;
    sampledY: number;
    sampledCb: number;
    sampledCr: number;
}
export interface UpstreamKeyerLumaSettings {
    preMultiplied: boolean;
    clip: number;
    gain: number;
    invert: boolean;
}
export interface UpstreamKeyerPatternSettings {
    style: Enum.Pattern;
    size: number;
    symmetry: number;
    softness: number;
    positionX: number;
    positionY: number;
    invert: boolean;
}
export interface UpstreamKeyerFlySettings {
    readonly isASet: boolean;
    readonly isBSet: boolean;
    readonly isAtKeyFrame: Enum.IsAtKeyFrame;
    readonly runToInfiniteIndex: number;
}
export interface UpstreamKeyer extends UpstreamKeyerBase {
    dveSettings?: UpstreamKeyerDVESettings;
    chromaSettings?: UpstreamKeyerChromaSettings;
    advancedChromaSettings?: UpstreamKeyerAdvancedChromaSettings;
    lumaSettings?: UpstreamKeyerLumaSettings;
    patternSettings?: UpstreamKeyerPatternSettings;
    flyKeyframes: [UpstreamKeyerFlyKeyframe | undefined, UpstreamKeyerFlyKeyframe | undefined];
    flyProperties?: UpstreamKeyerFlySettings;
    maskSettings: UpstreamKeyerMaskSettings;
    onAir: boolean;
}
//# sourceMappingURL=upstreamKeyers.d.ts.map