#include <nvnmos.h>

Collaboration diagram for _NvNmosAnnotation:

Detailed Description

IS-13 annotation applied at create, carried on nmos_annotation_update_callback, or passed to nmos_annotation_update.

At create, NVNMOS_UPDATE_SET writes the property. NVNMOS_UPDATE_UNCHANGED leaves the constructed value in place. NVNMOS_UPDATE_RESET is invalid.

On the callback, NvNmosAnnotation::label and NvNmosAnnotation::description are the effective strings after the merge. NVNMOS_UPDATE_SET means that string was written as the overlay. NVNMOS_UPDATE_RESET means the overlay was cleared and the string is the restored default. NVNMOS_UPDATE_UNCHANGED means the overlay was left alone. NvNmosAnnotation::tags is the writable-tag overlay after the merge. A NvNmosAnnotation::tags_update of NVNMOS_UPDATE_SET means the merge wrote the tags object. A key this merge wrote is NVNMOS_UPDATE_SET. A key this merge left in place is NVNMOS_UPDATE_UNCHANGED. A key this merge cleared is absent. A NvNmosAnnotation::tags_update of NVNMOS_UPDATE_RESET means every writable tag was cleared and NvNmosAnnotation::tags is empty. A NvNmosAnnotation::tags_update of NVNMOS_UPDATE_UNCHANGED means the merge left the tags object alone. NvNmosAnnotation::tags still lists the overlay, and each key is NVNMOS_UPDATE_UNCHANGED.

On nmos_annotation_update, only an operation of NVNMOS_UPDATE_SET or NVNMOS_UPDATE_RESET is applied, and a value on an unchanged or reset field is ignored. NvNmosAnnotation::tags lists the keys to update. A tag whose operation is NVNMOS_UPDATE_UNCHANGED is ignored.

Member Data Documentation

const char* _NvNmosAnnotation::description

Holds the description. On the callback this is the effective string. On nmos_annotation_update it is read when description_update is NVNMOS_UPDATE_SET. An empty string is a valid overlay. May be null unless description_update is NVNMOS_UPDATE_SET.

NvNmosUpdate _NvNmosAnnotation::description_update

Whether description is unchanged, written, or cleared.

const char* _NvNmosAnnotation::label

Holds the label. On the callback this is the effective string. On nmos_annotation_update it is read when label_update is NVNMOS_UPDATE_SET. An empty string is a valid overlay. May be null unless label_update is NVNMOS_UPDATE_SET.

NvNmosUpdate _NvNmosAnnotation::label_update

Whether label is unchanged, written, or cleared.

unsigned int _NvNmosAnnotation::num_tags

Holds the number of tags. May be zero.

const NvNmosTag* _NvNmosAnnotation::tags

Holds writable tags. On the callback this is the writable-tag overlay after the merge. At create and on nmos_annotation_update it lists the keys to update and is read when tags_update is NVNMOS_UPDATE_SET. A tag whose operation is NVNMOS_UPDATE_UNCHANGED is not read. The array's size must be equal to num_tags. May be null when num_tags is zero, or when tags_update is not NVNMOS_UPDATE_SET. Must not be null when num_tags is non-zero and tags_update is NVNMOS_UPDATE_SET.

NvNmosUpdate _NvNmosAnnotation::tags_update

Whether tags is unchanged, written, or cleared.

The documentation for this struct was generated from the following file: