Skip to main content
Header: spf/api/modules/metadata_api.h

Structures

metadata_tracking_event_t

Payload for Metadata tracking event. Members
uint32_t
Globally Unique ID of the metadata.
uint32_t
Specifies the source module of the metadata.
uint32_t
Specifies the module instance ID of the module which is raising the event when MD is consumed/dropped.
uint32_t
Specifies the control flags for the metadata event.
uint32_t
uint32_t
Specifies the LSW of the unique token.
uint32_t
Specifies the MSW of the unique token.

Type Definitions

metadata_header_t

metadata_tracking_event_t

Macros

MODULE_CMN_MD_ID_EOS

MD_HEADER_FLAGS_BIT_MASK_CLIENT_INFO

Metadata API to support the requirement of exchanging the metadata between the client and SPF.

MD_HEADER_FLAGS_SHIFT_CLIENT_INFO

Definition of a metadata client information flag shift value.

MD_HEADER_FLAGS_BIT_MASK_TRACKING_CONFIG

Definition of a metadata tracking configuration bitmask.

MD_HEADER_FLAGS_SHIFT_TRACKING_CONFIG_FLAG

Definition of a metadata tracking configuration shift value.

MD_HEADER_FLAGS_BIT_MASK_TRACKING_EVENT_POLICY

Definition of a metadata tracking event policy flag bitmask.

MD_HEADER_FLAGS_SHIFT_TRACKING_EVENT_POLICY_FLAG

Definition of a metadata tracking event policy flag shift value.

MD_HEADER_FLAGS_BIT_MASK_ASSOCIATION

Definition of a metadata association with data bitmask.

MD_HEADER_FLAGS_SHIFT_ASSOCIATION_FLAG

Definition of a metadata association with data flag shift value.

MD_HEADER_FLAGS_CLIENT_EXTERNAL

Definition of a external client of SPF.

MD_HEADER_FLAGS_CLIENT_INERTNAL

Definition of a internal client of SPF.

MD_HEADER_FLAGS_TRACKING_CONFIG_DISABLE

Definition of a metadata tracking configuration disable.

MD_HEADER_FLAGS_TRACKING_CONFIG_ENABLE_FOR_DROPS_ONLY

Definition of a metadata tracking configuration to enable for md drops only.

MD_HEADER_FLAGS_TRACKING_CONFIG_ENABLE_FOR_DROP_OR_CONSUME

Definition of a metadata tracking configuration to enable for md drop or consume.

MD_HEADER_FLAGS_TRACKING_EVENT_POLICY_LAST

Definition of a metadata tracking event policy last.

MD_HEADER_FLAGS_TRACKING_EVENT_POLICY_EACH

Definition of a metadata tracking event policy last.

MD_HEADER_FLAGS_SAMPLE_ASSOCIATED

Definition of a metadata sample association .

MD_HEADER_FLAGS_BUFFER_ASSOCIATED

Definition of a metadata sample association .

MD_TRACKING_FLAGS_BIT_MASK_LAST_INSTANCE

Definition of a metadata last instance flag bitmask.

MD_TRACKING_FLAGS_IS_LAST_INSTANCE_FLAG

Definition of a metadata last instance flag shift value.

MD_TRACKING_STATUS_IS_CONSUMED

tracking status of the metadata when the meta-data is consumed.

MD_TRACKING_STATUS_IS_DROPPED

tracking status of the metadata when the meta-data is dropped.

EVENT_ID_MODULE_CMN_METADATA_TRACKING_EVENT

The metadata event is raised if the metadata is set as tracking metadata.

MODULE_CMN_MD_ID_MEDIA_FORMAT

Metadata ID to specify the Media format Media format as metadata is propagated by the endpoint module in SPF to the client.