aes70 1.6.1 → 2.0.0

package/src/types/OcaMediaStreamEndpoint.d.ts

@@ -0,0 +1,238 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaIODirection, OcaIODirection } from './OcaIODirection';
+import {
+  IOcaMediaStreamCastMode,
+  OcaMediaStreamCastMode,
+} from './OcaMediaStreamCastMode';
+import { IOcaMediaStreamMode, OcaMediaStreamMode } from './OcaMediaStreamMode';
+import { IOcaPortID, OcaPortID } from './OcaPortID';
+import { IOcaSecurityType, OcaSecurityType } from './OcaSecurityType';
+
+export declare interface IOcaMediaStreamEndpoint {
+  /**
+   * Internal ID.
+   * @type number
+   */
+  IDInternal: number;
+
+  /**
+   * Public identifier of endpoint. May be advertised on the network.
+   * @type Uint8Array
+   */
+  IDExternal: Uint8Array;
+
+  /**
+   * Input or output (input ``->`` samples flow into endpoint from network,
+   * ``output->samples`` flow out of endpoint into network)
+   * @type OcaIODirection
+   */
+  Direction: IOcaIODirection;
+
+  /**
+   * Arbitrary user-settable label for endpoint.
+   * @type string
+   */
+  UserLabel: string;
+
+  /**
+   * ID(s) of the Network Assignment(s) this endpoint is using.
+   * @type number[]
+   */
+  NetworkAssignmentIDs: number[];
+
+  /**
+   * Media stream mode capabilities of this endpoint. List of indexes into
+   * **OcaMediaTransportApplication.MediaStreamModeCapabilities**.
+   * @type number[]
+   */
+  StreamModeCapabilityIDs: number[];
+
+  /**
+   * ONo of **OcaMediaClock3** media clock for this endpoint.
+   * @type number
+   */
+  ClockONo: number;
+
+  /**
+   * TRUE if and only if channel map may be modified at runtime.
+   * @type boolean
+   */
+  ChannelMapDynamic: boolean;
+
+  /**
+   * Map of this endpoint's signal channels to OCA Ports of the owning
+   * **OcaMediaTransportApplication** object. Each input endpoint channel may be
+   * mapped to zero or more **output** Ports; each output endpoint channel may
+   * be mapped to at most one **input** Port.
+   * @type Map<number, OcaPortID[]>
+   */
+  ChannelMap: Map<number, IOcaPortID[]>;
+
+  /**
+   * Alignment Level of the endpoint. The dBFS value is referenced to the
+   * endpoint's fullscale value, not to Device's internal fullscale value.
+   * @type number
+   */
+  AlignmentLevel: number;
+
+  /**
+   * Stream mode of current connection. If there is a no current connection,
+   * value is undefined.
+   * @type OcaMediaStreamMode
+   */
+  CurrentStreamMode: IOcaMediaStreamMode;
+
+  /**
+   * Security type of this endpoint, if any.
+   * @type OcaSecurityType
+   */
+  SecurityType: IOcaSecurityType;
+
+  /**
+   * Unicast or multicast
+   * @type OcaMediaStreamCastMode
+   */
+  StreamCastMode: IOcaMediaStreamCastMode;
+
+  /**
+   * Adaptation-specific connection data, e.g. IP addresses and ports of input
+   * and output endpoints. Specific media transport adaptations will define the
+   * fine-structure of this **OcaBlob**.
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+
+  /**
+   * ID of redundant set this endpoint belongs to. Unique within
+   * **OcaMediaTransportApplication** instance.
+   * @type number
+   */
+  RedundantSetID: number;
+}
+
+export declare class OcaMediaStreamEndpoint implements IOcaMediaStreamEndpoint {
+  /**
+   * Media stream endpoint descriptor. Collected by
+   * **OcaMediaTransportApplication**.
+   * @class OcaMediaStreamEndpoint
+   */
+  constructor(
+    IDInternal: number,
+    IDExternal: Uint8Array,
+    Direction: OcaIODirection,
+    UserLabel: string,
+    NetworkAssignmentIDs: number[],
+    StreamModeCapabilityIDs: number[],
+    ClockONo: number,
+    ChannelMapDynamic: boolean,
+    ChannelMap: Map<number, OcaPortID[]>,
+    AlignmentLevel: number,
+    CurrentStreamMode: OcaMediaStreamMode,
+    SecurityType: OcaSecurityType,
+    StreamCastMode: OcaMediaStreamCastMode,
+    AdaptationData: Uint8Array,
+    RedundantSetID: number
+  );
+
+  /**
+   * Internal ID.
+   * @type number
+   */
+  IDInternal: number;
+
+  /**
+   * Public identifier of endpoint. May be advertised on the network.
+   * @type Uint8Array
+   */
+  IDExternal: Uint8Array;
+
+  /**
+   * Input or output (input ``->`` samples flow into endpoint from network,
+   * ``output->samples`` flow out of endpoint into network)
+   * @type OcaIODirection
+   */
+  Direction: OcaIODirection;
+
+  /**
+   * Arbitrary user-settable label for endpoint.
+   * @type string
+   */
+  UserLabel: string;
+
+  /**
+   * ID(s) of the Network Assignment(s) this endpoint is using.
+   * @type number[]
+   */
+  NetworkAssignmentIDs: number[];
+
+  /**
+   * Media stream mode capabilities of this endpoint. List of indexes into
+   * **OcaMediaTransportApplication.MediaStreamModeCapabilities**.
+   * @type number[]
+   */
+  StreamModeCapabilityIDs: number[];
+
+  /**
+   * ONo of **OcaMediaClock3** media clock for this endpoint.
+   * @type number
+   */
+  ClockONo: number;
+
+  /**
+   * TRUE if and only if channel map may be modified at runtime.
+   * @type boolean
+   */
+  ChannelMapDynamic: boolean;
+
+  /**
+   * Map of this endpoint's signal channels to OCA Ports of the owning
+   * **OcaMediaTransportApplication** object. Each input endpoint channel may be
+   * mapped to zero or more **output** Ports; each output endpoint channel may
+   * be mapped to at most one **input** Port.
+   * @type Map<number, OcaPortID[]>
+   */
+  ChannelMap: Map<number, OcaPortID[]>;
+
+  /**
+   * Alignment Level of the endpoint. The dBFS value is referenced to the
+   * endpoint's fullscale value, not to Device's internal fullscale value.
+   * @type number
+   */
+  AlignmentLevel: number;
+
+  /**
+   * Stream mode of current connection. If there is a no current connection,
+   * value is undefined.
+   * @type OcaMediaStreamMode
+   */
+  CurrentStreamMode: OcaMediaStreamMode;
+
+  /**
+   * Security type of this endpoint, if any.
+   * @type OcaSecurityType
+   */
+  SecurityType: OcaSecurityType;
+
+  /**
+   * Unicast or multicast
+   * @type OcaMediaStreamCastMode
+   */
+  StreamCastMode: OcaMediaStreamCastMode;
+
+  /**
+   * Adaptation-specific connection data, e.g. IP addresses and ports of input
+   * and output endpoints. Specific media transport adaptations will define the
+   * fine-structure of this **OcaBlob**.
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+
+  /**
+   * ID of redundant set this endpoint belongs to. Unique within
+   * **OcaMediaTransportApplication** instance.
+   * @type number
+   */
+  RedundantSetID: number;
+}

