@vidispine/types 22.4.0-pre.4 → 22.4.0-pre.5

package/src/models/NLEJobOutputType.ts

@@ -0,0 +1,12 @@
+import type { NLEJobAudioOutputType } from './NLEJobAudioOutputType';
+import type { NLEJobVideoOutputType } from './NLEJobVideoOutputType';
+import type { UMIDType } from './UMIDType';
+
+export type NLEJobOutputType = {
+  video?: Array<NLEJobVideoOutputType>;
+  audio?: Array<NLEJobAudioOutputType>;
+  uri?: string;
+  containerFormat: string;
+  umid?: UMIDType;
+  clipName?: string;
+};

package/src/models/NLEJobSequenceType.ts

@@ -0,0 +1,8 @@
+import type { TrackType } from './TrackType';
+
+export type NLEJobSequenceType = {
+  track?: Array<TrackType>;
+  color?: string;
+  id: number;
+  length: number;
+};

package/src/models/NLEJobTransitionType.ts

@@ -0,0 +1,15 @@
+import type { BorderType } from './BorderType';
+
+export type NLEJobTransitionType = {
+  border?: BorderType;
+  length: number;
+  wipe?: number;
+  transition?: string;
+  horizRepeat?: number;
+  vertRepeat?: number;
+  startPercentage?: number;
+  endPercentage?: number;
+  reverse?: boolean;
+  color?: string;
+  delta?: number;
+};

package/src/models/NLEJobType.ts

@@ -0,0 +1,26 @@
+import type { AspectRatioType } from './AspectRatioType';
+import type { AudioClipType } from './AudioClipType';
+import type { FrameRateType } from './FrameRateType';
+import type { NLEJob2OutputType } from './NLEJob2OutputType';
+import type { NLEJobOutputType } from './NLEJobOutputType';
+import type { NLEJobSequenceType } from './NLEJobSequenceType';
+import type { SubtitleClipType } from './SubtitleClipType';
+import type { TimeIntervalType } from './TimeIntervalType';
+import type { TranscoderJobType } from './TranscoderJobType';
+import type { VideoClipType } from './VideoClipType';
+
+export type NLEJobType = TranscoderJobType & {
+  frameRate: FrameRateType;
+  interval?: TimeIntervalType;
+  width: number;
+  height: number;
+  dar: AspectRatioType;
+  sampleRate: number;
+  pauseFrame?: number;
+  videoClip?: Array<VideoClipType>;
+  audioClip?: Array<AudioClipType>;
+  subtitleClip?: Array<SubtitleClipType>;
+  sequence?: Array<NLEJobSequenceType>;
+  output?: Array<NLEJobOutputType>;
+  output2?: Array<NLEJob2OutputType>;
+};

package/src/models/NLEJobVideoOutputType.ts

@@ -0,0 +1,10 @@
+export type NLEJobVideoOutputType = {
+  preset?: Array<string>;
+  uri?: string;
+  sequence: number;
+  codec: string;
+  bitrate: number;
+  pixelFormat?: string;
+  gopSize?: number;
+  maxBFrames?: number;
+};

package/src/models/NameURIPairType.ts

@@ -0,0 +1,4 @@
+export type NameURIPairType = {
+  name: string;
+  uri: string;
+};

package/src/models/NetworkType.ts

@@ -0,0 +1,4 @@
+export type NetworkType = {
+  netmask: string;
+  bandwidth?: number;
+};

package/src/models/NotAuthorizedExceptionType.ts

@@ -0,0 +1,3 @@
+export type NotAuthorizedExceptionType = {
+  message?: string;
+};

package/src/models/NotFoundExceptionType.ts

@@ -0,0 +1,5 @@
+export type NotFoundExceptionType = {
+  type?: string;
+  id?: string;
+  context?: string;
+};

package/src/models/NotYetImplementedExceptionType.ts

@@ -0,0 +1 @@
+export type NotYetImplementedExceptionType = {};

package/src/models/NotificationAccessTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationAccessTriggerType = NotificationTriggerType;

package/src/models/NotificationActionType.ts

@@ -0,0 +1,6 @@
+export type NotificationActionType = {
+  extradata?: string;
+  retry?: number;
+  synchronous: boolean;
+  group?: string;
+};

package/src/models/NotificationCollectionTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationCollectionTriggerType = NotificationTriggerType;

package/src/models/NotificationDeletionLockTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationDeletionLockTriggerType = NotificationTriggerType;

