Event & Subscription Datatypes

OcaEvent

struct OcaEvent

Representation of an OCA event, i.e. the unique combination of emitter ONo and the EventID.

OcaONo EmitterONo

Object number of the emitter.

OcaEventID EventID

Event ID of the subscribed event.

OCP.1 Encoding

Field	Basic type	Byte length
EmitterONo.ONo	OcaUint32	4
EventID.DefLevel	OcaUint16	2
EventID.EventIndex	OcaUint16	2

OcaMethod

struct OcaMethod

Representation of an OCA method, i.e. the unique combination of an ONo and a MethodID. To denote the absence of a method, all field values shall be zero. Such a value is called the Null Method Identifier .

OcaONo ONo

The object number. For Null Method Identifier, value shall be zero.

OcaMethodID MethodID

The method ID. For Null Method Identifier, value of all subfields shall be zero.

OCP.1 Encoding

Field	Basic type	Byte length
ONo.ONo	OcaUint32	4
MethodID.DefLevel	OcaUint16	2
MethodID.MethodIndex	OcaUint16	2

OcaEventData

using OcaEventData = OcaEvent

Base class for event data. This base class holds the event data that every event notification must contain. When an event has additional properties, these propeties shall be defined in a class defined as a subclass of this base class. The properties of this base class need not be restated in the property list of the subclass, since they will be included by inheritance.

OcaLibVolChangedEventData

struct OcaLibVolChangedEventData

Event data for the OcaLibVolChanged event, which signals a change in an OcaLibrary.Volumes property.

OcaLibVolID VolumeID

ID of library volume that changed.

OcaPropertyChangeType ChangeType

Type of change : Will be either itemChanged, itemAdded, or itemDeleted.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
VolumeID.Value	OcaUint32	4
ChangeType	OcaEnumItem	1

OcaPropertyChangedEventData

template<>
struct OcaPropertyChangedEventData<typename DataType>

Template class that defines the event data parameter for events that return property values, such as the PropertyChanged event defined in OcaRoot , and the PeriodicObservation event define in OcaNumericObserver. The template parameter is the datatype of the changed property.

OcaPropertyID PropertyID

The property ID of the property that has changed.

DataType PropertyValue

New value of property. Type of property value parameter is defined by template parameter DataType. In the case of list and map properties with datatypes such as OcaList, OcaList2D, OcaMap, and OcaMultiMap, the entire list or map shall be returned when any of its elements changes.

OcaPropertyChangeType ChangeType

Type of change : Current value, Min, Max, Item changed, Item added, Item deleted

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
PropertyID.DefLevel	OcaUint16	2
PropertyID.PropertyIndex	OcaUint16	2
PropertyValue	DataType	variable
ChangeType	OcaEnumItem	1

OcaPropertyChangeType

enum OcaPropertyChangeType : uint8_t

Enum describing property change type.

enumerator CurrentChanged = 1

Current value has changed.

enumerator MinChanged = 2

Minimum value has changed.

enumerator MaxChanged = 3

Maximum value has changed.

enumerator ItemAdded = 4

An item has been added to a list or a map property.

enumerator ItemChanged = 5

An item of a list or a map property has been changed.

enumerator ItemDeleted = 6

An item of a list or a map property has been deleted.

OcaMediaConnectorElement

OcaMediaConnectorStatusChangedEventData

struct OcaMediaConnectorStatusChangedEventData

OcaMediaConnectorStatus ConnectorStatus

The status that has changed.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
ConnectorStatus.ConnectorID.Index	OcaUint16	2
ConnectorStatus.State	OcaEnumItem	1
ConnectorStatus.ErrorCode	OcaUint16	2

OcaTaskStateChangedEventData

struct OcaTaskStateChangedEventData

OcaTaskID TaskID

ID of Task

OcaLibVolIdentifier ProgramID

Library volume identifier of Program running in the task at the time of the change, or null

OcaTaskStatus Status

New task status

OCP.1 Encoding

Field	Basic type	Byte length
TaskID.Value	OcaUint32	4
ProgramID.Library.ONo	OcaUint32	4
ProgramID.ID.Value	OcaUint32	4
Status.ID.Value	OcaUint32	4
Status.State	OcaEnumItem	1
Status.ErrorCode	OcaUint16	2

