This is an implementation of schema.org VideoObject.

In Stencila Schema it is used both as media metadata and as rendered document content, especially in figures and multimedia documents. It inherits file and media capabilities from MediaObject while adding video-specific descriptive properties.

Key properties include caption, thumbnail, and transcript, with broader media metadata inherited from MediaObject.

Analogues

The following external types, elements, or nodes are similar to a VideoObject:

schema.org VideoObject

HTML <video>

JATS <inline-media>: Closest JATS analogue for embedded video-like media, though JATS uses a generic media element rather than a dedicated video element.

Properties

The VideoObject type has these properties:

Name	Description	Type	Inherited from
`caption`	The caption for this video recording.	`Inline`*	-
`thumbnail`	Thumbnail image of this video recording.	`ImageObject`	-
`transcript`	The transcript of this video recording.	`String`	-
`bitrate`	Bitrate in megabits per second (Mbit/s, Mb/s, Mbps).	`Number`	`MediaObject`
`contentSize`	File size in megabits (Mbit, Mb).	`Number`	`MediaObject`
`contentUrl`	URL for the actual bytes of the media object, for example the image file or video file.	`String`	`MediaObject`
`embedUrl`	URL that can be used to embed the media on a web page via a specific media player.	`String`	`MediaObject`
`mediaType`	IANA media type (MIME type).	`String`	`MediaObject`
`workType`	The type of `CreativeWork` (e.g. article, book, software application).	`CreativeWorkType`	`CreativeWork`
`doi`	The work's Digital Object Identifier (https://doi.org/).	`String`	`CreativeWork`
`about`	The subject matter of the content.	`ThingVariant`*	`CreativeWork`
`abstract`	A short description that summarizes a `CreativeWork`.	`Block`*	`CreativeWork`
`authors`	The authors of the `CreativeWork`.	`Author`*	`CreativeWork`
`provenance`	A summary of the provenance of the content within the work.	`ProvenanceCount`*	`CreativeWork`
`contributors`	A secondary contributor to the `CreativeWork`.	`Author`*	`CreativeWork`
`editors`	People who edited the `CreativeWork`.	`Person`*	`CreativeWork`
`maintainers`	The maintainers of the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`comments`	Comments about this creative work.	`Comment`*	`CreativeWork`
`dateCreated`	Date/time of creation.	`DateTime`	`CreativeWork`
`dateReceived`	Date/time that work was received.	`DateTime`	`CreativeWork`
`dateAccepted`	Date/time of acceptance.	`DateTime`	`CreativeWork`
`dateModified`	Date/time of most recent modification.	`DateTime`	`CreativeWork`
`datePublished`	Date of first publication.	`DateTime`	`CreativeWork`
`funders`	People or organizations that funded the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`fundedBy`	Grants that funded the `CreativeWork`; reverse of `fundedItems`.	(`Grant` \| `MonetaryGrant`)*	`CreativeWork`
`genre`	Genre of the creative work, broadcast channel or group.	`String`*	`CreativeWork`
`keywords`	Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.	`String`*	`CreativeWork`
`isPartOf`	An item or other CreativeWork that this CreativeWork is a part of.	`CreativeWorkVariant`	`CreativeWork`
`licenses`	License documents that applies to this content, typically indicated by URL, but may be a `CreativeWork` itself.	(`CreativeWorkVariant` \| `String`)*	`CreativeWork`
`parts`	Elements of the collection which can be a variety of different elements, such as Articles, Datatables, Tables and more.	`CreativeWorkVariant`*	`CreativeWork`
`publisher`	A publisher of the CreativeWork.	`Person` \| `Organization`	`CreativeWork`
`bibliography`	A bibliography of references which may be cited in the work.	`Bibliography`	`CreativeWork`
`references`	References to other creative works, such as another publication, web page, scholarly article, etc.	`Reference`*	`CreativeWork`
`text`	The textual content of this creative work.	`Text`	`CreativeWork`
`title`	The title of the creative work.	`Inline`*	`CreativeWork`
`repository`	URL of the repository where the un-compiled, human readable source of the work is located.	`String`	`CreativeWork`
`path`	The file system path of the source of the work.	`String`	`CreativeWork`
`commit`	The commit hash (or similar) of the source of the work.	`String`	`CreativeWork`
`version`	The version of the creative work.	`String` \| `Number`	`CreativeWork`
`alternateNames`	Alternate names (aliases) for the item.	`String`*	`Thing`
`description`	A description of the item.	`String`	`Thing`
`identifiers`	Any kind of identifier for any kind of Thing.	(`PropertyValue` \| `String`)*	`Thing`
`images`	Images of the item.	`ImageObject`*	`Thing`
`name`	The name of the item.	`String`	`Thing`
`url`	The URL of the item.	`String`	`Thing`
`id`	The identifier for this item.	`String`	`Entity`

The VideoObject type is related to these types:

Parents: MediaObject

Children: none

Bindings

The VideoObject type is represented in:

JSON-LD

JSON Schema

Python class VideoObject

Rust struct VideoObject

TypeScript class VideoObject

Testing

During property-based (a.k.a generative) testing, the properties of the VideoObject type are generated using the following strategies.

Property	Complexity	Description	Strategy
`contentUrl`	Min+	Generate a fixed URL.	`String::from("https://example.org/image.png")`
	Low+	Generate a random URL.	Regex `https://\w+\.\w+/\w+\.png`
	High+	Generate a random string of up to 100 alphanumeric characters.	Regex `[a-zA-Z0-9]{1,100}`
	Max	Generate an arbitrary string.	`String::arbitrary()`

This documentation was generated from VideoObject.yaml by docs_types.rs.

Analogues

Properties

Related

Bindings

Testing