package/src/models/NotificationDocument.ts

@@ -0,0 +1,3 @@
+import type { NotificationType } from './NotificationType';
+
+export type NotificationDocument = NotificationType;

package/src/models/NotificationDocumentTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationMetadataTriggerType } from './NotificationMetadataTriggerType';
+
+export type NotificationDocumentTriggerType = NotificationMetadataTriggerType;

package/src/models/NotificationEjbActionType.ts

@@ -0,0 +1,8 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { NotificationActionType } from './NotificationActionType';
+
+export type NotificationEjbActionType = NotificationActionType & {
+  bean: string;
+  method: string;
+  data?: Array<KeyValuePairType>;
+};

package/src/models/NotificationFileTriggerType.ts

@@ -0,0 +1,12 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+import type { SiteIdType } from './SiteIdType';
+
+export type NotificationFileTriggerType = NotificationTriggerType & {
+  storage?: SiteIdType;
+  new?: string;
+  delete?: string;
+  change?: string;
+  hash?: string;
+  close?: string;
+  lost?: string;
+};

package/src/models/NotificationGroupTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationGroupTriggerType = NotificationTriggerType;

package/src/models/NotificationHttpActionType.ts

@@ -0,0 +1,8 @@
+import type { NotificationActionType } from './NotificationActionType';
+
+export type NotificationHttpActionType = NotificationActionType & {
+  contentType?: string;
+  url: string;
+  method?: string;
+  timeout: string;
+};

package/src/models/NotificationItemTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationItemTriggerType = NotificationTriggerType;

package/src/models/NotificationJavaScriptActionType.ts

@@ -0,0 +1,5 @@
+import type { NotificationActionType } from './NotificationActionType';
+
+export type NotificationJavaScriptActionType = NotificationActionType & {
+  script: string;
+};

package/src/models/NotificationJmsActionType.ts

@@ -0,0 +1,9 @@
+import type { NotificationActionType } from './NotificationActionType';
+
+export type NotificationJmsActionType = NotificationActionType & {
+  contentType?: string;
+  queueFactory: string;
+  queue: string;
+  username?: string;
+  password?: string;
+};

package/src/models/NotificationJobTriggerType.ts

@@ -0,0 +1,22 @@
+import type { jobNotificationContentFilter } from './jobNotificationContentFilter';
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationJobTriggerType = NotificationTriggerType & {
+  placeholder?: boolean;
+  contentFilters?: {
+    contentFilter?: Array<jobNotificationContentFilter>;
+  };
+  filter?: {
+    type?: string;
+    step?: number;
+    jobdata?: {
+      key?: string;
+      'key-regex'?: string;
+    };
+  };
+  update?: string;
+  stop?: string;
+  finished?: string;
+  fail?: string;
+  create?: string;
+};

package/src/models/NotificationMetadataTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationMetadataTriggerType = NotificationTriggerType;

package/src/models/NotificationQuotaTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationQuotaTriggerType = NotificationTriggerType;

package/src/models/NotificationSNSActionType.ts

@@ -0,0 +1,12 @@
+import type { NotificationActionType } from './NotificationActionType';
+
+export type NotificationSNSActionType = NotificationActionType & {
+  contentType?: string;
+  endpoint: string;
+  topic: string;
+  secret?: string;
+  accessKey?: string;
+  roleArn?: string;
+  roleExternalId?: string;
+  roleSessionName?: string;
+};

package/src/models/NotificationSQSActionType.ts

@@ -0,0 +1,13 @@
+import type { NotificationActionType } from './NotificationActionType';
+
+export type NotificationSQSActionType = NotificationActionType & {
+  contentType?: string;
+  endpoint: string;
+  queue: string;
+  secret?: string;
+  accessKey?: string;
+  roleArn?: string;
+  roleExternalId?: string;
+  roleSessionName?: string;
+  messageGroupId?: string;
+};

package/src/models/NotificationShapeTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationShapeTriggerType = NotificationTriggerType;

package/src/models/NotificationStorageTriggerType.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationStorageTriggerType = NotificationTriggerType;

package/src/models/NotificationTriggerDocument.ts

@@ -0,0 +1,3 @@
+import type { NotificationTriggerType } from './NotificationTriggerType';
+
+export type NotificationTriggerDocument = NotificationTriggerType;

package/src/models/NotificationTriggerType.ts

@@ -0,0 +1,3 @@
+export type NotificationTriggerType = {
+  type?: string;
+};

