aes70 1.6.2 → 2.0.1

package/src/types/OcaMediaTransportSession.d.ts

@@ -0,0 +1,119 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaMediaTransportSessionConnection,
+  OcaMediaTransportSessionConnection,
+} from './OcaMediaTransportSessionConnection';
+import {
+  IOcaMediaTransportSessionConnectionState,
+  OcaMediaTransportSessionConnectionState,
+} from './OcaMediaTransportSessionConnectionState';
+
+export declare interface IOcaMediaTransportSession {
+  /**
+   * Internal ID, unique within OcaTransportSessionControlAgent instance.
+   * @type number
+   */
+  IDInternal: number;
+
+  /**
+   * External ID, i.e. the ID that is published to the network. Format is
+   * Adaptation-specific.
+   * @type Uint8Array
+   */
+  IDExternal: Uint8Array;
+
+  /**
+   * Arbitrary text label - not programmatically significant.
+   * @type string
+   */
+  UserLabel: string;
+
+  /**
+   * TRUE if and only if media streaming is allowed. If set to FALSE, does not
+   * cause disconnection.
+   * @type boolean
+   */
+  StreamingEnabled: boolean;
+
+  /**
+   * Adaptation-specific data.
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+
+  /**
+   * This session's stream connections.
+   * @type OcaMediaTransportSessionConnection[]
+   */
+  Connections: IOcaMediaTransportSessionConnection[];
+
+  /**
+   * State(s) of session's connection(s). Map key is connection ID.
+   * @type Map<number, OcaMediaTransportSessionConnectionState>
+   */
+  ConnectionStates: Map<number, IOcaMediaTransportSessionConnectionState>;
+}
+
+export declare class OcaMediaTransportSession
+  implements IOcaMediaTransportSession {
+  /**
+   * Container of all the Media Transport Sessions belonging to a Media
+   * Transport Session control Agent.
+   * @class OcaMediaTransportSession
+   */
+  constructor(
+    IDInternal: number,
+    IDExternal: Uint8Array,
+    UserLabel: string,
+    StreamingEnabled: boolean,
+    AdaptationData: Uint8Array,
+    Connections: OcaMediaTransportSessionConnection[],
+    ConnectionStates: Map<number, OcaMediaTransportSessionConnectionState>
+  );
+
+  /**
+   * Internal ID, unique within OcaTransportSessionControlAgent instance.
+   * @type number
+   */
+  IDInternal: number;
+
+  /**
+   * External ID, i.e. the ID that is published to the network. Format is
+   * Adaptation-specific.
+   * @type Uint8Array
+   */
+  IDExternal: Uint8Array;
+
+  /**
+   * Arbitrary text label - not programmatically significant.
+   * @type string
+   */
+  UserLabel: string;
+
+  /**
+   * TRUE if and only if media streaming is allowed. If set to FALSE, does not
+   * cause disconnection.
+   * @type boolean
+   */
+  StreamingEnabled: boolean;
+
+  /**
+   * Adaptation-specific data.
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+
+  /**
+   * This session's stream connections.
+   * @type OcaMediaTransportSessionConnection[]
+   */
+  Connections: OcaMediaTransportSessionConnection[];
+
+  /**
+   * State(s) of session's connection(s). Map key is connection ID.
+   * @type Map<number, OcaMediaTransportSessionConnectionState>
+   */
+  ConnectionStates: Map<number, OcaMediaTransportSessionConnectionState>;
+}

package/src/types/OcaMediaTransportSession.js

@@ -0,0 +1,58 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaTransportSession {
+  /**
+   * Container of all the Media Transport Sessions belonging to a Media
+   * Transport Session control Agent.
+   * @class OcaMediaTransportSession
+   */
+  constructor(
+    IDInternal,
+    IDExternal,
+    UserLabel,
+    StreamingEnabled,
+    AdaptationData,
+    Connections,
+    ConnectionStates
+  ) {
+    /**
+     * Internal ID, unique within OcaTransportSessionControlAgent instance.
+     * @type number
+     */
+    this.IDInternal = IDInternal;
+    /**
+     * External ID, i.e. the ID that is published to the network. Format is
+     * Adaptation-specific.
+     * @type Uint8Array
+     */
+    this.IDExternal = IDExternal;
+    /**
+     * Arbitrary text label - not programmatically significant.
+     * @type string
+     */
+    this.UserLabel = UserLabel;
+    /**
+     * TRUE if and only if media streaming is allowed. If set to FALSE, does not
+     * cause disconnection.
+     * @type boolean
+     */
+    this.StreamingEnabled = StreamingEnabled;
+    /**
+     * Adaptation-specific data.
+     * @type Uint8Array
+     */
+    this.AdaptationData = AdaptationData;
+    /**
+     * This session's stream connections.
+     * @type OcaMediaTransportSessionConnection[]
+     */
+    this.Connections = Connections;
+    /**
+     * State(s) of session's connection(s). Map key is connection ID.
+     * @type Map<number, OcaMediaTransportSessionConnectionState>
+     */
+    this.ConnectionStates = ConnectionStates;
+  }
+}

