aes70 1.6.2 → 2.0.1

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;
+  }
+}

package/src/types/OcaMediaStreamMode.d.ts

@@ -0,0 +1,83 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaMediaFrameFormat,
+  OcaMediaFrameFormat,
+} from './OcaMediaFrameFormat';
+
+export declare interface IOcaMediaStreamMode {
+  /**
+   * Media frame format
+   * @type OcaMediaFrameFormat
+   */
+  FrameFormat: IOcaMediaFrameFormat;
+
+  /**
+   * Media encoding type
+   * @type string
+   */
+  EncodingType: string;
+
+  /**
+   * Media sampling rate
+   * @type number
+   */
+  SamplingRate: number;
+
+  /**
+   * Number of signal channels in the stream
+   * @type number
+   */
+  ChannelCount: number;
+
+  /**
+   * Duration of the media signal fragment carried in a single network packet.
+   * @type number
+   */
+  PacketTime: number;
+}
+
+export declare class OcaMediaStreamMode implements IOcaMediaStreamMode {
+  /**
+   * Current media stream mode descriptor.
+   * @class OcaMediaStreamMode
+   */
+  constructor(
+    FrameFormat: OcaMediaFrameFormat,
+    EncodingType: string,
+    SamplingRate: number,
+    ChannelCount: number,
+    PacketTime: number
+  );
+
+  /**
+   * Media frame format
+   * @type OcaMediaFrameFormat
+   */
+  FrameFormat: OcaMediaFrameFormat;
+
+  /**
+   * Media encoding type
+   * @type string
+   */
+  EncodingType: string;
+
+  /**
+   * Media sampling rate
+   * @type number
+   */
+  SamplingRate: number;
+
+  /**
+   * Number of signal channels in the stream
+   * @type number
+   */
+  ChannelCount: number;
+
+  /**
+   * Duration of the media signal fragment carried in a single network packet.
+   * @type number
+   */
+  PacketTime: number;
+}

package/src/types/OcaMediaStreamMode.js

@@ -0,0 +1,43 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaStreamMode {
+  /**
+   * Current media stream mode descriptor.
+   * @class OcaMediaStreamMode
+   */
+  constructor(
+    FrameFormat,
+    EncodingType,
+    SamplingRate,
+    ChannelCount,
+    PacketTime
+  ) {
+    /**
+     * Media frame format
+     * @type OcaMediaFrameFormat
+     */
+    this.FrameFormat = FrameFormat;
+    /**
+     * Media encoding type
+     * @type string
+     */
+    this.EncodingType = EncodingType;
+    /**
+     * Media sampling rate
+     * @type number
+     */
+    this.SamplingRate = SamplingRate;
+    /**
+     * Number of signal channels in the stream
+     * @type number
+     */
+    this.ChannelCount = ChannelCount;
+    /**
+     * Duration of the media signal fragment carried in a single network packet.
+     * @type number
+     */
+    this.PacketTime = PacketTime;
+  }
+}

package/src/types/OcaMediaStreamModeCapability.d.ts