package/src/models/NotificationType.ts

@@ -0,0 +1,43 @@
+import type { NotificationAccessTriggerType } from './NotificationAccessTriggerType';
+import type { NotificationCollectionTriggerType } from './NotificationCollectionTriggerType';
+import type { NotificationDeletionLockTriggerType } from './NotificationDeletionLockTriggerType';
+import type { NotificationDocumentTriggerType } from './NotificationDocumentTriggerType';
+import type { NotificationEjbActionType } from './NotificationEjbActionType';
+import type { NotificationFileTriggerType } from './NotificationFileTriggerType';
+import type { NotificationGroupTriggerType } from './NotificationGroupTriggerType';
+import type { NotificationHttpActionType } from './NotificationHttpActionType';
+import type { NotificationItemTriggerType } from './NotificationItemTriggerType';
+import type { NotificationJavaScriptActionType } from './NotificationJavaScriptActionType';
+import type { NotificationJmsActionType } from './NotificationJmsActionType';
+import type { NotificationJobTriggerType } from './NotificationJobTriggerType';
+import type { NotificationMetadataTriggerType } from './NotificationMetadataTriggerType';
+import type { NotificationQuotaTriggerType } from './NotificationQuotaTriggerType';
+import type { NotificationShapeTriggerType } from './NotificationShapeTriggerType';
+import type { NotificationSNSActionType } from './NotificationSNSActionType';
+import type { NotificationSQSActionType } from './NotificationSQSActionType';
+import type { NotificationStorageTriggerType } from './NotificationStorageTriggerType';
+
+export type NotificationType = {
+  action: {
+    http?: NotificationHttpActionType;
+    ejb?: NotificationEjbActionType;
+    jms?: NotificationJmsActionType;
+    javascript?: NotificationJavaScriptActionType;
+    sqs?: NotificationSQSActionType;
+    sns?: NotificationSNSActionType;
+  };
+  trigger: {
+    job?: NotificationJobTriggerType;
+    metadata?: NotificationMetadataTriggerType;
+    item?: NotificationItemTriggerType;
+    collection?: NotificationCollectionTriggerType;
+    storage?: NotificationStorageTriggerType;
+    file?: NotificationFileTriggerType;
+    group?: NotificationGroupTriggerType;
+    access?: NotificationAccessTriggerType;
+    shape?: NotificationShapeTriggerType;
+    quota?: NotificationQuotaTriggerType;
+    document?: NotificationDocumentTriggerType;
+    deletionLock?: NotificationDeletionLockTriggerType;
+  };
+};

package/src/models/OAuth2ConfigurationDocument.ts

@@ -0,0 +1,3 @@
+import type { OAuth2ConfigurationType } from './OAuth2ConfigurationType';
+
+export type OAuth2ConfigurationDocument = OAuth2ConfigurationType;

package/src/models/OAuth2ConfigurationType.ts

@@ -0,0 +1,9 @@
+export type OAuth2ConfigurationType = {
+  federationMetadataURI?: string;
+  federationMetadataInterval?: number;
+  expectedAudience?: string;
+  validationEndpoint?: string;
+  tokenUser?: string;
+  x509Certificate?: Array<string>;
+  publicKey?: Array<string>;
+};

package/src/models/OSName.ts

@@ -0,0 +1,9 @@
+export type OSName =
+  | 'DEBIAN32'
+  | 'DEBIAN64'
+  | 'REDHAT32'
+  | 'REDHAT64'
+  | 'WINDOWS32'
+  | 'WINDOWS64'
+  | 'MACOSX32'
+  | 'MACOSX64';

package/src/models/OtifConfigurationDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifConfigurationType } from './OtifConfigurationType';
+
+export type OtifConfigurationDocument = OtifConfigurationType;

package/src/models/OtifConfigurationListDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifConfigurationListType } from './OtifConfigurationListType';
+
+export type OtifConfigurationListDocument = OtifConfigurationListType;

package/src/models/OtifConfigurationListType.ts

@@ -0,0 +1,6 @@
+import type { OtifConfigurationType } from './OtifConfigurationType';
+
+export type OtifConfigurationListType = {
+  hits?: number;
+  configuration?: Array<OtifConfigurationType>;
+};

package/src/models/OtifConfigurationType.ts

@@ -0,0 +1,10 @@
+import type { OtifPresetType } from './OtifPresetType';
+import type { SiteIdType } from './SiteIdType';
+
+export type OtifConfigurationType = {
+  id?: SiteIdType;
+  title?: string;
+  description?: string;
+  preset?: OtifPresetType;
+  instance?: string;
+};

