Documentation
    Preparing search index...

    Module kairos-connection

    KAIROS-connection

    Note: This library is not affiliated with Panasonic in any way.

    This is a library for communicating with the Panasonic KAIROS video switchers.

    More documentation can be found here: github.com/Sofie-Automation/sofie-kairos-connection

    const kairos = new KairosConnection()
    kairos.on('connect', () => console.log('Connected to Kairos'))
    kairos.on('disconnect', () => console.log('Disconnected from Kairos'))
    kairos.on('error', (e) => console.error(e))
    kairos.on('warn', (e) => console.log(e))
    kairos.on('reset', () => {
    // Emitted when the kairos has been reset (like when restarted or new configuration loaded)
    })

    kairos.connect(host, port)

    // Send commands:
    await kairos.updateScene(refScene(['MyFolder', 'MyScene']), values)
    // etc...

    // Terminate:
    kairos.disconnect()
    kairos.discard()
    kairos.removeAllListeners()

    Enumerations

    AuxRecordingStatus
    DissolveMode
    EffectChromaKeyEdgeSmoothingSize
    EffectFilmLookColorMode
    EffectLinearKeyBlendMode
    EffectLuminanceKeyBlendMode
    EffectLUTCorrectionColorspace
    EffectLUTCorrectionIndex
    EffectLUTCorrectionRange
    EffectTransform2DType
    ImageStoreScaleMode
    InputRecordingStatus
    LabelPosition
    MacroStatus
    MediaStatus
    PlayerTMS
    Resolution
    Rotate
    ScaleMode
    SceneCurve
    SceneLayerActiveBus
    SceneLayerBlendMode
    SceneLayerMode
    SceneLayerPgmPstMode
    SceneLayerState
    SceneLimitOffAction
    SceneSnapshotPriorityRecall
    SceneSnapshotStatus
    ShowTallyBorder

    Classes

    KairosConnection
    MinimalKairosConnection
    ResponseError
    TerminateSubscriptionError
    UnknownResponseError

    Interfaces

    AudioAuxObject
    AudioMixerObject
    AudioOutputSettingObject
    AuxObject
    ClipPlayerObject
    ColorBarSourceObject
    ColorCircleSourceObject
    EffectChromaKeyObject
    EffectCropObject
    EffectFilmLookObject
    EffectGlowEffectObject
    EffectLinearKeyObject
    EffectLuminanceKeyObject
    EffectLUTCorrectionObject
    EffectMatrixCorrectionObject
    EffectPCropObject
    EffectPositionObject
    EffectRGBCorrectionObject
    EffectTemperatureCorrectionObject
    EffectToneCurveCorrectionObject
    EffectTransform2DObject
    EffectVirtualPTZObject
    EffectYUVCorrectionObject
    FxInputObject
    GfxChannelObject
    GfxSceneClockItemObject
    GfxSceneCounterItemObject
    GfxSceneHTMLElementItemObject
    GfxSceneItemObject
    GfxSceneObject
    GfxSceneTextItemObject
    ImageStoreObject
    InputObject
    IpInputSettingObject
    IpOutputSettingObject
    MacroObject
    MediaObject
    MultiViewInputObject
    MultiViewObject
    MultiViewPipObject
    MultiViewSourceObject
    NDIInputSettingObject
    NDIOutputSettingObject
    Options
    Pos2D
    Pos2Df
    Pos3Df
    SceneLayerObject
    SceneObject
    SceneSnapshotObject
    SceneTransitionMixEffectObject
    SceneTransitionObject
    SDIInputSettingObject
    SDIOutputSettingObject
    StreamInputSettingObject
    StreamOutputSettingObject

    Type Aliases

    AnyInputRef
    AnyMVSourceRef
    AnyRef
    AnySourceRef
    AudioMixerChannelRef
    AudioOutputSettingRef
    AudioPlayerObject
    AudioPlayerRef
    AuxEffectRef
    AuxRef
    ClipPlayerRef
    ColorRGB
    FxInputRef
    GfxChannelRef
    GfxSceneItemRef
    GfxSceneRef
    ImageStoreRef
    IpInputRef
    IpInputSettingRef
    IpOutputSettingRef
    KairosConnectionEvents
    MacroRef
    MatteRef
    MediaClipRef
    MediaImageRef
    MediaRamRecRef
    MediaSoundRef
    MediaStillRef
    MultiViewInputRef
    MultiViewPipRef
    MultiViewRef
    NDIInputRef
    NDIInputSettingRef
    NDIOutputSettingRef
    RamRecorderRef
    RamRecPlayerObject
    RefPath
    RefPathSingle
    SceneLayerEffectRef
    SceneLayerRef
    SceneRef
    SceneSnapshotRef
    SceneTransition
    SceneTransitionMix
    SceneTransitionMixEffect
    SceneTransitionMixEffectRef
    SceneTransitionMixRef
    SceneTransitionRef
    SDIInputRef
    SDIInputSettingRef
    SDIOutputSettingRef
    SourceBaseRef
    SourceIntMVRef
    SourceIntRef
    StreamInputRef
    StreamInputSettingRef
    StreamOutputSettingRef
    SubscriptionCallback
    UpdateAudioAuxObject
    UpdateAudioMixerObject
    UpdateAudioOutputSettingObject
    UpdateAudioPlayerObject
    UpdateAuxObject
    UpdateClipPlayerObject
    UpdateEffectChromaKeyObject
    UpdateEffectCropObject
    UpdateEffectFilmLookObject
    UpdateEffectGlowEffectObject
    UpdateEffectLinearKeyObject
    UpdateEffectLuminanceKeyObject
    UpdateEffectLUTCorrectionObject
    UpdateEffectMatrixCorrectionObject
    UpdateEffectPCropObject
    UpdateEffectPositionObject
    UpdateEffectRGBCorrectionObject
    UpdateEffectTemperatureCorrectionObject
    UpdateEffectToneCurveCorrectionObject
    UpdateEffectTransform2DObject
    UpdateEffectVirtualPTZObject
    UpdateEffectYUVCorrectionObject
    UpdateFxInputObject
    UpdateGfxChannelObject
    UpdateGfxSceneClockItemObject
    UpdateGfxSceneCounterItemObject
    UpdateGfxSceneHTMLElementItemObject
    UpdateGfxSceneItemObject
    UpdateGfxSceneObject
    UpdateGfxSceneTextItemObject
    UpdateImageStoreObject
    UpdateInputObject
    UpdateIpInputSettingObject
    UpdateIpOutputSettingObject
    UpdateMacroObject
    UpdateMediaObject
    UpdateMultiViewInputObject
    UpdateMultiViewObject
    UpdateMultiViewPipObject
    UpdateNDIInputSettingObject
    UpdateNDIOutputSettingObject
    UpdateRamRecPlayerObject
    UpdateSceneLayerObject
    UpdateSceneObject
    UpdateSceneSnapshotObject
    UpdateSceneTransitionMixEffectObject
    UpdateSceneTransitionObject
    UpdateSDIInputSettingObject
    UpdateSDIOutputSettingObject
    UpdateStreamInputSettingObject
    UpdateStreamOutputSettingObject

    Functions

    assertNever
    exampleRef
    isAnyInputRef
    isAnyMVSourceRef
    isAnySourceRef
    isRef
    pathToRef
    protocolDecodePath
    protocolDecodeStr
    protocolEncodePath
    protocolEncodeStr
    refAudioMixerChannel
    refAudioOutputSetting
    refAudioPlayer
    refAuxEffect
    refAuxId
    refAuxName
    refClipPlayer
    refFxInput
    refGfxChannel
    refGfxScene
    refGfxSceneItem
    refImageStore
    refIpInput
    refIpInputSetting
    refIpOutputSetting
    refMacro
    refMatte
    refMediaClip
    refMediaImage
    refMediaRamRec
    refMediaSound
    refMediaStill
    refMultiView
    refMultiViewInput
    refMultiViewPip
    refNDIInput
    refNDIInputSetting
    refNDIOutputSetting
    refRamRecorder
    refScene
    refSceneLayer
    refSceneLayerEffect
    refSceneSnapshot
    refSceneTransition
    refSceneTransitionMix
    refSceneTransitionMixEffect
    refSDIInput
    refSDIInputSetting
    refSDIOutputSetting
    refSourceBase
    refSourceInt
    refSourceIntMV
    refStreamInput
    refStreamInputSetting
    refStreamOutputSetting
    refToPath
    splitPath