OcaBlock

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaWorker().

This class defines the properties

Name

JavaScript Type

AES70 Type

Type

number

OcaONo

Members

OcaObjectIdentification[]

OcaList<OcaObjectIdentification>

SignalPaths

Map<number, OcaSignalPath>

OcaMap<OcaUint16, OcaSignalPath>

MostRecentParamSetIdentifier

OcaLibVolIdentifier

OcaLibVolIdentifier

GlobalType

OcaGlobalTypeIdentifier

OcaGlobalTypeIdentifier

ONoMap

Map<number, number>

OcaMap<OcaProtoONo, OcaONo>

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Type, Members, SignalPaths, MostRecentParamSetIdentifier, GlobalType and ONoMap.

class OcaBlock(objectNumber, device)

A block is an object with three aspects: - It can contain other blocks. - It can contain workers. - It can contain agents. - It can contain data networks. - It can contain application networks. - It has a signal flow topology. We refer to an object inside a block as a member of that block. We refer to the block which contains an object as the object’s container. 1 Normally, a block contains a set of members that together function as a processing unit – for example, a crossover channel or mixer strip.

OcaBlock.OnMembersChanged

type: PropertyEvent.<Array.<OcaObjectIdentification>>

This event is emitted when the property Members changes in the remote object. The property Members is described in the AES70 standard as follows. List of members in the block.

OcaBlock.OnMostRecentParamSetIdentifierChanged

type: PropertyEvent.<OcaLibVolIdentifier>

This event is emitted when the property MostRecentParamSetIdentifier changes in the remote object. The property MostRecentParamSetIdentifier is described in the AES70 standard as follows. Library volume identifier of the paramset most recently applied to this block.

OcaBlock.OnSignalPathsChanged

type: PropertyEvent.<Map.<number, OcaSignalPath>>

This event is emitted when the property SignalPaths changes in the remote object. The property SignalPaths is described in the AES70 standard as follows. List of signal paths in the block.

OcaBlock.AddSignalPath(Path)

Adds a signal path to the block. The return value indicates whether the signal path was successfully added.

Arguments
Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaBlock.ApplyParamSet()

Applies the referenced paramset to this block, and sets the MostRecentParamSet property. The return value indicates whether the paramset was successfully applied.

Returns

Promise.<OcaLibVolIdentifier> – A promise which resolves to a single value of type OcaLibVolIdentifier().

OcaBlock.ConstructMember(ClassID, ConstructionParameters)

Constructs an object according to the given construction specification and adds it to the block. The return value indicates whether the member was successfully created and added.

Arguments

  • ClassID (OcaClassID) –

  • ConstructionParameters (variant) –

Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaBlock.ConstructMemberUsingFactory(FactoryONo)

Invokes a factory to construct an instance of the given class, then adds it to the block. The return value indicates whether the member was successfully created and added.

Arguments

  • FactoryONo (number) –

Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaBlock.DeleteMember(ObjectNumber)

Removes a member from the block and destroys the object. . Deletes all signal paths attached to its ports. The return value indicates whether the member was successfully removed and destroyed.

Arguments

  • ObjectNumber (number) –

Returns

Promise.<void> –

OcaBlock.DeleteSignalPath(Index)

Deletes a signal path from the block. The return value indicates whether the signal path was successfully added.

Arguments

  • Index (number) –

Returns

Promise.<void> –

OcaBlock.FindObjectsByLabelRecursive(SearchName, NameComparisonType, SearchClassID, ResultFlags)

Returns block member descriptors of all objects in the block and all contained blocks that match the given Label search string and Class ID. Added in version 2 of this class.

Arguments
Returns

Promise.<Array.<OcaObjectSearchResult>> – A promise which resolves to a single value of type OcaObjectSearchResult[].

OcaBlock.FindObjectsByPath(SearchPath, ResultFlags)

Returns object identifications of all objects with the given name path. Added in version 2 of this class.

