aes70/src/types/OcaMediaConnection.d.ts

A controller library for the AES70 protocol.

/*
 * This file has been generated.
 */
import {
  IOcaMediaStreamCastMode,
  OcaMediaStreamCastMode,
} from './OcaMediaStreamCastMode';

export declare interface IOcaMediaConnection {
  /**
   * True iff connection is secure.
   * @type boolean
   */
  Secure: boolean;

  /**
   * Stream parameters (encoding, sampling, etc). Format is media network type
   * dependent.
   * @type Uint8Array
   */
  StreamParameters: Uint8Array;

  /**
   * Unicast or multicast
   * @type OcaMediaStreamCastMode
   */
  StreamCastMode: IOcaMediaStreamCastMode;

  /**
   * Number of channels in connected stream
   * @type number
   */
  StreamChannelCount: number;
}

export declare class OcaMediaConnection implements IOcaMediaConnection {
  /**
   * A single-channel or multichannel connection between a local media connector
   * (i.e. **OcaMedia(Source/Sink)Connector** instance) of an
   * **OcaMediaTransportNetwork** object in this node and another ("remote")
   * media source or sink. Normally, the remote source or sink is in another
   * node. The remote end may or may not be an OCA-compliant device. A
   * connection is unidirectional. Its direction is determined by the connector
   * that owns the connection. Its direction is either:
   *
   *  - *Outbound: * A signal flow from a **source** connector to an external
   *    destination; or
   *
   *  - *Inbound: * A signal flow from an external source to a **sink**
   *    connector.
   *
   *
   * An **OcaMediaConnection** object may represent a connection to either a
   * unicast or a multicast stream. Any given **OcaMedia(Source/Sink)Connector**
   * object will only have one media connection. In non-OCA documents,
   * connections are sometimes referred to as *streams* or *flows.*
   * @class OcaMediaConnection
   */
  constructor(
    Secure: boolean,
    StreamParameters: Uint8Array,
    StreamCastMode: OcaMediaStreamCastMode,
    StreamChannelCount: number
  );

  /**
   * True iff connection is secure.
   * @type boolean
   */
  Secure: boolean;

  /**
   * Stream parameters (encoding, sampling, etc). Format is media network type
   * dependent.
   * @type Uint8Array
   */
  StreamParameters: Uint8Array;

  /**
   * Unicast or multicast
   * @type OcaMediaStreamCastMode
   */
  StreamCastMode: OcaMediaStreamCastMode;

  /**
   * Number of channels in connected stream
   * @type number
   */
  StreamChannelCount: number;
}