@contentauth/c2pa-js
    Preparing search index...

    Interface RegionOfInterest

    A region of interest within an asset describing the change.

    This struct can be used from [Action::changes][crate::assertions::Action::changes], [AssertionMetadata::region_of_interest][crate::assertions::AssertionMetadata::region_of_interest], or [SoftBindingScope::region][crate::assertions::soft_binding::SoftBindingScope::region].

    interface RegionOfInterest {
        description?: null | string;
        identifier?: null | string;
        metadata?: null | AssertionMetadata;
        name?: null | string;
        region: Range[];
        role?: null | Role;
        type?: null | string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    description? identifier? metadata? name? region role? type?

    Properties

    description?: null | string

    A free-text string.

    identifier?: null | string

    A free-text string representing a machine-readable, unique to this assertion, identifier for the region.

    metadata?: null | AssertionMetadata

    Additional information about the asset.

    name?: null | string

    A free-text string representing a human-readable name for the region which might be used in a user interface.

    region: Range[]

    A range describing the region of interest for the specific asset.

    role?: null | Role

    A value from our controlled vocabulary or an entity-specific value (e.g., com.litware.coolArea) that represents the role of a region among other regions.

    type?: null | string

    A value from a controlled vocabulary such as https://cv.iptc.org/newscodes/imageregiontype/ or an entity-specific value (e.g., com.litware.newType) that represents the type of thing(s) depicted by a region.

    Note this field serializes/deserializes into the name type.

    Settings

    Member Visibility

    On This Page

    Properties