package/src/types/OcaMediaStreamEndpoint.js

@@ -0,0 +1,114 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaStreamEndpoint {
+  /**
+   * Media stream endpoint descriptor. Collected by
+   * **OcaMediaTransportApplication**.
+   * @class OcaMediaStreamEndpoint
+   */
+  constructor(
+    IDInternal,
+    IDExternal,
+    Direction,
+    UserLabel,
+    NetworkAssignmentIDs,
+    StreamModeCapabilityIDs,
+    ClockONo,
+    ChannelMapDynamic,
+    ChannelMap,
+    AlignmentLevel,
+    CurrentStreamMode,
+    SecurityType,
+    StreamCastMode,
+    AdaptationData,
+    RedundantSetID
+  ) {
+    /**
+     * Internal ID.
+     * @type number
+     */
+    this.IDInternal = IDInternal;
+    /**
+     * Public identifier of endpoint. May be advertised on the network.
+     * @type Uint8Array
+     */
+    this.IDExternal = IDExternal;
+    /**
+     * Input or output (input ``->`` samples flow into endpoint from network,
+     * ``output->samples`` flow out of endpoint into network)
+     * @type OcaIODirection
+     */
+    this.Direction = Direction;
+    /**
+     * Arbitrary user-settable label for endpoint.
+     * @type string
+     */
+    this.UserLabel = UserLabel;
+    /**
+     * ID(s) of the Network Assignment(s) this endpoint is using.
+     * @type number[]
+     */
+    this.NetworkAssignmentIDs = NetworkAssignmentIDs;
+    /**
+     * Media stream mode capabilities of this endpoint. List of indexes into
+     * **OcaMediaTransportApplication.MediaStreamModeCapabilities**.
+     * @type number[]
+     */
+    this.StreamModeCapabilityIDs = StreamModeCapabilityIDs;
+    /**
+     * ONo of **OcaMediaClock3** media clock for this endpoint.
+     * @type number
+     */
+    this.ClockONo = ClockONo;
+    /**
+     * TRUE if and only if channel map may be modified at runtime.
+     * @type boolean
+     */
+    this.ChannelMapDynamic = ChannelMapDynamic;
+    /**
+     * Map of this endpoint's signal channels to OCA Ports of the owning
+     * **OcaMediaTransportApplication** object. Each input endpoint channel may
+     * be mapped to zero or more **output** Ports; each output endpoint channel
+     * may be mapped to at most one **input** Port.
+     * @type Map<number, OcaPortID[]>
+     */
+    this.ChannelMap = ChannelMap;
+    /**
+     * Alignment Level of the endpoint. The dBFS value is referenced to the
+     * endpoint's fullscale value, not to Device's internal fullscale value.
+     * @type number
+     */
+    this.AlignmentLevel = AlignmentLevel;
+    /**
+     * Stream mode of current connection. If there is a no current connection,
+     * value is undefined.
+     * @type OcaMediaStreamMode
+     */
+    this.CurrentStreamMode = CurrentStreamMode;
+    /**
+     * Security type of this endpoint, if any.
+     * @type OcaSecurityType
+     */
+    this.SecurityType = SecurityType;
+    /**
+     * Unicast or multicast
+     * @type OcaMediaStreamCastMode
+     */
+    this.StreamCastMode = StreamCastMode;
+    /**
+     * Adaptation-specific connection data, e.g. IP addresses and ports of input
+     * and output endpoints. Specific media transport adaptations will define
+     * the fine-structure of this **OcaBlob**.
+     * @type Uint8Array
+     */
+    this.AdaptationData = AdaptationData;
+    /**
+     * ID of redundant set this endpoint belongs to. Unique within
+     * **OcaMediaTransportApplication** instance.
+     * @type number
+     */
+    this.RedundantSetID = RedundantSetID;
+  }
+}