package/src/models/OtifDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifType } from './OtifType';
+
+export type OtifDocument = OtifType;

package/src/models/OtifJobConfigurationDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifJobConfigurationType } from './OtifJobConfigurationType';
+
+export type OtifJobConfigurationDocument = OtifJobConfigurationType;

package/src/models/OtifJobConfigurationListDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifJobConfigurationListType } from './OtifJobConfigurationListType';
+
+export type OtifJobConfigurationListDocument = OtifJobConfigurationListType;

package/src/models/OtifJobConfigurationListType.ts

@@ -0,0 +1,6 @@
+import type { OtifJobConfigurationType } from './OtifJobConfigurationType';
+
+export type OtifJobConfigurationListType = {
+  hits?: number;
+  configuration?: Array<OtifJobConfigurationType>;
+};

package/src/models/OtifJobConfigurationType.ts

@@ -0,0 +1,10 @@
+import type { OtifConfigurationListType } from './OtifConfigurationListType';
+import type { SiteIdType } from './SiteIdType';
+import type { VXAType } from './VXAType';
+
+export type OtifJobConfigurationType = {
+  id?: SiteIdType;
+  title: string;
+  configurations: OtifConfigurationListType;
+  vxa: Array<VXAType>;
+};

package/src/models/OtifListDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifListType } from './OtifListType';
+
+export type OtifListDocument = OtifListType;

package/src/models/OtifListType.ts

@@ -0,0 +1,6 @@
+import type { OtifType } from './OtifType';
+
+export type OtifListType = {
+  hits?: number;
+  otif?: Array<OtifType>;
+};

package/src/models/OtifOSDocment.ts

@@ -0,0 +1,3 @@
+import type { OtifOSType } from './OtifOSType';
+
+export type OtifOSDocment = OtifOSType;

package/src/models/OtifOSType.ts

@@ -0,0 +1,6 @@
+import type { OSName } from './OSName';
+
+export type OtifOSType = {
+  name: OSName;
+  file: Array<string>;
+};

package/src/models/OtifPluginType.ts

@@ -0,0 +1 @@
+export type OtifPluginType = 'audio' | 'video';

package/src/models/OtifPresetDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifPresetType } from './OtifPresetType';
+
+export type OtifPresetDocument = OtifPresetType;

package/src/models/OtifPresetType.ts

@@ -0,0 +1,11 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { NameURIPairType } from './NameURIPairType';
+
+export type OtifPresetType = {
+  uuid: string;
+  versionMajor: number;
+  versionMinor: number;
+  versionPatch: number;
+  configuration?: Array<KeyValuePairType>;
+  resource?: Array<NameURIPairType>;
+};

package/src/models/OtifResourceDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifResourceType } from './OtifResourceType';
+
+export type OtifResourceDocument = OtifResourceType;

package/src/models/OtifResourceListDocument.ts

@@ -0,0 +1,3 @@
+import type { OtifResourceListType } from './OtifResourceListType';
+
+export type OtifResourceListDocument = OtifResourceListType;

package/src/models/OtifResourceListType.ts

@@ -0,0 +1,6 @@
+import type { OtifResourceType } from './OtifResourceType';
+
+export type OtifResourceListType = {
+  hits?: number;
+  resource?: Array<OtifResourceType>;
+};

package/src/models/OtifResourceType.ts

@@ -0,0 +1,4 @@
+export type OtifResourceType = {
+  name: string;
+  size: number;
+};

package/src/models/OtifTranscoderPluginDocment.ts

@@ -0,0 +1,3 @@
+import type { OtifTranscoderPluginType } from './OtifTranscoderPluginType';
+
+export type OtifTranscoderPluginDocment = OtifTranscoderPluginType;

package/src/models/OtifTranscoderPluginType.ts

@@ -0,0 +1,8 @@
+import type { OtifOSType } from './OtifOSType';
+import type { OtifPluginType } from './OtifPluginType';
+
+export type OtifTranscoderPluginType = {
+  pluginType: OtifPluginType;
+  os?: Array<OtifOSType>;
+  file?: Array<string>;
+};

package/src/models/OtifType.ts