OcaMediaSourceConnectorChangedEventData

struct OcaMediaSourceConnectorChangedEventData

OcaMediaSourceConnector SourceConnector

The media source connector for which the changed event holds (i.e. that is added, deleted or changed).

OcaPropertyChangeType ChangeType

Indicates what type of change occurred. Only ItemAdded, ItemChanged and ItemDeleted can be used in this event data.

OcaMediaConnectorElement ChangedElement

Indicates which element(s) of the connector changed. If the connector is added or deleted, all bits in this bitset shall be set.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
SourceConnector.IDInternal.Index	OcaUint16	2
SourceConnector.IDExternal.Len	OcaUint16	2
SourceConnector.IDExternal.Value	string	variable
SourceConnector.Connection.Secure	OcaBoolean	1
SourceConnector.Connection.StreamParameters.Value.DataSize	OcaUint16	2
SourceConnector.Connection.StreamParameters.Value.Data	OcaUint8	1 * Count
SourceConnector.Connection.StreamCastMode	OcaEnumItem	1
SourceConnector.Connection.StreamChannelCount	OcaUint16	2
SourceConnector.AvailableCodings	OcaList<{OcaUint16, {OcaUint16, string}, OcaUint32}>	(2 + Count * (6 + (2 + variable)))
SourceConnector.PinCount	OcaUint16	2
SourceConnector.ChannelPinMap	OcaMap<OcaUint16, {OcaEnumItem, OcaUint16}>	(2 + 5 * Count)
SourceConnector.AlignmentLevel.Value.Value	OcaFloat32	4
SourceConnector.CurrentCoding.CodingSchemeID.Value	OcaUint16	2
SourceConnector.CurrentCoding.CodecParameters.Len	OcaUint16	2
SourceConnector.CurrentCoding.CodecParameters.Value	string	variable
SourceConnector.CurrentCoding.ClockONo.ONo	OcaUint32	4
ChangeType	OcaEnumItem	1
ChangedElement.PinMap.Value	bit	variable
ChangedElement.Connection.Value	bit	variable
ChangedElement.Coding.Value	bit	variable
ChangedElement.AlignmentLevel.Value	bit	variable
ChangedElement.AlignmentGain.Value	bit	variable

OcaMediaSinkConnectorChangedEventData

struct OcaMediaSinkConnectorChangedEventData

OcaMediaSinkConnector SinkConnector

The media source connector for which the changed event holds (i.e. that is added, deleted or changed).

OcaPropertyChangeType ChangeType

Indicates what type of change occurred. Only ItemAdded, ItemChanged and ItemDeleted can be used in this event data.

OcaMediaConnectorElement ChangedElement

Indicates which element(s) of the connector changed. If the connector is added or deleted, all bits in this bitset shall be set.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
SinkConnector.IDInternal.Index	OcaUint16	2
SinkConnector.IDExternal.Len	OcaUint16	2
SinkConnector.IDExternal.Value	string	variable
SinkConnector.Connection.Secure	OcaBoolean	1
SinkConnector.Connection.StreamParameters.Value.DataSize	OcaUint16	2
SinkConnector.Connection.StreamParameters.Value.Data	OcaUint8	1 * Count
SinkConnector.Connection.StreamCastMode	OcaEnumItem	1
SinkConnector.Connection.StreamChannelCount	OcaUint16	2
SinkConnector.AvailableCodings	OcaList<{OcaUint16, {OcaUint16, string}, OcaUint32}>	(2 + Count * (6 + (2 + variable)))
SinkConnector.PinCount	OcaUint16	2
SinkConnector.ChannelPinMap	OcaMultiMap<OcaUint16, {OcaEnumItem, OcaUint16}>	(2 + 5 * Count)
SinkConnector.AlignmentLevel.Value.Value	OcaFloat32	4
SinkConnector.AlignmentGain.Value	OcaFloat32	4
SinkConnector.CurrentCoding.CodingSchemeID.Value	OcaUint16	2
SinkConnector.CurrentCoding.CodecParameters.Len	OcaUint16	2
SinkConnector.CurrentCoding.CodecParameters.Value	string	variable
SinkConnector.CurrentCoding.ClockONo.ONo	OcaUint32	4
ChangeType	OcaEnumItem	1
ChangedElement.PinMap.Value	bit	variable
ChangedElement.Connection.Value	bit	variable
ChangedElement.Coding.Value	bit	variable
ChangedElement.AlignmentLevel.Value	bit	variable
ChangedElement.AlignmentGain.Value	bit	variable