package/src/types/OcaMediaTransportSessionConnection.d.ts

@@ -0,0 +1,63 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaMediaTransportSessionConnection {
+  /**
+   * Local ID of this connection, unique within OcaMediaTransportSession
+   * instance.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * Value of the **IDInternal** property of the **OcaMediaStreamEndpoint**
+   * descriptor that applies to the local endpoint of the connection.
+   * @type number
+   */
+  LocalEndpointID: number;
+
+  /**
+   * External ID of the remote endpoint of the connection. Typically, this will
+   * be the value of the **IDexternal** property of the applicable
+   * **OcaMediaStreamEndpoint** descriptor in the remote device.
+   * @type Uint8Array
+   */
+  RemoteEndpointID: Uint8Array;
+}
+
+export declare class OcaMediaTransportSessionConnection
+  implements IOcaMediaTransportSessionConnection {
+  /**
+   * A Media Stream connection belonging to an **OcaMediaTransportSession**
+   * instance.
+   * @class OcaMediaTransportSessionConnection
+   */
+  constructor(
+    ID: number,
+    LocalEndpointID: number,
+    RemoteEndpointID: Uint8Array
+  );
+
+  /**
+   * Local ID of this connection, unique within OcaMediaTransportSession
+   * instance.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * Value of the **IDInternal** property of the **OcaMediaStreamEndpoint**
+   * descriptor that applies to the local endpoint of the connection.
+   * @type number
+   */
+  LocalEndpointID: number;
+
+  /**
+   * External ID of the remote endpoint of the connection. Typically, this will
+   * be the value of the **IDexternal** property of the applicable
+   * **OcaMediaStreamEndpoint** descriptor in the remote device.
+   * @type Uint8Array
+   */
+  RemoteEndpointID: Uint8Array;
+}

package/src/types/OcaMediaTransportSessionConnection.js

@@ -0,0 +1,32 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaTransportSessionConnection {
+  /**
+   * A Media Stream connection belonging to an **OcaMediaTransportSession**
+   * instance.
+   * @class OcaMediaTransportSessionConnection
+   */
+  constructor(ID, LocalEndpointID, RemoteEndpointID) {
+    /**
+     * Local ID of this connection, unique within OcaMediaTransportSession
+     * instance.
+     * @type number
+     */
+    this.ID = ID;
+    /**
+     * Value of the **IDInternal** property of the **OcaMediaStreamEndpoint**
+     * descriptor that applies to the local endpoint of the connection.
+     * @type number
+     */
+    this.LocalEndpointID = LocalEndpointID;
+    /**
+     * External ID of the remote endpoint of the connection. Typically, this
+     * will be the value of the **IDexternal** property of the applicable
+     * **OcaMediaStreamEndpoint** descriptor in the remote device.
+     * @type Uint8Array
+     */
+    this.RemoteEndpointID = RemoteEndpointID;
+  }
+}

package/src/types/OcaMediaTransportSessionConnectionState.d.ts

@@ -0,0 +1,47 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaMediaStreamEndpointState,
+  OcaMediaStreamEndpointState,
+} from './OcaMediaStreamEndpointState';
+
+export declare interface IOcaMediaTransportSessionConnectionState {
+  /**
+   * State of local endpoint of a connection.
+   * @type OcaMediaStreamEndpointState
+   */
+  LocalEndpointState: IOcaMediaStreamEndpointState;
+
+  /**
+   * State of remote endpoint of a connection.
+   * @type OcaMediaStreamEndpointState
+   */
+  RemoteEndpointState: IOcaMediaStreamEndpointState;
+}
+
+export declare class OcaMediaTransportSessionConnectionState
+  implements IOcaMediaTransportSessionConnectionState {
+  /**
+   * State of a stream connection belonging to an **OcaMediaTransportSession**
+   * instance. The state of a stream connection is the union of the states of
+   * its two endpoints.
+   * @class OcaMediaTransportSessionConnectionState
+   */
+  constructor(
+    LocalEndpointState: OcaMediaStreamEndpointState,
+    RemoteEndpointState: OcaMediaStreamEndpointState
+  );
+
+  /**
+   * State of local endpoint of a connection.
+   * @type OcaMediaStreamEndpointState
+   */
+  LocalEndpointState: OcaMediaStreamEndpointState;
+
+  /**
+   * State of remote endpoint of a connection.
+   * @type OcaMediaStreamEndpointState
+   */
+  RemoteEndpointState: OcaMediaStreamEndpointState;
+}