Arguments
Returns

Promise.<Array.<OcaObjectSearchResult>> – A promise which resolves to a single value of type OcaObjectSearchResult[].

OcaBlock.FindObjectsByRole(SearchName, NameComparisonType, SearchClassID, ResultFlags)

Returns object identifications of all objects in the block that match the given Role search string and Class ID. Return value indicates whether the method succeeded. Added in version 2 of this class.

Arguments
Returns

Promise.<Array.<OcaObjectSearchResult>> – A promise which resolves to a single value of type OcaObjectSearchResult[].

OcaBlock.FindObjectsByRoleRecursive(SearchName, NameComparisonType, SearchClassID, ResultFlags)

Returns block member descriptors of all objects in the block and all contained blocks that match the given Role search string and Class ID. Added in version 2 of this class.

Arguments
Returns

Promise.<Array.<OcaObjectSearchResult>> – A promise which resolves to a single value of type OcaObjectSearchResult[].

OcaBlock.GetCurrentParamSetData()

Returns a paramset library volume data block which represents the current state of the block – i.e. a “snapshot”.

Returns

Promise.<OcaLibVolData_ParamSet> – A promise which resolves to a single value of type OcaLibVolData_ParamSet().

OcaBlock.GetGlobalType()

Gets the global blocktype. The return value indicates whether the type was successfully retrieved. If this block has no global blocktype, the Authority field of the returned GlobalType parameter will be zero. Added in version 2 of this class.

Returns

Promise.<OcaGlobalTypeIdentifier> – A promise which resolves to a single value of type OcaGlobalTypeIdentifier().

OcaBlock.GetMembers()

Gets the list of block members. Does not recurse inner blocks. Each inner block is included in the returned list as a single object – its contents are not enumerated. The return value indicates whether the list was successfully retrieved.

Returns

Promise.<Array.<OcaObjectIdentification>> – A promise which resolves to a single value of type OcaObjectIdentification[].

OcaBlock.GetMembersRecursive()

Gets the list of block members. Recurses inner blocks. Each inner block is included in the returned list as a single object, amd its contents are enumerated. The return value indicates whether the list was successfully retrieved.

Returns

Promise.<Array.<OcaBlockMember>> – A promise which resolves to a single value of type OcaBlockMember[].

OcaBlock.GetMostRecentParamSetIdentifier()

Gets the identifier of the paramset most recently applied to this block.

Returns

Promise.<OcaLibVolIdentifier> – A promise which resolves to a single value of type OcaLibVolIdentifier().

OcaBlock.GetONoMap()

Gets the block’s ONo map. The return value indicates whether the map was successfully retrieved. Added in version 2 of this class.

Returns

Promise.<Map.<number, number>> – A promise which resolves to a single value of type Map<number, number>.

OcaBlock.GetSignalPaths()

Gets the map of signal paths in the block. Does not recurse inner blocks. The return value indicates whether the list was successfully retrieved.

Returns

Promise.<Map.<number, OcaSignalPath>> – A promise which resolves to a single value of type Map<number, OcaSignalPath>.

OcaBlock.GetSignalPathsRecursive()

Gets the mapof signal paths in the block. Recurses inner blocks. The return value indicates whether the list was successfully retrieved.

Returns

Promise.<Map.<number, OcaSignalPath>> – A promise which resolves to a single value of type Map<number, OcaSignalPath>.

OcaBlock.GetType()

Gets the block type. For statically-defined blocks, the block type is a Uint32 with a value corresponding to the unique configuration of this block. For dynamically-defined blocks, the block type is the object number of the block’s factory. For the root block, the value of this property is 1.

Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaBlock.StoreCurrentParamSetData(LibVolIdentifier)

Stores a paramset library volume data block which represents the current state of the block (“snapshot”) in the given library. Replaces the library volume at the specified LibVolIdentifier.

Arguments
Returns

Promise.<void> –