OcaObjectListEventData

struct OcaObjectListEventData

Event data for events returning object lists, for example the SynchronizeState event defined in OcaSubscriptionManager.

OcaList<OcaONo> objectList

List of object numbers.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
objectList	OcaList<OcaUint32>	(2 + 4 * Count)

OcaObservationEventData

struct OcaObservationEventData

Event data for event OcaNumericObserver.Observation . Note: due to an error in AES70-2015, this class was not made a subclass of OcaEventData . Therefore, this class explicitly defines the Event property explicitly, rather than inheriting it from OcaEventData, as other event data classes do. However, the effect is the same as for all event data classes: the first property in the data structure is an OcaEvent value.

OcaEvent Event

The event that was raised. This field is not normally part of event data datatypes and was erroneously included this one; it is now retained for forward compatibility.

OcaFloat64 Reading

The observed value that the event is reporting.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
Reading	OcaFloat64	8

OcaObservationListEventData

struct OcaObservationListEventData

Event data for event OcaNumericObserverList.Observation . Note: due to an error in AES70-2015, this class was not made a subclass of OcaEventData . Therefore, this class explicitly defines the Event property explicitly, rather than inheriting it from OcaEventData, as other event data classes do. However, the effect is the same as for all event data classes: the first property in the data structure is an OcaEvent value.

OcaEvent Event

The event that was raised. This field is not normally part of event data datatypes and was erroneously included this one; it is now retained for forward compatibility.

OcaList<OcaFloat64> Reading

The list of observed values that the event is reporting.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
Reading	OcaList<OcaFloat64>	(2 + 8 * Count)

OcaGrouperStatusChangeType

enum OcaGrouperStatusChangeType : uint8_t

Enum describing status change types, as used in OcaGrouper’s StatusChange event.

enumerator citizenAdded = 1

New citizen has been added to the Grouper and is now in the online state.

enumerator citizenDeleted = 2

A citizen has been deleted from the Grouper.

enumerator citizenConnectionLost = 3

Previously online citizen has lost its connection with the grouper and is now in the offline state.

enumerator citizenConnectionReEstablished = 4

Previously offline citizen has lost its connection with the grouper and is now in the online state.

enumerator citizenError = 5

A citizen has failed to execute a requested parameter change.

enumerator enrollment = 6

A citizen has enrolled in a group, and is now a member of that group.

enumerator unEnrollment = 7

A member has been removed from a group.

OcaGrouperStatusChangeEventData

struct OcaGrouperStatusChangeEventData

Class that defines the event data parameter for the StatusChange event defined in OcaGrouper .

OcaUint16 groupIndex

Index of relevant group, or zero if event is non-group-specific.

OcaUint16 citizenIndex

Index of citizen within given grouper, or zero if event is non-citizen-specific.

OcaGrouperStatusChangeType changeType

Type of change.

OCP.1 Encoding

Field	Basic type	Byte length
Event.EmitterONo.ONo	OcaUint32	4
Event.EventID.DefLevel	OcaUint16	2
Event.EventID.EventIndex	OcaUint16	2
groupIndex	OcaUint16	2
citizenIndex	OcaUint16	2
changeType	OcaEnumItem	1

OcaNotificationDeliveryMode

enum OcaNotificationDeliveryMode : uint8_t

Enum for subscriptions that specifies whether its notification messages are to be delivered by reliable means (e.g. TCP) or fast means (e.g. UDP).

enumerator Reliable = 1

Reliable delivery mode, e.g. TCP.

enumerator Fast = 2

Fast delivery mode, e.g. UDP.

OcaSubscriptionManagerState

enum OcaSubscriptionManagerState : uint8_t

Enum describing OcaSubscriptionManager states.

enumerator Normal = 1

enumerator EventsDisabled = 2

Events are disabled.