@@ -0,0 +1,167 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaInterval, OcaInterval } from './OcaInterval';
+import {
+  IOcaMediaFrameFormat,
+  OcaMediaFrameFormat,
+} from './OcaMediaFrameFormat';
+import { IOcaMediaStreamModeCapabilityDirection } from './OcaMediaStreamModeCapabilityDirection';
+
+export declare interface IOcaMediaStreamModeCapability {
+  /**
+   * ID of this capability
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * Arbitrary user-supplied name of this capability
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Supported input/output direction - input, output, or both.
+   * @type IOcaMediaStreamModeCapabilityDirection
+   */
+  Direction: IOcaMediaStreamModeCapabilityDirection;
+
+  /**
+   * Supported frame formats
+   * @type OcaMediaFrameFormat[]
+   */
+  FrameFormatList: IOcaMediaFrameFormat[];
+
+  /**
+   * Supported encoding types
+   * @type string[]
+   */
+  EncodingTypeList: string[];
+
+  /**
+   * Supported sampling rates
+   * @type number[]
+   */
+  SamplingRateList: number[];
+
+  /**
+   * Supported channel count list. If both a list and a range are specified, the
+   * capability includes all channel counts within the union of the two
+   * constraints.
+   * @type number[]
+   */
+  ChannelCountList: number[];
+
+  /**
+   * Supported channel count range. If both a list and a range are specified,
+   * the capability includes all channel counts within the union of the two
+   * constraints.
+   * @type OcaInterval<number>
+   */
+  ChannelCountRange: IOcaInterval<number>;
+
+  /**
+   * Supported packet-time value list. If both a list and a range are specified,
+   * the capability includes all packet times within the union of the two
+   * constraints.
+   * @type number[]
+   */
+  PacketTimeList: number[];
+
+  /**
+   * Range of supported packet-time values. If both a list and a range are
+   * specified, the capability includes all packet times within the union of the
+   * two constraints.
+   * @type OcaInterval<number>
+   */
+  PacketTimeRange: IOcaInterval<number>;
+}
+
+export declare class OcaMediaStreamModeCapability
+  implements IOcaMediaStreamModeCapability {
+  /**
+   * Media stream mode capability descriptor.
+   * @class OcaMediaStreamModeCapability
+   */
+  constructor(
+    ID: number,
+    Name: string,
+    Direction: IOcaMediaStreamModeCapabilityDirection,
+    FrameFormatList: OcaMediaFrameFormat[],
+    EncodingTypeList: string[],
+    SamplingRateList: number[],
+    ChannelCountList: number[],
+    ChannelCountRange: OcaInterval<number>,
+    PacketTimeList: number[],
+    PacketTimeRange: OcaInterval<number>
+  );
+
+  /**
+   * ID of this capability
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * Arbitrary user-supplied name of this capability
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Supported input/output direction - input, output, or both.
+   * @type IOcaMediaStreamModeCapabilityDirection
+   */
+  Direction: IOcaMediaStreamModeCapabilityDirection;
+
+  /**
+   * Supported frame formats
+   * @type OcaMediaFrameFormat[]
+   */
+  FrameFormatList: OcaMediaFrameFormat[];
+
+  /**
+   * Supported encoding types
+   * @type string[]
+   */
+  EncodingTypeList: string[];
+
+  /**
+   * Supported sampling rates
+   * @type number[]
+   */
+  SamplingRateList: number[];
+
+  /**
+   * Supported channel count list. If both a list and a range are specified, the
+   * capability includes all channel counts within the union of the two
+   * constraints.
+   * @type number[]
+   */
+  ChannelCountList: number[];
+
+  /**
+   * Supported channel count range. If both a list and a range are specified,
+   * the capability includes all channel counts within the union of the two
+   * constraints.
+   * @type OcaInterval<number>
+   */
+  ChannelCountRange: OcaInterval<number>;
+
+  /**
+   * Supported packet-time value list. If both a list and a range are specified,
+   * the capability includes all packet times within the union of the two
+   * constraints.
+   * @type number[]
+   */
+  PacketTimeList: number[];
+
+  /**
+   * Range of supported packet-time values. If both a list and a range are
+   * specified, the capability includes all packet times within the union of the
+   * two constraints.
+   * @type OcaInterval<number>
+   */
+  PacketTimeRange: OcaInterval<number>;
+}

package/src/types/OcaMediaStreamModeCapability.js