package/src/types/OcaMediaTransportSessionConnectionState.js

@@ -0,0 +1,24 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaTransportSessionConnectionState {
+  /**
+   * State of a stream connection belonging to an **OcaMediaTransportSession**
+   * instance. The state of a stream connection is the union of the states of
+   * its two endpoints.
+   * @class OcaMediaTransportSessionConnectionState
+   */
+  constructor(LocalEndpointState, RemoteEndpointState) {
+    /**
+     * State of local endpoint of a connection.
+     * @type OcaMediaStreamEndpointState
+     */
+    this.LocalEndpointState = LocalEndpointState;
+    /**
+     * State of remote endpoint of a connection.
+     * @type OcaMediaStreamEndpointState
+     */
+    this.RemoteEndpointState = RemoteEndpointState;
+  }
+}

package/src/types/OcaMediaTransportSessionState.d.ts

@@ -0,0 +1,62 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * State of a session
+ * @class OcaMediaTransportSessionState
+ */
+export class OcaMediaTransportSessionState {
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Unconfigured: OcaMediaTransportSessionState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Configured: OcaMediaTransportSessionState;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static ConnectedNotStreaming: OcaMediaTransportSessionState;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static ConnectedStreaming: OcaMediaTransportSessionState;
+  /**
+   * Singleton object corresponding to the entry with value ``5``.
+   */
+  static Error: OcaMediaTransportSessionState;
+
+  /**
+   * 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 IOcaMediaTransportSessionState =
+  | OcaMediaTransportSessionState
+  | 'Unconfigured'
+  | 'Configured'
+  | 'ConnectedNotStreaming'
+  | 'ConnectedStreaming'
+  | 'Error'
+  | 1
+  | 2
+  | 3
+  | 4
+  | 5;

package/src/types/OcaMediaTransportSessionState.js

@@ -0,0 +1,52 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * State of a session
+ * @class OcaMediaTransportSessionState
+ */
+export class OcaMediaTransportSessionState extends Enum({
+  Unconfigured: 1,
+  Configured: 2,
+  ConnectedNotStreaming: 3,
+  ConnectedStreaming: 4,
+  Error: 5,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaMediaTransportSessionState}
+ * @member Unconfigured
+ * @memberof OcaMediaTransportSessionState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaMediaTransportSessionState}
+ * @member Configured
+ * @memberof OcaMediaTransportSessionState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaMediaTransportSessionState}
+ * @member ConnectedNotStreaming
+ * @memberof OcaMediaTransportSessionState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaMediaTransportSessionState}
+ * @member ConnectedStreaming
+ * @memberof OcaMediaTransportSessionState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaMediaTransportSessionState}
+ * @member Error
+ * @memberof OcaMediaTransportSessionState
+ * @static
+ */

package/src/types/OcaMediaTransportSessionStatus.d.ts

@@ -0,0 +1,43 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaMediaTransportSessionState,
+  OcaMediaTransportSessionState,
+} from './OcaMediaTransportSessionState';
+
+export declare interface IOcaMediaTransportSessionStatus {
+  /**
+   * Generic state of session
+   * @type OcaMediaTransportSessionState
+   */
+  State: IOcaMediaTransportSessionState;
+
+  /**
+   * Adaptation-dependent state data
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+}
+
+export declare class OcaMediaTransportSessionStatus
+  implements IOcaMediaTransportSessionStatus {
+  /**
+   * Status of a media transport session. Two parts: a generic part, and an
+   * application-specific part.
+   * @class OcaMediaTransportSessionStatus
+   */
+  constructor(State: OcaMediaTransportSessionState, AdaptationData: Uint8Array);
+
+  /**
+   * Generic state of session
+   * @type OcaMediaTransportSessionState
+   */
+  State: OcaMediaTransportSessionState;
+
+  /**
+   * Adaptation-dependent state data
+   * @type Uint8Array
+   */
+  AdaptationData: Uint8Array;
+}

