Each Type includes an ExtensionGroup to
allow for vendor-specific extensions, but the definition is out of scope of the FIMS
specification.
Any number of extension elements
from an external namespace. The lax processing model indicates that if the
schema for the extension elements is known, then they should be validated.
If the schema is not known, no error will be generated. Extension nodes must
be the last element in a sequence of a non-abstract type.
Optional
Optional
Each Type includes an ExtensionAttributes
to allow for vendor-specific extensions, but the definition is out of scope of the
FIMS specification.
Permitted extensions to elements
that permit extensions. Attributes from other namespaces are permitted. Lax
processing requests that a validator checks the attributes where access to the
attribute's defining schema is available.
Extension attributes should
not be used where an equivalent property is available in the FIMS data model.
Attributes from the FIMS base namespace shall not be used.
Optional
Optional
The source or target of a reference to a
distinct resource. Resources include queues, jobs, assets, descriptions, formats and
profiles.
Locally distinct identifier for
the resource that can be used to make reference to the resource. The
reference may also be globally unique.
Mandatory
Mandatory
Identifier for the specific
revision of the resource. Tracking the different versions of resources
across systems enables different instances and versions of a resource to
coexist at different locations and updated to be eventually consistent
according to local policy.
A reference to a
resource that omits the revision identification of the resource shall
indicate that the latest version is required.
Required
Support or
not.
Optional
Optional
A Uniform Resource Location that
points to a specific instance of a resource at a location.
Reference to a resource
that omits the location shall require resolution of the resourceID according
to local policy.
Required
Support or
not.
Optional
Optional
Resources include queues, jobs, assets,
descriptions, formats and profiles.
Date and time when this
resource was created.
Optional
Optional
Date and time when this
resource was last modified. Modification date of the resource should
be updated when any of the values of the resource's properties are
updated.
Optional
Optional
Endpoints where a service
can send back a notification for a job completed or failed.
A service shall
support either notification or polling. If this element is set, the
service shall send a notification to the address(es) indicated in
the "replyTo" field(s) for successful completion and shall send a
notification to the address(es) indicated in the "faultTo" field(s)
for failure. If this element is not set, the service shall not send
notifications to the requester.
Required
Support
or not, including the maximum number of notification
endpoints.
Optional
Not
applicable
Extension
point.
Extension
point.
Provides endpoints where a service can
send back a notification for a job completed or failed.
Endpoint where the service sends
notifications indicating the successful termination or cancellation of a
job. Depending on the invoking client or business process, the endpoint for
"faultTo" can be the same as the "replyTo" or it can be
different.
Mandatory
Mandatory
Endpoint where the service sends
the fault notification indicating the failure of a job. Depending on the
invoking client or business process, the endpoint for "faultTo" can be the
same as the "replyTo" or it can be different.
Mandatory
Mandatory
Describes the location endpoint, provider
and Service Description of the service.
Name for the provider of
a service.
Required
Support
or not
Optional
Optional
Provider endpoint that
uniquely locates the provider servicing the job
request.
Optional
Mandatory
Service-specific
description of the capabilities offered by the service. The
transfer, transcode and capture services defined alongside the
original FIMS framework have service descriptions provided and, if
used, it is recommended that these are embedded
here.
Not
applicable
Optional
A profile used by a FIMS media service to
perform a job on media content. For example, it may represent the profile of a
transfer media service for transferring media content and, as such, may specify the
media format to be produced in output. The profile provides a mechanism to specify
service-provider-specific information for each operation.
Details of the service
that has been selected to execute this profile.
Optional
Optional
Name of the
profile.
Optional
Optional
Description of the
profile.
Optional
Optional
Provides basic queue information, such as
the status and length of the queue.
Required
Support or not the queue,
queue depth, and supported queue commands
Status information for
the queue.
Not
applicable
Mandatory
An optional description
for the status.
Not
applicable
Optional
Length of the queue,
measured in the number of jobs currently in this
queue.
Not
applicable
Mandatory
Determines if the queue
is currently available.
Not
applicable
Mandatory
Estimate of the time
duration required for processing all jobs currently in the
queue.
Required
Support
or not
Not
applicable
Optional
Optional list of jobs
currently in the queue.
Not
applicable
Optional
Describes a job, which is extended in
each service schema.
Required
Supported job
commands
The current status of the
job (e.g. running, completed), enumerated in JobStatusType.
Not
applicable
Mandatory
Optional description for
job status.
Not
applicable
Optional
Service-provided local
job identifier, such as a job identifier provided locally by an
application.
If the service
provider generates its own local job identifier associated with a
job request, this field may be set. Otherwise, the service provider
may use the supplied resource identifier.
Required
Support
or not.
Not
applicable
Optional
The queue that has master
control over execution of this job. As a FIMS-compliant device is
not required to support queues, this element is optional.
The property
shall be used as a reference to a queue containing the resource ID
of the queue.
Required
Support
or not.
Not
applicable.
Optional
A list of sub-tasks that
consists of related jobs running in parallel. For information only
in FIMS 1.0. Whether the sub-tasks are running in parallel or
sequence to one another is not recorded in this model.
Required
Support
or not.
Not
applicable
Optional
Descriptive name of the
operation associated with this job.
Required
Support
or not.
Not
applicable
Optional
Business media objects
produced or consumed by the job. For some services, such as a
capture service, no BMObjects are consumed. However, the job will
include a BMObject on completion.
Optional
Optional
The priority for the job
(e.g. "immediate", "high"...) enumerated in PriorityType. Where
supported, job priorities describe the relative priority of a job in
the owning queue.
The priority
shall be included where the job is being managed as part of a
queue.
Required
Support
or not.
Optional
Optional
Parameter used to
indicate that the job shall be initiated no earlier then the
specified time.
A service shall
support at least the NoWait type.
Required
Support
or not and supported StartJob types
Mandatory
Optional
Specifies the time by
which the job shall have been completed. This element also specifies
the deadline for job execution. For example, in the case of
specifying "TimeMark" type in the "stopProcess", it can be used as a
timeout time.
When
"finishBefore" is exceeded before the job is completed, the service
shall notify "deadline passed" to the orchestration system. If the
service cannot accommodate the time constraint, the service shall
notify "time constraints in request cannot be met" to the
orchestration system. Even if a service does not itself support the
function to control the job completion time, an orchestration system
should specify "finishBefore" as a deadline.
Required
Support
or not
Optional
Optional
Before the job has
started, an estimate for the expected total duration of the job.
Once the job has started, it provides an estimation of time
remaining until the end of the job.
Required
Support
or not.
Not
applicable
Optional
The position of the job
in the queue.
The current
queue position shall be included where the job is being managed as
part of a queue.
Required
Support
or not.
Not
applicable
Optional
The date and time this
job started.
Required
Support
or not
Not
applicable
Optional
The time elapsed since
the job started.
Required
Support
or not
Not
applicable
Optional
The time and date that
the job completed.
Required
Support
or not
Not
applicable
Optional
Provides statistics on
number of bytes or frames processed. Note that a time-based
percentage value to completion is not directly provided, but can be
calculated if the service provides the
"estimatedCompletionDuration". The time-based percentage is a ratio
between "jobElapsedTime" and
"estimatedCompletionDuration".
Required
Support
or not and which kind of processed information is
provided.
Not
applicable
Optional
Characteristics of files, video, audio
and ancillary data.
User defined technical
attributes. See 'technical attribute' in EBU Tech 3293 for more
information.
Optional
Optional
Characteristics of a video signal. See
'videoFormat' in EBU Tech 3293 for more information.
Width of the image or
picture. Used as numerator to define the aspect ratio for video
content. See 'width' in EBU Tech 3293 for more
information.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Height of the image or
picture. Used as denominator to define the aspect ratio for video
content. See 'height' in EBU Tech 3293 for more
information.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Frame rate for the video
content, measured in frames/second.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Ratio of the picture (the
width by the height), for instance '4:3' or '16:9' (rational). The
format of the aspect ratio is specified in the format attributes.
See 'aspectRatio' in EBU Tech 3293 for more
information.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Defines the encoding
parameters of the resource (e.g. H264) for a video channel. See
'videoEncoding' in EBU Tech 3293 for more
information.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Definition of the video
tracks in the source.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Number of bits at which
the video is encoded, measured in bits per second.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Type of bitrate, either
constant or variable.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Number of scanning lines
in the image, also known as resolution height. For example, 1080,
720, 576 etc..
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Whether the image is
presented using interlaced or progressive scanning.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Whether the fields are
ordered top (upper) or bottom (lower) field first in video stream
encoding order.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Whether noise was removed
from the signal.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Characteristics of an audio signal. See
'audioFormat' in EBU Tech 3293 for more information.
Audio sampling rate that
defines the number of samples per second taken from the continuous
audio signal, and it is expressed in Hertz.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Defines the audio
compression format of the resource (e.g. AAC) for an audio channel.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Defines the audio track
configuration that expresses the arrangement or audio tracks e.g.
'stereo', '2+1', 'surround', 'surround (7+1)' etc..
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Definition of audio
tracks in the source.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Number of channels used
for the source recording.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Number of bits at which
the audio is encoded, measured in bits per second.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Type of bitrate, either
constant or variable.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Sample size for the
recording, e.g. 16- or 24-bits per sample.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Whether the samples are
represented as integer or floating point values.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Characteristics of a data signal, used to
carry captioning or ancillary data.
Where captioning data is
present, describes the captioning formats and their
purpose.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Where ancillary data is
present, describes the captioning formats and their
purpose.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Describes a captioning format and its
purpose.
Underlying format for the
captioning/subtitling being used.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Location of the file with the
captioning/subtitling data. See '@captioningSourceUri' in EBU Tech 3293
for more information.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Language of the caption as
delivered (e.g., en-UK). See 'captioningFormat - dc:language' in EBU
Tech 3293 for more information.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Attributes from other
namespaces are permitted. Lax processing requests that a validator
checks the attributes where access to the attribute's defining schema is
available.
Attributes from the
FIMS base namespace shall not be used.
Ancillary data packet type. See SMPTE ST
291 and SMPTE ST 436.
ANC DID value.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
ANC SDID value.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Video line number containing the
ANC packets of this type.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Indicates HANC or VANC, and what
field in which packets should be stored. See SMPTE ST 436 for legal
values.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Extension point.
Extension point.
Container/wrapper format that is used in
complement to the streams encoding, for example MXF, wave, Quicktime, etc.. See
'fileFormat' in EBU Tech 3293 for more information.
Defines the file format
for the data. See 'fileFormat' in EBU Tech 3293 for more
information.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Tracks expose the underlying structural
metadata of the content streams embedded inside a physical content essence. Examples
of tracks are the separate audio and video streams inside an audiovisual content
essence. Tracks have a category, for example "main" (videoTrack), "audioDescription"
(audioTrack), "closed captioning" (dataTrack). Tracks have also an identifier and a
description.
Extension point.
Extension point.
Identifier of the
track.
Optional
Optional
The category of the track (e.g.
"video").
Optional
Optional
Name for the track.
Optional
Optional
Language of the track, such as the
primary spoken language for an audio track.
Optional
Optional
Describes a codec used for video or audio
encoding.
Name of the hardware or software
codec.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
The vendor/organization that
produced the codec.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Version of the specific release
of the codec.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Codec family, e.g. MPEG-2, H.264
etc.
Required
Whether on
request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
To define the encoding format either
as a string using typeLabel or as a pointer to a classification scheme using
typeLink. An optional definition can be provided using the
typeDefinition.
Required
Whether on request,
it must be present, may be interpreted or is not applicable.
Optional
Optional
Common representation of the content
exchanged by FIMS media services, through reference to logical content objects. Note
that although the current BMObject can only reference at most one logical content
item, it is intended that future versions of FIMS will extend BMObject to provide
different kinds of content collections, such as sequences and edit decision lists.
Logical content item that
is exchanged by a FIMS media service.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Logical items of content, representing a
sequence of frames and/or samples that have a fixed length and are intended to be
played sequentially from end-to-end.
Logical content items should be
used to representing a single version of a programme or clip that has many different
renditions, e.g. different encodings. Logical content items shall not be used to
represent different editorial versions of content, such as a different cut of a
programme created for a different audience.
List of different content
formats that provide physical representations of the logical content
item. Content formats are different renditions of the same content,
differing in the way they are encoded. Content formats have
technical metadata.
All content
formats shall have the same play time, with the exception of minor
alterations due to frame rate conversions.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Non-technical
descriptions of the logical content. It is recommended that a basic
description of the content items is included by making use of the
FIMS description metadata schema (http://description.fims.tv), which
is based on a subset of descriptive metadata fields from EBUCore and
Dublin Core. This will be useful for interoperable monitoring
applications by providing a consistent place where, say, a title
field can be found for presentation in a GUI. Content items may have
many different descriptions for different purposes, such as for
archiving, presentation, rights management and contributor
management. For this purpose, the use of multiple descriptions in
included. Also, a programme may be an episode that is part of a
series that is part of a brand and the descriptions of each level in
that hierarchy could be included (by reference) here.
At least one
description of a logical content item should be provided. One of the
descriptions should include an element containing the basic metadata
described according to the FIMS description scheme
(http://description.fims.tv).
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Description of a logical content,
containing descriptive metadata. Descriptive metadata is attached using the proposed
core XML description based on EBUCore or using the schema "any" facility supported
by all resources.
Description of a logical
content, containing core descriptive metadata based on EBUCore.
Optional
Optional
Format description and essence locations
of a physical representation of single rendition of a logical content
item.
Known locations for the
content.
All the
locations described shall store the same content and shall share the
format description that is described by the formatCollection
property of this content format.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Technical metadata
describing this specific physical embodiment of the content. The
description contains the video, audio, data and container formats of
the content format.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Duration of the audio
and/or visual content.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Hash code value
calculated for the physical essence representation.
If the essence
location is a collection of files rather than a single file and the
hash is expected to be produced by a service, then the service shall
describe the algorithm used to calculate a hash value for multiple
files.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Size of the file or
collection of files that provide the physical essence
representation.
If the essence
representation is a single file, this value shall be set and be
equal to the file size. If the package is a collection of files,
rather than a single file, then the packageSize shall correspond to
the sum of the sizes of the different components of the
package.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Multipurpose Internet
Mail Extensions Media Type for the physical essence representation.
The MIME type can include any required or optional parameters after
the type, separated by semicolons. Note that this MIME type refers
to the overall type of media, for example a folder containing P2
card data or an AS-02 bundle both use MXF file formats, setting this
property to "application/mxf".
The format of
the media type shall be as defined in IETF RFC 2046 and the MIME
type should be registered by IANA at
http://www.iana.org/assignments/media-types/index.html.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Location of a physical representation of
an item of content. Note that essence locations may be shared by multiple physical
content formats and/or logical content items. For example, a folder structure taken
from a camera may contain both master-quality and proxy-quality versions. The same
essence locator can be targeted by two different physical content formats for the
same logical content item. As another example, an AS-02 bundle may contain two
different editorial versions of the same programme and can be referenced from two
separate logical content items.
An essence locator may be the
target of more than one references from a content format.
Kind of storage for the
essence, for example "online" or "hsm".
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Describes the
geographical location of the content, for example "New
York".
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Multipurpose Internet
Mail Extensions Media Type for the physical container used for the
representation. Vendors are encouraged to register MIME types for
the containers in use, such as a folder containing capture data from
a camera. Where additional structural data is required, vendors are
encouraged to extend one of the essence locator types (single file,
list, folder).
The format of
the media type shall be as defined in IETF RFC 2046 and the MIME
type should be registered by IANA at
http://www.iana.org/assignments/media-types/index.html.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Location of essence represented by a
single file
Location of the
essence-containing single file, such as an MXF OP-1a
file.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Location of essence represented by a list
of files that represent a single rendition of the content.
List of a collection of
files that, taken together, represent an essence location. Note that
the files are not necessarily stored in the folder, on the same disk
resource or even on the same server.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Root of a folder structure that, taken as
a whole including its children, represents an essence location that stores the
rendition of the content described by the parent content format.
The folder and all of its
children should be presented within a single filing system.
Root of a folder
structure where the root and its children are an essence
representation.
Required
Whether
on request, it must be present, may be interpreted or is not
applicable.
Optional
Optional
Parameters specific to transfer media
services that can be re-used for other services. Note: Some parameters might be
added to the atom in future version to specify network resource utilization, a list
of acceptable transfer mechanisms or additional security options including whether
the received files should be checked against a fingerprint and whether they are
encrypted.
Destination path for the target.
The URL field shall
follow the standard structure for a URL as defined in RFC1738 - Uniform
Resource Locators (URL). In case of a file protocol scheme, the host field
shall explicitly be included in the URL. The URL covers different protocol
schemes, such as NFS mounts RFC2224, which defines
nfs://[host]:[port]/[directory].../[filename], and the internet draft for
the smb: scheme for CIFS, with the restriction that only the path and not
the file name shall be provided.
Required
Kinds of
destination supported.
Mandatory
Mandatory
Extension point.
Extension point.
Parameters specific to the transform
media service that can be re-used by other services. Note: Some parameters might be
added to this type in future version of this specification to specify AV Process,
etc.
Specifies the output video
format. See 'videoFormat' in EBU tech 3293 for more
information.
Required
Support or not.
If supported, the video formats are supported.
Optional
Optional
Specifies the output audio
format. See 'audioFormat' in EBU tech 3293 for more
information.
Required
Support or not.
If supported, the audio formats are supported.
Optional
Optional
Container/wrapper format of the
output file. See "fileFormat" in EBU tech 3293 for more
information.
Required
Support or not.
If supported, the container formats are supported.
Optional
Optional
Extension point.
Extension point.
Defines a contextual type.
Free text. Example: ‘H264 Main
Profile @ Level 1’. See EBU Tech 3293 for more information.
Optional
Optional
Free text for an optional definition.
Example: ‘the video compression scheme H264, main profile, level1 as specified
by ISO/IEC’. See EBU Tech 3293 for more information.
Optional
Optional
Link to a classification scheme. See
EBU Tech 3293 for more information.
Optional
Optional
Defines a format.
Free text field. See EBU Tech 3293
for more information.
Optional
Optional
An optional definition. See EBU Tech
3293 for more information.
Optional
Optional
A link to a term or identification of
a classification scheme. See EBU Tech 3293 for more information.
Optional
Optional
Unique identifiers that are based on
SMPTE 2029, providing a generic representation for UUIDs, ULs and
UMIDs.
Although empty IDs are
permitted, these should only be used for initial requests where the server is
expected to create an identifier.
A universally unique identifier (UUID) or
globally unique identifier (GUID) that may be represented as a URN as per RFC
4122.
A SMPTE unique material number, as
specified in SMPTE ST 330 and represented as a URN according to SMPTE ST
2029.
A SMPTE universal label, as specified in
SMPTE ST 298 and represented as a URN according to SMPTE ST 2029.
Empty identification permitted to enable
validation of documents where identities are not yet known.
This type provides a unique way to
identify a resource.
Identification of a specific revision of
a resource.
A SMPTE ST 12-1 timecode value formatted
according to the edit decision list grammar specified in SMPTE ST
258.
A representation of AV duration as a
SMPTE timecode-like value, with an upper bound of 99 hours rather than 23
hours.
Allows users / implementers to define
their own technical parameters as ‘string’ for which a format can be defined to
restrict the string format. See 'TechnicalAttributeString' in EBU Tech 3293 for more
information.
Type information for the
technical attribute, as specified in EBU Tech 3293.
Optional
Optional
Format information for the
technical attribute, as specified in EBU Tech 3293.
Optional
Optional
A length value and its unit of
measurement.
Specifies the unit in which
the length is expressed. See '@unit' in EBU Tech 3293 for more
information.
Optional
Optional
A rational value expressed by its
fraction of a second numerator and denominator components. Rational values can be
used to represent edit rates. For example, a frame rate of 29.97 would be
represented as 30 corrected by 1000 (numerator) / 1001 (denominator).
The numerator of the rational
value.
Mandatory
Mandatory
The denominator of the
rational value.
Mandatory
Mandatory
Provides information on the algorithm
used in an integrity check process. It is based on the 'hash' type defined in SMPTE
ST 2032.
The hash function used to hash
the content (e.g. CRC32).
Mandatory
Mandatory
Hash (digest) value as a
hexadecimal string.
Mandatory
Mandatory
A number of edit units as defined in EBU
Tech 3293. An editUnit is the inverse of the edit rate, or corrected edit rate as
the result of editUnit=1/(editrate*(factorNumerator/factorDenominator)). A number of
edit units as defined in EBU Tech 3293. An editUnit is the inverse of the edit rate,
or corrected edit rate as the result of
editUnit=1/(editRrate*(factorNumerator/factorDenominator)). Values of the
combination of editRate, factorNumerator, and factorDenominator shall be subject to
the constraints listed in the Annex EditUnitNumberType. See EBU Tech 3293 for more
information.
The base number of frames or
samples per seconds. This base number can be corrected by a factor
calculated as the product of the edit rate and
'factorNumerator/factorDenominator'.
Mandatory
Mandatory
The numerator of the
correction factor.
Mandatory
Mandatory
The denominator of the
correction factor.
Mandatory
Mandatory
Statistics on the amount of information
processed so far. For example in terms of bytes or frames processed.
Required
The type of processed
information provided.
The percentage of job completed.
The percentage can be based on one of two metrics: number of bytes
processed, or number of frames processed (e.g. for transcoding video files).
If the "processedBytesCount" metric is provided, then the percentage is
based on number of bytes processed. If the "processedFramesCount" metric is
provided, then the percentage is based on the number of processed frames.
Mandatory
Mandatory
Statistics on number of bytes
processed.
The number of bytes
processed from the start of the job.
Mandatory
Mandatory
Statistics on number of frames
processed.
The number of frames (for
audiovisual content only) processed from the beginning of the
job.
Mandatory
Mandatory
Measure of the duration of an operation
or item of content.
One of the elements shall be
used.
Required
Element(s)
supported.
Duration of AV content in a
timecode-like format (e.g. SMPTE ST 12-1) as defined in EBU Tech
3293.
This kind of duration
shall be used only where an exact time can be calculated from the timecode
value. For example, it is not appropriate for NTSC systems.
Mandatory
Mandatory
A duration expressed using usual
time representation as in RFC 2326 and ISO 8601
(e.g.:PT1H31M25.152S)
Mandatory
Mandatory
A duration expressed as a number
of edit units, as defined in EBU Tech 3293.
Mandatory
Mandatory
Value used to represent a point in time,
such as at what time to start an operation.
One of the elements shall be
used.
Required
Element(s)
supported.
Start time expressed using
timecode values compliant with SMPTE ST 12-1.
Mandatory
Mandatory
Start time expressed by time of
day in the format hh:mm:ss.sss with an optional following time zone
indicator.
Mandatory
Mandatory
Start time expressed as a number
of edit units.
Mandatory
Mandatory
Current state of a queue.
Queue has started
successfully.
Queue has been stopped
successfully. The queue is not accepting newly submitted
jobs.
Queue has been locked
successfully and will not accept any new submitted jobs. The jobs already in
the queue will continue to start or run to completion.
Acceptable priority values used to
determine the execution order of jobs. See specification Part1 "Job Execution
Priority".
Job initially allocated to the
end of the queue.
Job initially allocated to be
executed before any low priority jobs but after any existing medium priority
jobs.
Job initially allocated before
any medium and low priority jobs but after existing high priority
jobs.
Job initially allocated to be
executed before any high, medium and low priority jobs but after existing
urgent jobs.
Job should be executed as soon as
the request is received.
Different kinds of storage media
available (e.g. online on disk).
Different kinds of storage media
available (e.g. online on disk), in combination with type group
attributes.
Storage type.
Attributes from other
namespaces are permitted. Lax processing requests that a validator
checks the attributes where access to the attribute's defining schema is
available.
Attributes from the
FIMS base namespace shall not be used.
Commands for the control and management
of a queue. All commands are optional.
Required
Supported
commands
Retrieve the current status of
the queue.
Delete all remaining jobs in the
queue.
Stop the queue. Jobs cannot then
be en-queued or de-queued.
Restart a stopped
queue.
Lock the queue. Jobs cannot be
en-queued but they are still being processed and can be deleted.
Unlock a locked
queue.
Commands for the control and management
of a job. All commands are optional.
Required
Supported
commands
Cancel the job.
Pause the job. It can be
restarted with resume.
Resume the job from its paused
state.
Restart the job from the
beginning.
Stop the job.
Remove all the data associated
with the job.
Modify the priority of the
job.
Different hash functions that can be used
to hash the content, as defined in SMPTE ST 2032.
32-bit Cyclic Redundancy Check,
as defined in ISO 3309.
64-bit Cyclic Redundancy Check,
as defined in ISO 3309.
128-bit Message Digest Algorithm
5, as defined in RFC 1321.
160-bit Secure Hash Algorithm, as
defined in FIPS 180-2.
256-bit Secure Hash Algorithm, as
defined in FIPS 180-2.
84-bit Secure Hash Algorithm, as
defined in FIPS 180-2.
512-bit Secure Hash Algorithm, as
defined in FIPS 180-2.
Different hash functions that can be used
to hash the content, as defined in SMPTE ST 2032, in combination with type group
description.
Hash function
type.
Attributes from other
namespaces are permitted. Lax processing requests that a validator
checks the attributes where access to the attribute's defining schema is
available.
Attributes from the
FIMS base namespace shall not be used.
All possible states for a
job.
Job is in the queue and is ready
to start.
Job has started successfully and
is currently running.
Job has been
paused.
Job has completed
successfully.
Job has been
canceled.
Job has been stopped. A partial
result may be retrieved.
Job has ended with an error.
A cleanup command was issued for
the job. All data related to the job has been removed.
Status for the job is unknown.
Audio sample representation: integer or
floating point values.
Scanning format representation:
interlaced or progressive.
Scanning order representation: whether
the fields are ordered top (upper) or bottom (lower) field first.
Representation of type of bitrate:
constant or variable.
Common error codes which can be shared by
different classes of adapters. Error codes are classified in five main categories: •
INF_S00_xxxx: Infrastructure errors (system, storage, network, memory, processor) •
DAT_S00_xxxx: Data errors (validation, missing, duplication) • SVC_S00_xxxx:
Operation errors (existence, support, lock, connection, failure) • SEC_S00_xxxx:
Security errors (authentication, authorization) • EXT_S00_xxxx: Extended code. See
extended error code for detail.
System
unavailable.
System timeout.
System internal
error.
Unable to connect to the
database.
System out of
memory.
System out of disk
space.
Job Command is not currently
supported by the service URI specified
Queue Command is not currently
supported by the service or the device.
Operation requested is not
currently supported by the service or the device.
Service unable to find/lookup
device endpoint.
Job command
failed.
Queue command
failed.
Service unable to connect to
device endpoint
Job queue is full, locked or
stopped. No new jobs are being accepted.
Job ended with a
failure.
Service received no response from
device.
Service received an exception
from device. See description or exception detail.
Service received an unknown or an
internal error from device. See description for error
detail.
Unable to connect to client's
notification service endpoint (replyTo) to send the asynchronous job result
notification response.
Unable to connect to client's
service endpoint (faultTo) to send the asynchronous job fault
response.
Feature not
supported.
Deadline passed.
Time constraints in request
cannot be met.
Internal or Unknown error
encountered. See description for error detail.
Invalid request, XML
format.
Invalid input media
format.
Invalid jobID - the supplied
jobID does not exists.
Missing required service metadata
in request.
Duplicate jobGUID detected for
new job.
Invalid request
parameters.
Job command not
valid.
Queue command not
valid.
Invalid priority.
Input media not found. Invalid
resource URI specified.
Extended code. See extended error
code for details.
Kinds of time, time code, or event based
information used to start a real-time process such as a capture
process.
One of the following types shall
be used. StartProcessByNoWaitType and StartProcessByServiceDefinedTimeType shall be
supported.
Required
Supported start process
types.
Start a real-time process with no initial
wait.
The process shall start without
waiting for a specific time or event.
Actual time that the
process started.
If supported,
the value shall be provided on completion of the
process.
Required
Support
or not.
Not
applicable
Optional
Time mark indicating the
time that the process started as a value measured along the
associated audio and/or video stream.
Required
Support
or not.
Not
applicable
Optional
Provides the time when a real-time
process should start.
The time for starting a
real-time process.
Date and time
information shall be set with format defined according to the
dateTime type and shall include the timezone
component.
Mandatory
Mandatory
Provides a video or audio stream time
mark value to indicate the required start of a real-time process.
A video and audio time
point reference.
The time
reference shall be defined according to EBU Tech 3295. For example,
SMPTE ST 12-1 time code.
Required
Kinds of
time mark the service supports.
Mandatory
Mandatory
A service-specific time mechanism
specifies when a process is required to start.
The service shall wait for an
event to start the process. The actual event depends on the service implementation.
A service shall support this type.
Actual time that the
process started.
If supported,
the value shall be provided on completion of the
process.
Required
Support
or not.
Not
applicable
Optional
Time mark indicating the
time that the process started as a value measured along the
associated audio and/or video stream.
Required
Support
or not.
Not
applicable
Optional
Kind of time, time code, or event
information used to stop a real-time process, such as a capture
process.
One of the following types shall
be used. StopProcessByServiceDefinedTimeType shall be supported.
Required
Supported stop process
types.
The time when a real-time process should
stop.
Time to stop a real-time
process.
Date and time
information shall be set with format defined according to the
dateTime type including the timezone component.
Mandatory
Mandatory
Total duration of the real time
process.
A real time process shall stop
once the specified duration has elapsed.
Total required duration
of the real-time process.
Required
Kind of
duration supported.
Mandatory
Mandatory
A video or audio stream time reference
when the real-time process stops.
A video or audio time
point reference.
The value shall
be defined according to EBU Tech 3295 (e.g. SMPTE ST 12-1 time
code).
Required
Kinds of
time mark supported
Mandatory
Mandatory
A service-specific time mechanism
specifies when a process is required to stop.
The service shall wait for an
event to stop the process. The actual event depends on the service implementation. A
service shall support this type.
Actual time that the
process stopped.
If supported,
the value shall be provided on completion of the
process.
Required
Support
or not.
Not
applicable
Optional
Time mark indicating the
time that the process stopped as a value measured along the the
associated audio and/or video stream.
Required
Support
or not.
Not
applicable
Optional
The real-time process is to continue
indefinitely until a stop command (manageJobRequest) is received.
Actual time that the
process stopped.
If supported,
the value shall be provided on completion of the
process.
Required
Support
or not.
Not
applicable
Optional
Time mark indicating the
time that the process stopped as a value measured along the the
associated audio and/or video stream.
Required
Support
or not.
Not
applicable
Optional
Kinds of time when a job is required to
start.
One of the following types shall
be used. StartJobByNoWaitType shall be supported.
Required
Supported start job
types
Start a job as soon as
possible.
The job shall start without
waiting for a specific time or event. This type shall be supported.
Provides a time when the job should
start.
Time when the job should
start.
Mandatory
Mandatory
Start the job as close as possible to the
defined start process time.
FIMS service common mechanism to manage
jobs and update jobs properties, including job priority. The manage job request uses
the jobCommand to set the intent of the command (acting on the job
state).
Resource identifier of the job to
be managed.
Mandatory
Not
applicable
Action to perform on the job.
Mandatory
Not
applicable
New priority for the
job.
If the job command is
set to "modifyPriority", this element shall be set to provide one of the
allowed values (priority or profile). If the job command is set to any other
value, this element shall not be set.
Optional
Not
applicable
Extension point.
Optional
Not
applicable
Extension point
Optional
Not
applicable
This type provides job status as a
response to a job management request (e.g. pausing a job).
Job status as a response to a job
management request.
Not
applicable
Mandatory
Extension point
Not
applicable
Optional
Extension point
Not
applicable
Optional
This type provides a mechanism to manage
a queue, for example checking the status of the queue, stopping and starting the
queue and locking the queue. The queue management request uses the queueCommand to
set the intent of the command (requesting status or acting on the queue state).
Identifier for the queue,
required for services with more than one queue. Note: FIMS 1.0 does not
allow more than one queue per service.
Optional
Not
applicable
This element specifies the intent
of the command. Possible values for the command are listed in
QueueCommandType.
Mandatory
Not
applicable
Extension point.
Optional
Not
applicable
Extension point.
Optional
Not
applicable
This type represents a response to a
queue management request. It provides information such as the status and the length
of queue.
Queue information such as the
status and the length of queue.
Not
applicable
Mandatory
Extension point.
Not
applicable
Optional
Extension point
Not
applicable
Optional
This is an abstract type to be extended
to create types to request status of multiple identified jobs or to list the status
of jobs that meet requirements specified by a filter object.
Level of status details to be
returned for the jobs.
Mandatory
Not
applicable
Extension point.
Optional
Not
applicable
Extension point
Optional
Not
applicable
This type is part of the FIMS service
common status interface and provides a mechanism query jobs and retrieve information
associated to them. A client can request the status of multiple identified
jobs.
This element carries the
IDs of one or more jobs for which status is to be
retrieved.
Mandatory
Not
applicable
This type is part of the FIMS service
common status interface and provides a mechanism query jobs and retrieve information
associated to them. A client can request the status of jobs that meet requirements
specified by a filter object.
This element defines the
filtering parameters to list jobs for which status is to be
retrieved.
Mandatory
Not
appplicable
This type provides a response to
QueryJobRequestType. It contains a list of queryJobInfo elements. Furthermore, the
response message provided by this type supports a polling interaction pattern for
retrieving the status and the response of an asynchronous job
request.
List of jobs matching the query
parameters.
Not
applicable
Optional
This optional element indicates
the number of results that were not reported due to the restriction imposed
by the maximum number of results specified in the request.
Not
applicable
Optional
Extension point.
Not
applicable
Optional
Extension point.
Not
applicable
Optional
Provides a mechanism to query Service
Description.
Whether the response is required as
an embedded description or as a reference.
Response is required as a
reference to the Service Description.
Response is required as
an embedded value with the complete Service
Description.
Response to the Service Description
query.
Service Description, embedded or
by reference.
Not
applicable
Mandatory
Whether to return only mandatory elements
or all elements.
Specifies a list of jobs to be retrieved.
The list includes only jobs that fall in the period of time specified (if provided)
and in the specified category (queued, active, completed, failed).
A 'from' date filter. If this
element is not specified, the list includes jobs that started at any point
in time (that still complies with the 'toDatte' field).
Jobs to be listed shall
have started on or after the date specified in this field.
Optional
Not
applicable
A 'to' date filter. If this
element is not specified, the list includes jobs that started at any point
in time (that still complies with the 'fromDatte' field).
Jobs to be listed shall
have started on or before the date specified in this field.
Optional
Not
applicable
A flag to indicate job or jobs in
the queue.
Mandatory
Not
applicable
A flag to indicate job or jobs in
the 'Running', 'Paused' or 'Unknown' state.
Mandatory
Not
applicable
A flag to indicate job or jobs in
the 'Completed', 'Stopped' or 'Cleaned' state.
Mandatory
Not
applicable
A flag to indicate job or jobs in
the 'Failed' state.
Mandatory
Not
applicable
Maximum number of results to be
listed.
Optional
Not
applicable
Details of a fault. This type can be
extended by each service to provide additional error codes.
The error code specified in
ErrorCodeType.
In the case of
service-specific errors, "EXT_S00_0000" shall be set, and the specific error
code shal be set in the child class "extendedErrorCode"
field.
Not
applicable
Mandatory
An optional description of the
error.
Not
applicable
Optional
This optional field can provide a
detailed description of the error.
Not
applicable
Optional
Additional description of the
lower-level errors.
Not
applicable
Optional
Additional description of the lower-level
errors.
Lower-level error code. This can
be any value that is relevant to the appropriate subsystem
Not
applicable
Mandatory
Description of lower-level error
code.
Not
applicable
Optional
This optional field can provide a
detailed description of the lower-level error.
Not
applicable
Optional
This element allows to submit jobs
management requests, such as getting the status or pausing a job.
This element provides the response to job
management requests, which includes the current status of the job.
This element allows to submit queue
management requests, such as getting the status or locking a queue.
This element provides the response to
queue management requests, which includes the status and length of the
queue.
This element is used to request the list
of jobs in a queue.
This element provides the list of jobs in
a queue.
This element is used to request the
service capability.
Provides the requested service
capability.
Element used to carry a fault defined in
the base schema, as detailed in the "ErrorCodeType" enumeration.