@@ -0,0 +1,81 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaStreamModeCapability {
+  /**
+   * Media stream mode capability descriptor.
+   * @class OcaMediaStreamModeCapability
+   */
+  constructor(
+    ID,
+    Name,
+    Direction,
+    FrameFormatList,
+    EncodingTypeList,
+    SamplingRateList,
+    ChannelCountList,
+    ChannelCountRange,
+    PacketTimeList,
+    PacketTimeRange
+  ) {
+    /**
+     * ID of this capability
+     * @type number
+     */
+    this.ID = ID;
+    /**
+     * Arbitrary user-supplied name of this capability
+     * @type string
+     */
+    this.Name = Name;
+    /**
+     * Supported input/output direction - input, output, or both.
+     * @type IOcaMediaStreamModeCapabilityDirection
+     */
+    this.Direction = Direction;
+    /**
+     * Supported frame formats
+     * @type OcaMediaFrameFormat[]
+     */
+    this.FrameFormatList = FrameFormatList;
+    /**
+     * Supported encoding types
+     * @type string[]
+     */
+    this.EncodingTypeList = EncodingTypeList;
+    /**
+     * Supported sampling rates
+     * @type number[]
+     */
+    this.SamplingRateList = SamplingRateList;
+    /**
+     * Supported channel count list. If both a list and a range are specified,
+     * the capability includes all channel counts within the union of the two
+     * constraints.
+     * @type number[]
+     */
+    this.ChannelCountList = ChannelCountList;
+    /**
+     * Supported channel count range. If both a list and a range are specified,
+     * the capability includes all channel counts within the union of the two
+     * constraints.
+     * @type OcaInterval<number>
+     */
+    this.ChannelCountRange = ChannelCountRange;
+    /**
+     * Supported packet-time value list. If both a list and a range are
+     * specified, the capability includes all packet times within the union of
+     * the two constraints.
+     * @type number[]
+     */
+    this.PacketTimeList = PacketTimeList;
+    /**
+     * Range of supported packet-time values. If both a list and a range are
+     * specified, the capability includes all packet times within the union of
+     * the two constraints.
+     * @type OcaInterval<number>
+     */
+    this.PacketTimeRange = PacketTimeRange;
+  }
+}

package/src/types/OcaMediaStreamModeCapabilityDirection.d.ts

@@ -0,0 +1,21 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Bitset describing the I/O direction(s) an Endpoint supports.
+ * @enum {number}
+ * @readonly
+ */
+export declare const OcaMediaStreamModeCapabilityDirection: {
+  /**
+   * Entry with value ``1``.
+   */
+  Input: number;
+
+  /**
+   * Entry with value ``2``.
+   */
+  Output: number;
+};
+
+export declare type IOcaMediaStreamModeCapabilityDirection = number;

package/src/types/OcaMediaStreamModeCapabilityDirection.js

@@ -0,0 +1,27 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Bitset describing the I/O direction(s) an Endpoint supports.
+ * @enum {number}
+ * @readonly
+ */
+export const OcaMediaStreamModeCapabilityDirection = {
+  Input: 1,
+  Output: 2,
+};
+
+/**
+ * Entry with value ``1``.
+ * @type {number}
+ * @member Input
+ * @memberof OcaMediaStreamModeCapabilityDirection
+ * @static
+ */
+/**
+ * Entry with value ``2``.
+ * @type {number}
+ * @member Output
+ * @memberof OcaMediaStreamModeCapabilityDirection
+ * @static
+ */

package/src/types/OcaMediaTrackFunction.d.ts

@@ -0,0 +1,27 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Media track function. Controls handling of a track during
+ * **OcaMediaRecorderPlayer** operations.
+ * @enum {number}
+ * @readonly
+ */
+export declare const OcaMediaTrackFunction: {
+  /**
+   * Entry with value ``1``.
+   */
+  PlayInPlayMode: number;
+
+  /**
+   * Entry with value ``2``.
+   */
+  PlayInRecordMode: number;
+
+  /**
+   * Entry with value ``4``.
+   */
+  RecordInRecordMode: number;
+};
+
+export declare type IOcaMediaTrackFunction = number;

package/src/types/OcaMediaTrackFunction.js

@@ -0,0 +1,36 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Media track function. Controls handling of a track during
+ * **OcaMediaRecorderPlayer** operations.
+ * @enum {number}
+ * @readonly
+ */
+export const OcaMediaTrackFunction = {
+  PlayInPlayMode: 1,
+  PlayInRecordMode: 2,
+  RecordInRecordMode: 4,
+};
+
+/**
+ * Entry with value ``1``.
+ * @type {number}
+ * @member PlayInPlayMode
+ * @memberof OcaMediaTrackFunction
+ * @static
+ */
+/**
+ * Entry with value ``2``.
+ * @type {number}
+ * @member PlayInRecordMode
+ * @memberof OcaMediaTrackFunction
+ * @static
+ */
+/**
+ * Entry with value ``4``.
+ * @type {number}
+ * @member RecordInRecordMode
+ * @memberof OcaMediaTrackFunction
+ * @static
+ */