NAME

SemanticWeb::Schema::MediaObject - A media object

VERSION

version v23.0.0

DESCRIPTION

A media object, such as an image, video, audio, or text object embedded in a web page or a downloadable dataset i.e. DataDownload. Note that a creative work may have many media objects associated with it on the same web page. For example, a page about a single song (MusicRecording) may have a music video (VideoObject), and a high and low bandwidth audio stream (2 AudioObject's).

ATTRIBUTES

associated_article

associatedArticle

A NewsArticle associated with the Media Object.

A associated_article should be one of the following types:

InstanceOf['SemanticWeb::Schema::NewsArticle']

_has_associated_article

A predicate for the "associated_article" attribute.

bitrate

The bitrate of the media object.

A bitrate should be one of the following types:

Str

_has_bitrate

A predicate for the "bitrate" attribute.

content_size

contentSize

File size in (mega/kilo)bytes.

A content_size should be one of the following types:

Str

_has_content_size

A predicate for the "content_size" attribute.

content_url

contentUrl

Actual bytes of the media object, for example the image file or video file.

A content_url should be one of the following types:

Str

_has_content_url

A predicate for the "content_url" attribute.

duration

The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).

A duration should be one of the following types:

InstanceOf['SemanticWeb::Schema::Duration']

_has_duration

A predicate for the "duration" attribute.

embed_url

embedUrl

A URL pointing to a player for a specific video. In general, this is the information in the ```src``` element of an ```embed``` tag and should not be the same as the content of the ```loc``` tag.

A embed_url should be one of the following types:

Str

_has_embed_url

A predicate for the "embed_url" attribute.

encodes_creative_work

encodesCreativeWork

The CreativeWork encoded by this media object.

A encodes_creative_work should be one of the following types:

InstanceOf['SemanticWeb::Schema::CreativeWork']

_has_encodes_creative_work

A predicate for the "encodes_creative_work" attribute.

encoding_format

encodingFormat

Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.

In cases where a SemanticWeb::Schema::CreativeWork has several media type representations, [[encoding]] can be used to indicate each SemanticWeb::Schema::MediaObject alongside particular [[encodingFormat]] information.

Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.

A encoding_format should be one of the following types:

Str

_has_encoding_format

A predicate for the "encoding_format" attribute.

end_time

endTime

The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

A end_time should be one of the following types:

Str

_has_end_time

A predicate for the "end_time" attribute.

height

The height of the item.

A height should be one of the following types:

InstanceOf['SemanticWeb::Schema::Distance']
InstanceOf['SemanticWeb::Schema::QuantitativeValue']

_has_height

A predicate for the "height" attribute.

ineligible_region

ineligibleRegion

The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.

See also [[eligibleRegion]].

A ineligible_region should be one of the following types:

InstanceOf['SemanticWeb::Schema::GeoShape']
InstanceOf['SemanticWeb::Schema::Place']
Str

_has_ineligible_region

A predicate for the "ineligible_region" attribute.

interpreted_as_claim

interpretedAsClaim

Used to indicate a specific claim contained, implied, translated or refined from the content of a SemanticWeb::Schema::MediaObject or other SemanticWeb::Schema::CreativeWork. The interpreting party can be indicated using [[claimInterpreter]].

A interpreted_as_claim should be one of the following types:

InstanceOf['SemanticWeb::Schema::Claim']

_has_interpreted_as_claim

A predicate for the "interpreted_as_claim" attribute.

player_type

playerType

Player type required—for example, Flash or Silverlight.

A player_type should be one of the following types:

Str

_has_player_type

A predicate for the "player_type" attribute.

production_company

productionCompany

The production company or studio responsible for the item, e.g. series, video game, episode etc.

A production_company should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']

_has_production_company

A predicate for the "production_company" attribute.

regions_allowed

regionsAllowed

The regions where the media is allowed. If not specified, then it's assumed to be allowed everywhere. Specify the countries in [ISO 3166 format](http://en.wikipedia.org/wiki/ISO_3166).

A regions_allowed should be one of the following types:

InstanceOf['SemanticWeb::Schema::Place']

_has_regions_allowed

A predicate for the "regions_allowed" attribute.

requires_subscription

requiresSubscription

Indicates if use of the media require a subscription (either paid or free). Allowed values are ```true``` or ```false``` (note that an earlier version had 'yes', 'no').

A requires_subscription should be one of the following types:

Bool
InstanceOf['SemanticWeb::Schema::MediaSubscription']

_has_requires_subscription

A predicate for the "requires_subscription" attribute.

sha256

The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the content of the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'.

A sha256 should be one of the following types:

Str

_has_sha256

A predicate for the "sha256" attribute.

start_time

startTime

The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

A start_time should be one of the following types:

Str

_has_start_time

A predicate for the "start_time" attribute.

upload_date

uploadDate

Date (including time if available) when this media object was uploaded to this site.

A upload_date should be one of the following types:

Str

_has_upload_date

A predicate for the "upload_date" attribute.

width

The width of the item.

A width should be one of the following types:

InstanceOf['SemanticWeb::Schema::Distance']
InstanceOf['SemanticWeb::Schema::QuantitativeValue']

_has_width

A predicate for the "width" attribute.

SEE ALSO

SemanticWeb::Schema::CreativeWork

SOURCE

The development version is on github at https://github.com/robrwo/SemanticWeb-Schema and may be cloned from git://github.com/robrwo/SemanticWeb-Schema.git

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/SemanticWeb-Schema/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Robert Rothenberg <[email protected]>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2023 by Robert Rothenberg.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)