package/src/types/OcaMediaStreamEndpointCommand.d.ts

@@ -0,0 +1,80 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Command values for **OcaMediaTransportApplication.ApplyEndpointCommand(...)**
+ * @class OcaMediaStreamEndpointCommand
+ */
+export class OcaMediaStreamEndpointCommand {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static None: OcaMediaStreamEndpointCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static SetReady: OcaMediaStreamEndpointCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Connect: OcaMediaStreamEndpointCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static ConnectAndStart: OcaMediaStreamEndpointCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static Disconnect: OcaMediaStreamEndpointCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``5``.
+   */
+  static StopAndDisconnect: OcaMediaStreamEndpointCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``6``.
+   */
+  static Start: OcaMediaStreamEndpointCommand;
+  /**
+   * Singleton object corresponding to the entry with value ``7``.
+   */
+  static Stop: OcaMediaStreamEndpointCommand;
+
+  /**
+   * Returns the numeric value of this enum entry.
+   */
+  valueOf(): number;
+
+  /**
+   * Returns the string representation of this enum entry.
+   */
+  toString(): string;
+
+  /**
+   * Returns the name of an enum entry.
+   */
+  static getName(value: number): string;
+
+  /**
+   * Returns the value of an enum entry name.
+   */
+  static getValue(name: string): number;
+}
+
+export type IOcaMediaStreamEndpointCommand =
+  | OcaMediaStreamEndpointCommand
+  | 'None'
+  | 'SetReady'
+  | 'Connect'
+  | 'ConnectAndStart'
+  | 'Disconnect'
+  | 'StopAndDisconnect'
+  | 'Start'
+  | 'Stop'
+  | 0
+  | 1
+  | 2
+  | 3
+  | 4
+  | 5
+  | 6
+  | 7;

package/src/types/OcaMediaStreamEndpointCommand.js

