1. Introduction
This document is designed to familiarise developers, architects and video makers with the IPTC Video Metadata Hub, a mapping of key fields between commonly-used video formats. It provides a short guideline on the use and meaning of each "field" or "property" in the IPTC Video Metadata Hub.
1.1. What IPTC Video Metadata Hub is For
IPTC’s Video Metadata Hub is a universal metadata schema for video developed with the key goal of storing and exchanging metadata in a safe and reliable way.
It is not a new video metadata standard, in the sense that it does not define any new fields that are not already defined in other formats.
Instead, it defines a common set of video metadata fields, giving precise semantics — so we will know exactly what we mean by "Contributor" or "Creator" — and shows how each of those common fields can be used in existing video standards such as EBUCore, PBCore, IPTC Photo Metadata Standard, Apple Quicktime, MPEG7, Panasonic P2 and Sony XDCAM.
These properties can be used for describing the visible and audible content, rights and licensing information, administrative details and technical characteristics of a video in a system-independent way.
It’s like Dublin Core, but for video metadata.
1.2. What problem are we solving?
Metadata is stored in different ways in existing video formats. For video editors it is very difficult to move video metadata between systems and the semantics are not always clear.
For example, location information can be described in various existing video metadata formats as:
-
location
withrole=0
in QuickTime -
Creation/location
in MPEG7 -
located
in NewsML-G2 -
locationCreated
in schema.org -
Shoot/Location
in SMPTE P2
IPTC Video Metadata Hub describes two fields, Location Shot and Location Shown, with very clearly defined semantics, and the fields are mapped to fields of existing video formats, so metadata can be moved between systems from different vendors.
1.3. Using Video Metadata Hub with your video content
The way in which Video Metadata Hub fields are associated with your video content will vary depending on the workflows and technical video structures used in your organisation.
Typically users will choose one of three mechanisms for expressing Video Metadata Hub properties for their content:
- Sidecar files
-
Some organisations will choose to associate metadata in so-called "sidecar files", in a format such as JSON, NewsML-G2 or as an XML component in an IMF package. We have created a JSON Schema for IPTC Video Metadata Hub which makes this easy to do.
- Embedded metadata
-
Other organisations will embed metadata into the video file, using a structure such as an XMP metadata packet in a UUID box in an ISO Base Media File Format (ISOBMFF) or Quicktime file.
- External database
-
A third option is to simply use Video Metadata Hub properties in a database schema describing metadata in a Digital Asset Management system.
2. About the IPTC Video Metadata User Guide
2.1. IPTC Video Metadata Hub version used by this User Guide
This document is based on the IPTC Video Metadata Hub version 1.3 which was approved in May 2020. The specification for Video Metadata Hub is separated into two parts: IPTC Video Metadata Hub properties and IPTC Video Metadata Hub mappings showing how to apply these core properties in many existing video standards.
Examples, information and the specification document can be obtained from https://iptc.org/std/videometadatahub/
2.2. Copyright
Copyright © 2021 IPTC, International Press Telecommunications Council. Rights Reserved.
The IPTC Video Metadata User Guide document is published under the Creative Commons Attribution 4.0 license - see the full license agreement at http://creativecommons.org/licenses/by/4.0/.
By obtaining, using and/or copying this document, you (the licensee) agree that you have read, understood, and will comply with the terms and conditions of the license.
Materials used in this guide are either in the public domain or are available with the permission of their respective copyright holders. All materials of this IPTC standard covered by copyright shall be licensable at no charge.
2.3. Acknowledgements
This document is the result of a team effort by members of the Video Metadata Working Group of the International Press Telecommunications Council (IPTC), with input and assistance from other contributors.
The User Guide up to this version was edited by (in alphabetical order):
Linda Burman (Individual IPTC member), Derek Coller (Getty Images), Pam Fisher (Individual Member and lead of the IPTC Video Metadata Working Group), Mark Milstein (Microstocksolutions) Brendan Quinn (IPTC), David Riecks (www.controlledvocabulary.com/PLUS), Michael Steidl (Honorary IPTC member), Alison Sullivan (Individual Member).
2.4. How to contact IPTC
Join the public IPTC Video Metadata group: https://groups.io/g/iptc-videometadata/
Submit a message on our website: https://iptc.org/about-iptc/contact-us/
Visit IPTC’s website: https://iptc.org/standards/video-metadata-hub/
Follow IPTC on Twitter: @IPTC
2.5. About IPTC
The IPTC, based in London, brings together the world’s leading news agencies, publishers and industry vendors. It develops and promotes efficient technical standards to improve the management and exchange of information between content providers, intermediaries and consumers. The standards enable easy, cost-effective and rapid innovation and include the Photo Metadata standard, the Video Metadata Hub, the news exchange formats NewsML-G2, ninjs, SportsML-G2 and NITF, rNews for marking up online news, the rights expression language RightsML, and NewsCodes taxonomies for categorising news.
IPTC is a not-for-profit membership organisation registered in England - find more about membership.
Business address:
IPTC International Press Telecommunications Council 25 Southampton Buildings London WC2A 1AL United Kingdom
3. Use Cases for Video Metadata Hub
The Video Metadata Hub aims to provide a comprehensive set of properties, however specific applications may not require each of these.
To make Video Metadata Hub easier to understand, a set of six initial use cases has been outlined, each typically requiring only a subset of VMH properties:
- Enterprise Advertising Production
-
Non-broadcast corporate marketing video assets
- Galleries, Libraries, Archives, Museums (GLAM)
-
Moving image material held by cultural institutions, for preservation, exhibition or reference
- Stock Footage
-
Individual film/video footage clips from production or archive, made available for licensing or repurposing
- Long-form Production
-
Finished programming ready for broadcast playout or OTT delivery. (Note that the example video for long-form production will be added to this guide in the future)
- Broadcast Media Management
-
Broadcast asset management for repository and archive. (Note that the example video for Broadcast Media Management will be added to this guide in the future)
- News Agency
-
Individual video news item distributed or published by a news agency
For each of these use cases, we provide an example video below, showing the Video Metadata Hub fields that would apply to that use case in particular.
3.1. Enterprise Advertising Production example
Thanks to Allison Sullivan of MGM Resorts for providing the example footage:
3.1.1. Administrative fields
Property name | Example value |
---|---|
2020-04-28 |
|
2021-01-21 |
|
2020-12-10 |
|
MGM Resorts International Operations Inc. |
|
106271516 |
|
v.2 |
3.1.2. Fields describing audio/visual content
Property name | Example value |
---|---|
Video; Fountains of Bellagio; Attractions; Entertainment & Attractions; Fountains; Drone; Drone Footage; Night; Exterior; Aerial; Architecture; Drone Footage - Night; Aerial View; Aircraft Point of View; Building - Exterior |
|
Bellagio, Las Vegas |
|
Bellagio, Las Vegas |
|
Fountains of Bellagio |
|
Aerial, exterior, night |
|
BEL106271516 |
|
Color |
3.1.3. Rights fields
Property name | Example value |
---|---|
Mark Ott |
|
MGM Resorts International Operations Inc. |
|
2020 |
|
Mark Ott |
|
Mark Ott, 808 Post |
|
MGM Resorts International Operations Inc. |
|
MGM Resorts International Operations Inc. |
|
808 Post |
|
Mark Ott |
3.2. Galleries, Libraries, Archives, Museums example
3.2.1. Administrative fields
Property name | Example value |
---|---|
1990s |
|
No |
|
Wellcome Library |
|
Yes |
|
b16766246 |
3.2.2. Fields describing audio/visual content
Property name | Example value |
---|---|
Public health |
|
A television advertisement asking people to register for a Donor Card in order to donate organs after death. |
|
Public information |
|
A television advertisement asking people to register for a Donor Card in order to donate organs after death. |
|
Organ procurement, Public health, Medical sciences, Organ transplantation, Health education, Health policy, Health services |
|
En |
|
Donor card gift (commercial). |
3.2.3. Rights fields
Property name | Example value |
---|---|
This video was made from material preserved by the BFI National Archive. |
|
Crown copyright, managed by BFI; CC-BY-NC |
|
This video was made from material preserved by the BFI National Archive. |
|
Wellcome Library |
|
Wellcome Library |
|
Wellcome Library |
3.3. Stock Footage example
Thanks to Mark Milstein of Microstocksolutions for providing the example footage:
3.3.1. Administrative fields
Property name | Example value |
---|---|
2020-09-18 |
|
2020-09-18 |
|
2020-09-18 |
|
Mark Milstein |
|
2020-10-21 |
|
IPTC VM Working Group |
|
Mark Milstein |
|
IPTC VM Working Group Authentication Process |
|
Panasonic HC-X1 Camera |
|
VRMETA_101010 |
|
Drone footage |
|
From: 2020 To: 2020 |
|
VRMETA_100000 |
3.3.2. Fields describing audio/visual content
Property name | Example value |
---|---|
An aerial view of the Budapest Container Port |
|
container port, Budapest, Hungary, railroad, trucking, transportation, logistics, aerial view |
|
Budapest |
|
Budapest |
|
Container port |
|
Aerial, long shot |
|
An aerial view of the Budapest Container Port |
3.3.3. Rights fields
Property name | Example value |
---|---|
Copyright VRMETA |
|
2020 |
|
Mark Millstein |
|
VRMETA |
|
VRMETA |
3.4. News Agency example
3.4.1. Administrative fields
Property name | Example value |
---|---|
1961-05-25 |
|
1961-05-25 |
|
NASA Video |
|
NASA |
3.4.2. Fields describing audio/visual content
Property name | Example value |
---|---|
In an address to Congress on "Urgent National Needs" on May 25, 1961, President John F. Kennedy called for America to send astronauts to the moon and return him safely to Earth before the end of the decade. |
|
NASA, US Government |
|
News |
|
A President Issues NASA’s First Historic Challenge |
|
EN |
|
Washington DC |
|
President John F Kennedy |
|
President John F Kennedy |
3.4.3. Rights fields
Property name | Example value |
---|---|
NASA |
|
1961 |
|
NASA |
|
NASA; public domain |
4. Properties and Mappings for video metadata
The Video Metadata Hub’s set of metadata properties includes:
-
23 properties describing what can be seen and heard in the video
-
14 properties providing rights-related information
-
22 properties for administrative purposes
-
26 properties covering technical characteristics
-
15 property structures which are used for the properties listed above.
Each property is defined by:
-
its name
-
a definition of its semantics
-
a basic data type
-
a definition how often it may occur in the metadata about a piece of video (its "cardinality")
The properties are defined in detail in the Property Reference Table below.
Each property can be used to describe a clip within a video or the video as a whole.
Below the property table we describe how these properties can be mapped to many existing video structures using our mapping table.
5. Property Reference Table
This section provides a reference of property labels and names in alphabetical order for quick location of specific fields and their guidelines.
Each property has a data type such as Text or Date. Where the property requires a more complex structure such as Location Structure, it is hyperlinked to the below section which defines the properties that make up each property structure.
5.1. Administrative fields
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
Approximate date or range of dates associated with the creation and production of a video.
|
Text (0..1) |
New 1.0 |
|||
Date and optionally time when the video was created
|
Date (0..1) |
New 1.0 |
|||
Date and optionally time when the video was modified last time |
Date (0..1) |
New 1.0 |
|||
Date and optionally time of the public release of the video |
Date (0..1) (Year only, Year-Month only, Year-Month-Day optional with time) |
Changed 1.3 |
|||
Episode in a specific season of a TV or video series this video is a member of. |
Episode/Season Structure (0..1) |
New 1.0 |
|||
Link(s) to an external web resource for retrieval of further metadata about this video |
URL (0..unbounded) |
New 1.0 |
|||
Identifier of the feed/source this video was delivered by |
Text (0..1) |
New 1.0 |
|||
Date of the last edit of the metadata of this video. |
Date(0..1) |
New 1.3 |
|||
Party doing the last edit of the metadata of this video. |
Entity Structure (0..1) |
New 1.3 |
|||
Party responsible for the accuracy of the metadata values. |
Entity Structure (0..1) |
New 1.3 |
|||
Reference to a data item used for planning the shooting of this video |
Entity with role Structure (0..unbounded) |
New 1.2 |
|||
Date and optionally the time of publishing this video with name and identifier for the event of this publication. |
Publication Event Structure (0..unbounded) |
New 1.0 |
|||
How the video is rated by a public source or an authority |
Rating Structure (0..unbounded) |
New 1.0 |
|||
An indicator if this video is ready for being released to the public. This depends on rules by the party responsible for the publication. |
Boolean (0..1) |
New 1.0 |
|||
Device used for recording this video |
Device Structure (0..1) |
New 1.2 |
|||
Identifier of the video issued by an identified registry.
|
Registry Entry Structure (0..unbounded) |
New 1.0 |
|||
Season of a TV or video series this video is a member of. |
Episode/Season Structure (0..1) |
New 1.0 |
|||
TV or video series this video is a member of. |
Series Structure (0..1) |
New 1.0 |
|||
Identifier(s) of a story evolving over time with which this video is associated |
Text (0..unbounded) |
New 1.0 |
|||
The style, historical or artistic period, movement, group, or school whose characteristics are represented by the video
|
Text (0..1) |
New 1.0 |
|||
Period of time covered by the video
|
Temporal Coverage Structure (0..1) |
New 1.0 |
|||
Globally unambiguous identifier of the video from which this video was derived.
|
Text/URI (0..1) |
New 1.3 |
|||
Globally unambiguous identifier of the video regardless of renditions, formats, encodings etc. This identifier should be shared across all renditions.
|
Text (0..1) |
New 1.0 |
|||
Unambiguous identifier of the video specific to a rendition.
|
Text (0..1) |
New 1.0 |
|||
Version of the video identified by the Video Identifier |
Text (0..1) |
New 1.0 |
|||
Indicator for the role of this video in a production workflow.
|
Concept Structure (0..1) |
New 1.0 |
5.2. Fields describing audio/visual content
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
What the video is about expressed by term(s) selected from taxonomies or controlled vocabularies |
Concept Structure (0..unbounded) |
New 1.0 |
|||
Text or other data shown in some region of the image. |
Text with Region Delimiter Structure (0..unbounded) |
New 1.0 |
|||
Textual description of the content of the video |
Text + language tag (0..1) |
New 1.0 |
|||
Shotlist with descriptions |
Text + language tag (0..1) |
New 1.0 |
|||
Link(s) to an external web resource providing a shotlist with descriptions |
Qualified Link Structure (0..unbounded) |
New 1.0 |
|||
Organisation(s) featured by the content of the video |
Entity Structure (0..unbounded) |
New 1.0 |
|||
Artistic, style, journalistic, product or other genre(s) of the video. |
CV-Term Structure (0..unbounded) |
New 1.0 |
|||
Short description of the content of the video |
Text + language tag (0..1) |
New 1.0 |
|||
What the video is about expressed by a free choice of descriptive phrases or keywords |
Text (0..unbounded) optional language tag |
New 1.0 |
|||
Language version of the video |
Language tag (0..1) |
New 1.0 |
|||
Place from where the video was shot, in particular where the camera was located
|
Location Structure (0..unbounded) |
New 1.0 |
|||
Place(s) shown by the video |
Location Structure (0..unbounded) |
New 1.0 |
|||
Object(s) shown by the video |
Entity Structure (0..unbounded) |
New 1.0 |
|||
Person(s) who can be heard only in the video |
Entity Structure (0..unbounded) |
New 1.0 |
|||
Person(s) shown by the video |
Entity Structure or Person Details Structure (0..unbounded) |
New 1.0 |
|||
Product(s) identified by a GTIN code shown by the video |
Product with GTIN Structure (0..unbounded) |
New 1.0 |
|||
Visual type(s) of the video |
Concept Structure (0..unbounded) |
New 1.0 |
|||
Event(s) shown by the video |
Entity Structure (0..unbounded) |
New 1.0 |
|||
A still image representing the video. |
Linked Image Structure (0..unbounded) |
New 1.1 |
|||
Title of the video, should be a shorthand reference |
Text (0..1) |
New 1.0 |
|||
Transcription of the video |
Text (0..1) |
New 1.0 |
|||
Link(s) to an external web resource providing a transcription of the video |
Qualified Link Structure (0..unbounded) |
New 1.0 |
|||
The visual colouring of the video.
|
Text (0..1) Enumeration: - black and white/monochrome - colour |
New 1.0 |
5.3. Rights fields
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
Party or parties (person or organisation) which contributed to the video, refinement by the role attribute.
|
Entity with role Structure (0..unbounded) |
New 1.0 |
|||
Any textual notice necessary by legal needs or common use to indicate the current owner of the copyright of this media resource |
Text + language tag (0..1) |
New 1.0 |
|||
Year appearing in the copyright notice as numeric value |
Number/integer (0..1) |
New 1.0 |
|||
Party or parties (person or organisation) which created the video, refinement by the role attribute.
|
Entity with role Structure (0..unbounded) |
New 1.0 |
|||
Credit to person(s) and/or organisation(s) required by the supplier of the video (clip) to be used when published. |
Text (0..1) |
New 1.0 |
|||
Company or person to be contacted for licensing |
Entity Structure (0..1) |
New 1.0 |
|||
Identifier(s) of a Model Release document. |
Text (0..unbounded) |
New 1.0 |
|||
Summarises the availability and scope of model releases authorizing usage of the likenesses of persons appearing in the video |
PLUS CV Term/URI |
New 1.0 |
|||
Identifier(s) of a Property Release document. |
Text (0..unbounded) |
New 1.0 |
|||
Summarises the availability and scope of property releases authorising usage of the properties appearing in the photograph. |
PLUS CV Term/URI |
New 1.0 |
|||
Structure covering the assertion of rights, the granting of licenses and both in human and a machine readable ways (including restrictions, embargoes, duties …)
|
Embedded Rights Expression Structure (0..unbounded) |
New 1.0 |
|||
Structure covering the assertion of rights, the granting of licenses and both in human and a machine readable ways (including restrictions, embargoes, duties …)
|
Linked Rights Expression Structure (0..unbounded) |
New 1.0 |
|||
Data identifying the individual or organisation owning the rights for this media resource which could be the video as a whole or a clip in a video. The optional role attribute may indicate which facet of rights is covered by this entity. |
Entity with role (0..unbounded) |
New 1.0 |
|||
Supplier of this copy of the media resource |
Entity Structure (0..1) |
New 1.0 |
|||
Person or party who has a role in the content supply chain. |
Entity Structure (0..unbounded) |
New 1.0 |
5.4. Technical fields
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
Bit rate of the audio data depending on the Video Bit Rate Type: if fixed the fixed rate, if variable the maximum rate. The unit is bits per second. |
Number (0..1) |
New 1.0 |
|||
Indicates if the bitrate of the audio data is fixed or variable |
Text (0..1) Enumeration - fixed - variable |
New 1.0 |
|||
Number of bits used for an audio sample |
Number (0..1) |
New 1.2 |
|||
Term indicating the channel layout |
Text (0..1) |
New 1.0 |
|||
Number of used audio channels |
Number (0..1) |
New 1.0 |
|||
Machine readable code and a human readable term for the used audio coding |
Entity Structure (0..1) |
New 1.0 |
|||
Rate used for sampling the audio |
Number (0..1) |
New 1.0 |
|||
Ratio of width and height of the displayed image. (Width and height do not require to be in pixels.)
|
Text (0..1) |
New 1.0 |
|||
Duration of the video content proposed for editorial use
|
Video Time Structure (0..unbounded) |
New 1.0 |
|||
The point in time and frames the content proposed for editorial use ends
|
Video Time Structure (0..unbounded) |
New 1.0 |
|||
The point in time and frames the content proposed for editorial use starts
|
Video Time Structure (0..unbounded) |
New 1.0 |
|||
The total bit rate of the all media streams in this file. |
Number (0..1) |
New 1.0 |
|||
Duration of the overall video (from the first to the last frame)
|
Video Time Structure (0..1) |
New 1.0 |
|||
Format of the file containing the video data. |
Entity Structure (0..1) |
New 1.0 |
|||
Size of the video frame in pixels |
Frame Size Structure (0..1) |
New 1.0 |
|||
IANA Media Type of the video.
|
Text (0..1) |
New 1.0 |
|||
Orientation of the visual content of the video as defined by TIFF. |
Number (0..1) (TIFF 6.0 orientation - with a user guideline ("no flips")) |
New 1.0 |
|||
Ratio of width and height in pixels of a frame
|
Text (0..1) |
New 1.0 |
|||
Combined term including the size of the frame, interlaced/progressive, framerate
|
Text (0..1) |
New 1.0 |
|||
Indicates if this video can be used for streaming by the rule of having the key technical data of the video at the start rather than end of the file and that the wrapper and essense format are suitable for streaming |
Text (0..1) Enumeration: - true - false - unknown |
New 1.0 |
|||
Bit rate of the video data depending on the Video Bit Rate Type: if fixed the fixed rate, if variable the maximum rate. The unit is bits per second. |
Number (0..1) |
New 1.0 |
|||
Indicates if the bitrate of the video data is fixed or variable |
Text (0..1) Enumeration - fixed - variable |
New 1.0 |
|||
Machine readable code and a human readable term for the used video coding |
Entity Structure (0..1) |
New 1.0 |
|||
Used frame rate |
Number (0..1) |
New 1.0 |
|||
Name of the used video profile as defined by the maker of the encoding standard.
|
Text (0..1) |
New 1.0 |
|||
Count of video streams in a video file. |
Number (0..1) |
New 1.0 |
5.5. Time marker
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
A marker describes a location in an audio or video sequence. It is used to identify for which part of the video (a clip of the video as a whole) a set of IPTC Video Metadata properties is used. |
XMP specific type |
New 1.0 |
6. Property Structures
Intro text to structures section.
6.1. CV-Term Structure
Used in: Genre
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
CV-Term CV ID |
Globally unique identifier of the Controlled Vocabulary the term is from. |
Text/URI (0..1) |
New 1.0 |
||
CV-Term ID |
Globally unique identifier of the term from a Controlled Vocabulary. |
Text/URI (1) |
New 1.0 |
||
CV-Term name |
Natural language name of the term from a Controlled Vocabulary. |
Text + language tag (0..1) |
New 1.0 |
||
Refined 'aboutness' of the CV-Term |
Refinement of the 'about' relationship of the term with the content.
|
Text/URI (0..1) |
New 1.0 |
6.2. Device Structure
Used in: Recording Device
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Manufacturer |
Name of the manufacturer of the device |
Text (0..1) |
New 1.2 |
Model Name |
Name of the device model |
Text (0..1) |
New 1.2 |
Serial Number |
Serial number, assigned by manufacturer |
Text (0..1) |
New 1.2 |
Attached Lens Description |
Short description of the lens used with the device at the time of the recording |
Text (0..1) |
New 1.2 |
Owner´s Device ID |
Identifier assigned by the owner of the device |
Text (0..1) |
New 1.2 |
6.3. Embedded Rights Expression Structure
Used in: Rights and Licensing Terms (1)
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Rights Expression Language ID |
Identifier of the rights expression language used by the rights expression. |
Text/URI (1) |
New 1.0 |
Encoding type |
Encoding type of the rights expression, identified by an IANA Media Type. |
Text (1) |
New 1.0 |
Encoded Rights Expression |
Embedded serialized rights expression using a rights expression language which is encoded as a string. |
Text (1) |
New 1.0 |
6.4. Entity Structure
Used in: Metadata Editor, Metadata Authority, Featured Organisation, Object Shown, Person Heard, Person Shown, Shown Event, Licensor , Supplier , Supply Chain Source, Audio Coding, File Format, Video Coding
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Identifier |
Globally unique identifier of the entity |
Text/URI (0..unbounded) |
New 1.0 |
Name |
Full name of the entity |
Text + language tag (0..1) |
New 1.0 |
6.5. Concept Structure
Used in: Workflow Tag, CV Term About the Content, Shot Type
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Identifier |
Globally unique identifier of the concept |
Text/URI (0..unbounded) |
New 1.0 |
Name |
Full name of the concept |
Text + language tag (0..1) |
New 1.0 |
6.6. Entity with role Structure
Used in: Planning Reference, Contributor, Creator
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Identifier |
Globally unique identifier of the entity |
Text/URI (0..unbounded) |
New 1.0 |
Name |
Full name of the entity |
Text + language tag (0..1) |
New 1.0 |
Role |
Identifier of the role the entity has in the context of the metadata property |
URI (0..unbounded) |
New 1.0 |
6.7. Concept with role Structure
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Identifier |
Globally unique identifier of the concept |
Text/URI (0..unbounded) |
New 1.0 |
Name |
Full name of the concept |
Text + language tag (0..1) |
New 1.0 |
Role |
Identifier of the role the concept has in the context of the metadata property |
URI (0..unbounded) |
New 1.0 |
6.8. Episode/Season Structure
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Name |
Name of the episode or season of a series |
Text + language tag (0..1) |
New 1.0 |
Number |
Number of the episode or season of a series |
Integer (0..1) |
New 1.0 |
Identifier |
Identifier of the episode or season of a series |
URI (0..1) |
New 1.0 |
6.9. Frame Size Structure
Used in: Frame Size
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Width |
Width of the video frame in pixels |
Number (1) |
New 1.0 |
Height |
Height of the video frame in pixels |
Number (1) |
New 1.0 |
Measure Unit |
Units of width and height values, fixed value "pixels" |
Text(1) |
New 1.0 |
6.10. Linked Rights Expression Structure
Used in: Rights and Licensing Terms (2)
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Rights Expression Language ID |
Identifier of the rights expression language used by the rights expression. |
Text/URI (1) |
New 1.0 |
Encoding type |
Encoding type of the rights expression, identified by an IANA Media Type. |
Text (0..1) |
New 1.0 |
Link to Encoded Rights Expression |
Link to a rights expression using a rights expression language. |
URL (1) |
New 1.0 |
6.11. Linked Image Structure
Used in: Snapshot Link
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Image Link |
Link URL locating the image resource |
URL (1) |
New 1.1 |
Image Qualifier |
Qualifier of the relationship of the image with the video |
URI (0..unbounded) |
New 1.1 |
Image Role |
Role of this image in the context of the video |
Text (0..1) |
New 1.1 |
Media Type |
IANA Media (MIME) Type |
Text (0..1) |
New 1.1 |
Image Width |
Width of the image, in pixels |
Integer (0..1) |
New 1.1 |
Image Height |
Height of the image, in pixels |
Integer (0..1) |
New 1.1 |
Used Video Frame |
Frame of the video used for this still image. |
Video Time structure (0..1) |
New 1.1 |
6.12. Location Structure
Used in: Location Shot, Location Shown
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Identifier |
Globally unique identifier of the location |
Text/URI (0..unbounded) |
New 1.0 |
Name |
Full name of the location |
Text + language tag (0..1) |
New 1.0 |
Sublocation name |
Name of a sub location the Location is located in |
Text + language tag (0..1) |
New 1.0 |
City name |
Name of the city the Location is located in |
Text + language tag (0..1) |
New 1.0 |
State/Province name |
Name of the state or province the Location is located in |
Text + language tag (0..1) |
New 1.0 |
Country name |
Name of the country the Location is located in |
Text + language tag (0..1) |
New 1.0 |
Country ISO code |
ISO code of the country the Location is located in |
Text + language tag (0..1) |
New 1.0 |
World region name |
Name of the world region the Location is located in |
Text + language tag (0..1) |
New 1.0 |
GPS-Longitude |
Longitude of a WGS84 based position of this Location |
Number/decimal (0..1) |
New 1.0 |
GPS-Latitude |
Latitude of a WGS84 based position of this Location |
Number/decimal (0..1) |
New 1.0 |
GPS-Altitude |
Altitude in meters of a WGS84 based position of this Location |
Number/decimal (0..1) |
New 1.0 |
6.13. Person Details Structure
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Identifier |
Globally unique identifier of the person |
Text/URI (0..unbounded) |
New 1.0 |
Name |
Name of the person |
Text + language tag (0..1) |
New 1.0 |
Description |
A textual description of the person |
Text + language tag (0..1) |
New 1.0 |
Characteristics |
A property or trait of the person |
Concept structure (0..unbounded) |
New 1.0 |
6.14. Product with GTIN Structure
Used in: Product Shown
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
GTIN |
A 14 digit GTIN (Global Trade Item Number) of the product (GTIN-8 to GTIN-14 codes are used). |
Text (1) |
New 1.0 |
Name |
Name of the product. |
Text + language tag (0..1) |
New 1.0 |
Description |
A textual description of the product. |
Text + language tag (0..1) |
New 1.0 |
6.15. Publication Event Structure
Used in: Publication Event
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
Publication Date |
Date and optionally the time of publishing the video |
Date (1) |
New 1.0 |
||
Publication Event Name |
Name of the event for publishing this video.
|
Text + language tag (0..1) |
New 1.0 |
||
Publication Event Identifier |
Identifier of the event for publishing this video |
URI (0..1) |
New 1.0 |
6.16. Qualified Link Structure
Used in: Dopesheet Link, Transcript Link
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Link |
URL of the link |
URL (1) |
New 1.0 |
Qualifier |
Term qualifying the use of the link |
URI (0..1) |
New 1.0 |
6.17. Rating Structure
Used in: Rating
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Rating Value |
Rating value as issued by the rating source |
Text (1) |
New 1.0 |
Rating Source Link |
Link to the site and optionally the page of the party which has issued the rating value, linked resource should explain the rating rules. |
URL (1) |
New 1.0 |
Rating Scale Min Value |
The value of the rating scale used for the lowest/worst rating |
Text (0..1) |
New 1.0 |
Rating Scale Max Value |
The value of the rating scale used for the highest/best rating |
Text (0..1) |
New 1.0 |
Rating Value Logo |
Visualisation of the rating value referenced by a link |
URL (0..1) |
New 1.0 |
Rating Region |
Geopolitical region to which this rating applies. |
Location Entity structure (0..unbounded) |
New 1.0 |
6.18. Registry Entry Structure
Used in: Registry Entry
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
Asset Identifier |
Unique identifier of the video as issued by a registry
|
Text (preferred: URI) (1) |
New 1.0 |
||
Registry Identifier |
An identifier for the registry which issued the identifier of the video. |
Text (preferred: URI) (1) |
New 1.0 |
||
Role |
An identifier of the reason and/or purpose for this Registry Entry.
|
Text/URI (0..1) |
New 1.0 |
6.19. Series Structure
Used in: Series
Property name | Definition | Type and cardinality | Change history |
---|---|---|---|
Series name |
Name of the series |
Text + language tag (0..1) |
New 1.0 |
Series identifier |
Identifier for the series |
URI (0..1) |
New 1.0 |
6.20. Temporal Coverage Structure
Used in: Temporal Coverage
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
From Date |
Optionally truncated date when the temporal coverage starts
|
Date(1) |
New 1.0 |
||
To Date |
Optionally truncated date when the temporal coverage ends |
Date(1) |
New 1.0 |
6.21. Text with Region Delimiter Structure
Used in: Data Displayed on Screen
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
Text |
Text or textual data |
Text (1) |
New 1.0 |
||
Measure Type |
How the measures of the rectangle are expressed
|
Text (0..1) - enumeration - absolutePixels - ratio |
New 1.0 |
||
Rectangle, upper left X |
Horizontal axis value of the upper left corner of the rectange |
Decimal (0..1) |
New 1.0 |
||
Rectangle, upper left Y |
Vertical axis value of the upper left corner of the rectange |
Decimal (0..1) |
New 1.0 |
||
Rectangle, horizontal size |
Horizontal width of the rectangle |
Decimal (0..1) |
New 1.0 |
||
Rectangle, vertical size |
Vertical height of the rectangle |
Decimal (0..1) |
New 1.0 |
6.22. Video Time Structure
Property name | Definition | Type and cardinality | Change history | ||
---|---|---|---|---|---|
Time Format |
Identifier of the time format. For time code formats following SMPTE specifications. |
Text value from CV (1) Enumeration: - normalPlayTime - smpteTC24 - smpteTC25 - smpteTC2997 - smpteTC2997drop - smpteTC30 - smpteTC50 - smpteTC5994 - smpteTC5994drop - smpteTC60 - smpteTC23976 |
New 1.0 |
||
Time Value |
Formated string including hours, minutes, seconds, fractions of seconds or frames, depending on the Time Format |
Text (1) |
New 1.0 |
||
Identifier |
Globally unique identifier of the entity |
Text (0..1) |
New 1.3 |
||
Name |
Full name of the entity |
Text (0..1) |
New 1.3 |
||
Circa Date Created |
Approximate date or range of dates associated with the creation and production of an artwork or object or its components. |
Text (0..1) |
New 1.3 |
||
Content Description |
A textual description of the content depicted in the artwork or object. NOTE: |
Text (0..1) |
New 1.3 |
||
Contribution Description |
A textual description about a contribution made to an artwork or an object.
|
Text (0..1) |
New 1.3 |
||
Copyright Notice |
Contains any necessary copyright notice for claiming the intellectual property for artwork or an object in the image and should identify the current owner of the copyright of this work with associated intellectual property rights. |
Text (0..1) |
New 1.3 |
||
Creator |
Contains the name of the artist who has created artwork or an object in the image. In cases where the artist could or should not be identified the name of a company or organisation may be appropriate. |
Text (0..unbounded) |
New 1.3 |
||
Creator ID |
Globally unique identifier for the creator of artwork or object.
|
URL (0..unbounded) |
New 1.3 |
||
Current Copyright Owner ID |
Globally unique identifier for the current owner of the copyright of the artwork or object. |
URI (0..1) |
New 1.3 |
||
Current Copyright Owner Name |
Name of the current owner of the copyright of the artwork or object. |
Text (0..1) |
New 1.3 |
||
Current Licensor ID |
Globally unique identifier for the current licensor of the artwork or object. |
URI (0..1) |
New 1.3 |
||
Current Licensor Name |
Name of the current licensor of the artwork or object. |
Text (0..1) |
New 1.3 |
||
Date Created |
Designates the date and optionally the time the artwork or object in the image was created. This relates to artwork or objects with associated intellectual property rights. |
DateTime (preferred: truncated DateTime) (0..1) |
New 1.3 |
||
Physical Description |
A textual description of the physical characteristics of the artwork or object, without reference to the content depicted.
|
Text (0..1) |
New 1.3 |
||
Source |
The organisation or body holding and registering the artwork or object in the image for inventory purposes. |
Text (0..1) |
New 1.3 |
||
Source Inventory Number |
The inventory number issued by the organisation or body holding and registering the artwork or object in the image. |
Text (0..1) |
New 1.3 |
||
Source Inventory URL |
URL reference to the metadata record of the inventory maintained by the Source. |
URL (0..1) |
New 1.3 |
||
Style Period |
The style, historical or artistic period, movement, group, or school whose characteristics are represented in the artwork or object.
|
Text (0..unbounded) |
New 1.3 |
||
Title |
A reference for the artwork or object in the image. |
Text (0..1) |
New 1.3 |
7. Recommended Property Mappings
Many Video Metadata Hub properties are mapped to properties defined by one or more of the below standards, to make implementation easier for vendors:
-
Apple QuickTime
-
Canon VideoClip XML (as of Video Metadata Hub 1.2)
-
EBUCore (updated in Video Metadata Hub 1.3)
-
IPTC NewsML-G2
-
MPEG 7 (ISO 15938-5)
-
PBCore
-
Schema.org
-
SMPTE P2 as used by Panasonic*
-
Sony XDCAM & planning (as of Video Metadata Hub 1.2)
The mappings can be obtained from the IPTC Video Metadata Hub mappings table.
7.1. Using the mapping table
For example, if an organisation uses NewsML-G2 as its main metadata format, and wants to describe the unique identifier for the video file (Video Identifier in VM Hub).
Looking up the appropriate row in
the mapping table,
and then consulting the NewsML-G2 column,
we can see that the recommended mapping is contentMeta/altId[@role="altidrole:vmhVideoId"]
.
So this means that the video identifier should be represented as follows in the NewsML-G2 file:
<contentMeta> <altId role="altidrole:vmhVideoId">xxxx</altId> </contentMeta>
8. JSON Schema for Video Metadata Hub
A JSON Schema has been created to help users create metadata packages in the JSON format. These could be embedded into a video file, or used as a separate file accompanying the video, known as a "sidecar".
The JSON Schema is located at https://www.iptc.org/std/videometadatahub/recommendation/iptc-vmhub-1.3-schema.json. A JSON Schema-aware editor can help you to create metadata files in that format, or you can write software that outputs that format from a graphical user interface.
Example JSON files are available at https://iptc.org/std/videometadatahub/examples/json/.
Here is an extract of the example relating to the GLAM use case:
[...] "photoVideoMetadataIPTC": { "circaDateCreated": "1990s", "dateModified": "No", "episode": { "name": { "en": "https://wellcomelibrary.org/item/b16766246" } }, "externalMetadataLinks": [ "https://wellcomelibrary.org/data/b16766246" ], "metadataAuthority": { "name": { "en": "Wellcome Library" } }, "releaseReady": true, "identifier": "b16766246", "aboutCvTerms": "Public health", "description": { "en": "A television advertisement asking people to register for a Donor Card in order to donate organs after death. " }, "dopesheetLinks": "https://wellcomelibrary.org/data/b16766246", "genres": "Public information", "headline": { "en": "A television advertisement asking people to register for a Donor Card in order to donate organs after death. " }, [...]
9. Example files
9.1. Example videos with embedded XMP
We have created some sample video files with embedded metadata using Video Metadata Hub properties.
The example files can be found at https://iptc.org/std/videometadatahub/examples/.
These "reference videos" have a value for each and every Video Metadata Hub property, embedded using the XMP format.
View the embedded metadata by downloading and examining the file, for example using the command-line tool exiftool:
$ curl --output refvideo.mp4 https://www.iptc.org/std/videometadatahub/examples/IPTC-VMHub-RefVideo-Rec0100.mp4 $ exiftool -G1 -json -struct refvideo.mp4
This is an extract of the embedded metadata, showing the Video Metadata Hub tags extracted by exiftool:
{
[ ... ]
"LinkedEncRightsExpr": [{
"LinkedRightsExpr": "http://example.org/linkedrightsexpression/id986/Rec0100",
"RightsExprEncType": "IANA Media Type of ERE (Rec0100)",
"RightsExprLangId": "http://example.org/RELids/id4712/Rec0100"
}],
"LocationCreated": [{
"City": "City (Location created1) (Rec0100)",
"CountryCode": "R16",
"CountryName": "CountryName (Location created1) (Rec0100)",
"GPSAltitude": "180 m",
"GPSLatitude": "16 deg 20' 1.20\" N",
"GPSLongitude": "48 deg 14' 1.80\" E",
"LocationId": ["Location Id (Location created1) (Rec0100)"],
"LocationName": "Name of Location Created 1 (Rec0100)",
"ProvinceState": "Province/State (Location created1) (Rec0100)",
"Sublocation": "Sublocation (Location created1) (Rec0100)",
"WorldRegion": "Worldregion (Location created1) (Rec0100)"
}],
"LocationShown": [{
"City": "City (Location shown1) (Rec0100)",
"CountryCode": "R16",
[ ... ]
Please note that the field names used by exiftool do not exactly match the names in the Video Metadata Hub specification.
10. How can you help?
-
Software vendors: implement the standard in your systems to support interoperability. The standard is freely available and free to implement.
-
Broadcasters and video producers: encourage your software vendors and manufacturers to implement IPTC Video Metadata Hub in their systems.
-
Media managers: as you configure your Digital Asset Management systems' metadata fields, consider using the Video Metadata Hub properties as the basis for your metadata schema, to ensure easy supply chain interchange and compatibility with other systems in the future.
11. Contact us
If you would like to implement IPTC Video Metadata Hub, suggest changes or help us spread the word, please contact the IPTC Video Metadata Working Group via the public discussion list https://groups.io/g/iptc-videometadata .