package/src/types/OcaMediaTransportSessionStatus.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaTransportSessionStatus {
+  /**
+   * Status of a media transport session. Two parts: a generic part, and an
+   * application-specific part.
+   * @class OcaMediaTransportSessionStatus
+   */
+  constructor(State, AdaptationData) {
+    /**
+     * Generic state of session
+     * @type OcaMediaTransportSessionState
+     */
+    this.State = State;
+    /**
+     * Adaptation-dependent state data
+     * @type Uint8Array
+     */
+    this.AdaptationData = AdaptationData;
+  }
+}

package/src/types/OcaMediaTransportTimingParameters.d.ts

@@ -0,0 +1,54 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaMediaTransportTimingParameters {
+  /**
+   * Minimum receive buffer capacity in floating-point seconds
+   * @type number
+   */
+  MinReceiveBufferCapacity: number;
+
+  /**
+   * Maximum receive buffer capacity in floating-point seconds
+   * @type number
+   */
+  MaxReceiveBufferCapacity: number;
+
+  /**
+   * Transmission time variation in floating-point seconds
+   * @type number
+   */
+  TransmissionTimeVariation: number;
+}
+
+export declare class OcaMediaTransportTimingParameters
+  implements IOcaMediaTransportTimingParameters {
+  /**
+   * Media transport application's transport timing parameters
+   * @class OcaMediaTransportTimingParameters
+   */
+  constructor(
+    MinReceiveBufferCapacity: number,
+    MaxReceiveBufferCapacity: number,
+    TransmissionTimeVariation: number
+  );
+
+  /**
+   * Minimum receive buffer capacity in floating-point seconds
+   * @type number
+   */
+  MinReceiveBufferCapacity: number;
+
+  /**
+   * Maximum receive buffer capacity in floating-point seconds
+   * @type number
+   */
+  MaxReceiveBufferCapacity: number;
+
+  /**
+   * Transmission time variation in floating-point seconds
+   * @type number
+   */
+  TransmissionTimeVariation: number;
+}

package/src/types/OcaMediaTransportTimingParameters.js

@@ -0,0 +1,31 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaTransportTimingParameters {
+  /**
+   * Media transport application's transport timing parameters
+   * @class OcaMediaTransportTimingParameters
+   */
+  constructor(
+    MinReceiveBufferCapacity,
+    MaxReceiveBufferCapacity,
+    TransmissionTimeVariation
+  ) {
+    /**
+     * Minimum receive buffer capacity in floating-point seconds
+     * @type number
+     */
+    this.MinReceiveBufferCapacity = MinReceiveBufferCapacity;
+    /**
+     * Maximum receive buffer capacity in floating-point seconds
+     * @type number
+     */
+    this.MaxReceiveBufferCapacity = MaxReceiveBufferCapacity;
+    /**
+     * Transmission time variation in floating-point seconds
+     * @type number
+     */
+    this.TransmissionTimeVariation = TransmissionTimeVariation;
+  }
+}

package/src/types/OcaMediaVolumePosition.d.ts

@@ -0,0 +1,46 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaMediaVolumePositionType,
+  OcaMediaVolumePositionType,
+} from './OcaMediaVolumePositionType';
+
+export declare interface IOcaMediaVolumePosition {
+  /**
+   * What kind of position specification - samples or seconds.
+   * @type OcaMediaVolumePositionType
+   */
+  PositionType: IOcaMediaVolumePositionType;
+
+  /**
+   * Position - sample count or time in floating-point seconds after start of
+   * Media Volume.
+   * @type number|BigInt
+   */
+  Position: number | BigInt;
+}
+
+export declare class OcaMediaVolumePosition implements IOcaMediaVolumePosition {
+  /**
+   * Position within a media volume - samples or seconds.
+   * @class OcaMediaVolumePosition
+   */
+  constructor(
+    PositionType: OcaMediaVolumePositionType,
+    Position: number | BigInt
+  );
+
+  /**
+   * What kind of position specification - samples or seconds.
+   * @type OcaMediaVolumePositionType
+   */
+  PositionType: OcaMediaVolumePositionType;
+
+  /**
+   * Position - sample count or time in floating-point seconds after start of
+   * Media Volume.
+   * @type number|BigInt
+   */
+  Position: number | BigInt;
+}

package/src/types/OcaMediaVolumePosition.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaMediaVolumePosition {
+  /**
+   * Position within a media volume - samples or seconds.
+   * @class OcaMediaVolumePosition
+   */
+  constructor(PositionType, Position) {
+    /**
+     * What kind of position specification - samples or seconds.
+     * @type OcaMediaVolumePositionType
+     */
+    this.PositionType = PositionType;
+    /**
+     * Position - sample count or time in floating-point seconds after start of
+     * Media Volume.
+     * @type number|BigInt
+     */
+    this.Position = Position;
+  }
+}