@@ -0,0 +1,76 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Command values for **OcaMediaTransportApplication.ApplyEndpointCommand(...)**
+ * @class OcaMediaStreamEndpointCommand
+ */
+export class OcaMediaStreamEndpointCommand extends Enum({
+  None: 0,
+  SetReady: 1,
+  Connect: 2,
+  ConnectAndStart: 3,
+  Disconnect: 4,
+  StopAndDisconnect: 5,
+  Start: 6,
+  Stop: 7,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member None
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member SetReady
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member Connect
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member ConnectAndStart
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member Disconnect
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member StopAndDisconnect
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``6``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member Start
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``7``.
+ * @type {OcaMediaStreamEndpointCommand}
+ * @member Stop
+ * @memberof OcaMediaStreamEndpointCommand
+ * @static
+ */

package/src/types/OcaMediaStreamEndpointState.d.ts

@@ -0,0 +1,68 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * State of a stream endpoint.
+ * @class OcaMediaStreamEndpointState
+ */
+export class OcaMediaStreamEndpointState {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static Unknown: OcaMediaStreamEndpointState;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static NotReady: OcaMediaStreamEndpointState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Ready: OcaMediaStreamEndpointState;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static Connected: OcaMediaStreamEndpointState;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static Running: OcaMediaStreamEndpointState;
+  /**
+   * Singleton object corresponding to the entry with value ``5``.
+   */
+  static ErrorHalt: OcaMediaStreamEndpointState;
+
+  /**
+   * Returns the numeric value of this enum entry.
+   */
+  valueOf(): number;
+
+  /**
+   * Returns the string representation of this enum entry.
+   */
+  toString(): string;
+
+  /**
+   * Returns the name of an enum entry.
+   */
+  static getName(value: number): string;
+
+  /**
+   * Returns the value of an enum entry name.
+   */
+  static getValue(name: string): number;
+}
+
+export type IOcaMediaStreamEndpointState =
+  | OcaMediaStreamEndpointState
+  | 'Unknown'
+  | 'NotReady'
+  | 'Ready'
+  | 'Connected'
+  | 'Running'
+  | 'ErrorHalt'
+  | 0
+  | 1
+  | 2
+  | 3
+  | 4
+  | 5;

package/src/types/OcaMediaStreamEndpointState.js

@@ -0,0 +1,60 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * State of a stream endpoint.
+ * @class OcaMediaStreamEndpointState
+ */
+export class OcaMediaStreamEndpointState extends Enum({
+  Unknown: 0,
+  NotReady: 1,
+  Ready: 2,
+  Connected: 3,
+  Running: 4,
+  ErrorHalt: 5,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaMediaStreamEndpointState}
+ * @member Unknown
+ * @memberof OcaMediaStreamEndpointState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaMediaStreamEndpointState}
+ * @member NotReady
+ * @memberof OcaMediaStreamEndpointState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaMediaStreamEndpointState}
+ * @member Ready
+ * @memberof OcaMediaStreamEndpointState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaMediaStreamEndpointState}
+ * @member Connected
+ * @memberof OcaMediaStreamEndpointState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaMediaStreamEndpointState}
+ * @member Running
+ * @memberof OcaMediaStreamEndpointState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaMediaStreamEndpointState}
+ * @member ErrorHalt
+ * @memberof OcaMediaStreamEndpointState
+ * @static
+ */

package/src/types/OcaMediaStreamEndpointStatus.d.ts

@@ -0,0 +1,44 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaMediaStreamEndpointState,
+  OcaMediaStreamEndpointState,
+} from './OcaMediaStreamEndpointState';
+
+export declare interface IOcaMediaStreamEndpointStatus {
+  /**
+   * Endpoint state
+   * @type OcaMediaStreamEndpointState
+   */
+  State: IOcaMediaStreamEndpointState;
+
+  /**
+   * Indicates what type of error the endpoint has encountered. Irrelevant if
+   * State is not **Fault**.
+   * @type number
+   */
+  ErrorCode: number;
+}
+
+export declare class OcaMediaStreamEndpointStatus
+  implements IOcaMediaStreamEndpointStatus {
+  /**
+   * Current status of a media stream endpoint.
+   * @class OcaMediaStreamEndpointStatus
+   */
+  constructor(State: OcaMediaStreamEndpointState, ErrorCode: number);
+
+  /**
+   * Endpoint state
+   * @type OcaMediaStreamEndpointState
+   */
+  State: OcaMediaStreamEndpointState;
+
+  /**
+   * Indicates what type of error the endpoint has encountered. Irrelevant if
+   * State is not **Fault**.
+   * @type number
+   */
+  ErrorCode: number;
+}

package/src/types/OcaMediaStreamEndpointStatus.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaStreamEndpointStatus {
+  /**
+   * Current status of a media stream endpoint.
+   * @class OcaMediaStreamEndpointStatus
+   */
+  constructor(State, ErrorCode) {
+    /**
+     * Endpoint state
+     * @type OcaMediaStreamEndpointState
+     */
+    this.State = State;
+    /**
+     * Indicates what type of error the endpoint has encountered. Irrelevant if
+     * State is not **Fault**.
+     * @type number
+     */
+    this.ErrorCode = ErrorCode;
+  }
+}