@@ -0,0 +1,13 @@
+import type { OtifTranscoderPluginType } from './OtifTranscoderPluginType';
+import type { OtifVxaPluginType } from './OtifVxaPluginType';
+
+export type OtifType = {
+  uuid: string;
+  pluginName: string;
+  vendorName: string;
+  versionMajor: number;
+  versionMinor: number;
+  versionPatch: number;
+  transcoderPlugin?: OtifTranscoderPluginType;
+  vxaPlugin?: OtifVxaPluginType;
+};

package/src/models/OtifVxaPluginDocment.ts

@@ -0,0 +1,3 @@
+import type { OtifVxaPluginType } from './OtifVxaPluginType';
+
+export type OtifVxaPluginDocment = OtifVxaPluginType;

package/src/models/OtifVxaPluginType.ts

@@ -0,0 +1,3 @@
+export type OtifVxaPluginType = {
+  file: string;
+};

package/src/models/OverlayType.ts

@@ -0,0 +1,13 @@
+import type { SequenceRangeType } from './SequenceRangeType';
+import type { SiteIdType } from './SiteIdType';
+import type { TimeIntervalType } from './TimeIntervalType';
+
+export type OverlayType = {
+  uri?: Array<string>;
+  range?: Array<SequenceRangeType>;
+  id?: SiteIdType;
+  x: number;
+  y: number;
+  interval?: TimeIntervalType;
+  opacity?: number;
+};

package/src/models/PackageTrackType.ts

@@ -0,0 +1,10 @@
+import type { FrameRateType } from './FrameRateType';
+
+export type PackageTrackType = {
+  name: string;
+  number: number;
+  isPicture: boolean;
+  is50FPS?: boolean;
+  frameRate?: FrameRateType;
+  length: number;
+};

package/src/models/PackageType.ts

@@ -0,0 +1,7 @@
+import type { MXFTimestampType } from './MXFTimestampType';
+import type { UMIDType } from './UMIDType';
+
+export type PackageType = {
+  umid: UMIDType;
+  timestamp: MXFTimestampType;
+};

package/src/models/PartialFileDVDescriptorType.ts

@@ -0,0 +1,4 @@
+export type PartialFileDVDescriptorType = {
+  frameSize: number;
+  frameCount: number;
+};

package/src/models/PartialFileDemuxerInfoType.ts

@@ -0,0 +1,8 @@
+import type { PartialFileDescriptorType } from './PartialFileDescriptorType';
+
+export type PartialFileDemuxerInfoType = {
+  byteOffset?: number;
+  adjustForPTSPredecessors?: boolean;
+  descriptor?: PartialFileDescriptorType;
+  descriptorLocation?: string;
+};

package/src/models/PartialFileDescriptorDocument.ts

@@ -0,0 +1,3 @@
+import type { PartialFileDescriptorType } from './PartialFileDescriptorType';
+
+export type PartialFileDescriptorDocument = PartialFileDescriptorType;

package/src/models/PartialFileDescriptorType.ts

@@ -0,0 +1,18 @@
+import type { AudioComponentType } from './AudioComponentType';
+import type { ContainerComponentType } from './ContainerComponentType';
+import type { PartialFileDVDescriptorType } from './PartialFileDVDescriptorType';
+import type { PartialFileRandomIndexType } from './PartialFileRandomIndexType';
+import type { VideoComponentType } from './VideoComponentType';
+
+export type PartialFileDescriptorType = {
+  label?: string;
+  transcoderVersion?: string;
+  startTimecode?: number;
+  roundedTimeBase?: number;
+  dropFrame?: boolean;
+  containerComponent?: ContainerComponentType;
+  audioStream?: Array<AudioComponentType>;
+  videoStream?: Array<VideoComponentType>;
+  dvDescriptor?: PartialFileDVDescriptorType;
+  index?: PartialFileRandomIndexType;
+};

package/src/models/PartialFileRandomIndexType.ts

@@ -0,0 +1,11 @@
+export type PartialFileRandomIndexType = {
+  packet?: Array<{
+    pts?: number;
+    dts?: number;
+    offset?: number;
+    length?: number;
+    duration?: number;
+    stream?: number;
+    isKeyFrame?: boolean;
+  }>;
+};

package/src/models/PathAliasConfigurationDocument.ts

@@ -0,0 +1,3 @@
+import type { PathAliasConfigurationType } from './PathAliasConfigurationType';
+
+export type PathAliasConfigurationDocument = PathAliasConfigurationType;

package/src/models/PathAliasConfigurationType.ts

@@ -0,0 +1,3 @@
+export type PathAliasConfigurationType = {
+  alias?: Array<string>;
+};