ArcXP-Mobile-SDK-Android/com.arcxp.content.models/Video

Video

@JsonClass(generateAdapter = true)

data class Video( val _id: String?, val version: String?, val subtype: String?, val channels: List<String>?, val alignment: String?, val copyright: String?, val canonical_url: String?, val canonical_website: String?, val short_url: String?, val created_date: Date?, val last_updated_date: Date?, val publish_date: Date?, val first_publish_date: Date?, val display_date: Date?, val geo: Geo?, val language: String?, val location: String?, val address: Address?, val editor_note: String?, val status: String?, val headlines: Headline?, val subheadlines: Headline?, val description: Description?, val credits: Credits?, val vanity_credits: Credits?, val taxonomy: Taxonomy?, val promo_items: PromoItem?, val related_content: Map<String, *>?, val owner: Owner?, val planning: Planning?, val pitches: Pitches?, val source: Source?, val distributor: Distributor?, val tracking: Any?, val comments: Comments?, val label: Label?, val slug: String?, val content_restrictions: ContentRestrictions?, val content_aliases: List<String>?, val duration: Int?, val transcript: String?, val rating: String?, val video_type: String?, val youtube_content_id: String?, val streams: List<Streams>?, val subtitles: Video.Subtitle?, val additional_properties: Map<String, *>?, val image_type: String?, val alt_text: String?, val focal_point: Image.FocalPoint?, val subtitle: String?, val caption: String?, val url: String?, val width: Int?, val height: Int?, val licensable: Boolean?, val contributors: Image.CreatedBy?, val promo_image: Image?, val embed_html: String?, val corrections: List<Correction>?, val websites: Map<String, SiteInfo>?) : StoryElement

Holds attributes of an ANS video component. In the Arc ecosystem, these are stored in Goldfish.

Constructors

Video

fun Video( _id: String?, version: String?, subtype: String?, channels: List<String>?, alignment: String?, copyright: String?, canonical_url: String?, canonical_website: String?, short_url: String?, created_date: Date?, last_updated_date: Date?, publish_date: Date?, first_publish_date: Date?, display_date: Date?, geo: Geo?, language: String?, location: String?, address: Address?, editor_note: String?, status: String?, headlines: Headline?, subheadlines: Headline?, description: Description?, credits: Credits?, vanity_credits: Credits?, taxonomy: Taxonomy?, promo_items: PromoItem?, related_content: Map<String, *>?, owner: Owner?, planning: Planning?, pitches: Pitches?, source: Source?, distributor: Distributor?, tracking: Any?, comments: Comments?, label: Label?, slug: String?, content_restrictions: ContentRestrictions?, content_aliases: List<String>?, duration: Int?, transcript: String?, rating: String?, video_type: String?, youtube_content_id: String?, streams: List<Streams>?, subtitles: Video.Subtitle?, additional_properties: Map<String, *>?, image_type: String?, alt_text: String?, focal_point: Image.FocalPoint?, subtitle: String?, caption: String?, url: String?, width: Int?, height: Int?, licensable: Boolean?, contributors: Image.CreatedBy?, promo_image: Image?, embed_html: String?, corrections: List<Correction>?, websites: Map<String, SiteInfo>?)

Types

Subtitle

@JsonClass(generateAdapter = true)

data class Subtitle(val confidence: Any?, val urls: List<String>?)

Subtitle for video

Properties

_id

val _id: String?

Globally Unique ID trait: A globally unique identifier of the content in the ANS repository.

additional_properties

val additional_properties: Map<String, *>?

A grab-bag object for non-validatable data.

address

val address: Address?

An Address following the convention of http://microformats.org/wiki/hcard

alignment

val alignment: String?

Alignment: A property used to determine horizontal positioning of a content element relative to the elements that immediately follow it in the element sequence. could be 'left', 'right', or 'center'

alt_text

val alt_text: String?

The direct ANS equivalent of the HTML 'alt' attribute. A description of the contents of an image for improved accessibility.

canonical_url

val canonical_url: String?

Canonical URL: The relative URL to this document on the website specified by the canonical_website field. In the Arc ecosystem, this will be populated by the content api from the arc-canonical-url service if present based on the canonical_website. In conjunction with canonical_website, it can be used to determine the SEO canonical url or open graph url. In a multi-site context, this field may be different from the website_url field.

canonical_website

val canonical_website: String?

The _id of the website from which this document was originally authored. In conjunction with canonical_url, it can be used to determine the SEO canonical url or open graph url. In a multi-site context, this field may be different from the website field.

caption

val caption: String?

Caption for the image.

channels

val channels: List<String>?

Channel trait: An optional list of output types for which this element should be visible

comments

val comments: Comments?

Comment configuration data

content_aliases

val content_aliases: List<String>?

An list of alternate names that this content can be fetched by instead of id.

content_restrictions

val content_restrictions: ContentRestrictions?

Trait that applies contains the content restrictions of an ANS object.

contributors

val contributors: Image.CreatedBy?

Trait that holds information on who created and contributed to a given document in Arc.

val copyright: String?

corrections

val corrections: List<Correction>?

Trait that applies a list of corrections to a document.

created_date

val created_date: Date?

Created Date: When the content was originally created (RFC3339-formatted). In the Arc ecosystem, this will be automatically generated for stories in the Story API.

credits

val credits: Credits?

Credits: A list of people and groups attributed to this content, keyed by type of contribution. In the Arc ecosystem, references in this list will be denormalized into author objects from the arc-author-service.

description

val description: Description?

The interstitial link url. This is where the user should be taken if they follow this link.

display_date

val display_date: Date?

Display_Date: The RFC3339-formatted dated time of the most recent date the story was (re)displayed on a public site.

distributor

val distributor: Distributor?

Information about a third party that provided this content from outside this document's hosted organization.

duration

val duration: Int?

Runtime of the video in milliseconds.

editor_note

val editor_note: String?

Editor_Note: Additional information to be displayed near the content from the editor.

embed_html

val embed_html: String?

An HTML snippet used to embed this video in another document. Used for oembed responses.

first_publish_date

val first_publish_date: Date?

First Publish Date: When the story was first published.

focal_point

val focal_point: Image.FocalPoint?

coordinates representing the 'visual center' of an image. The X axis is horizontal line and the Y axis the vertical line, with 0,0 being the LEFT, TOP of the image.

geo

val geo: Geo?

Geo: Latitude and Longitude of the content

headlines

val headlines: Headline?

Headlines: The headline(s) or title for this content.

height

val height: Int?

Height for the image.

image_type

val image_type: String?

A more specific category for an image. "photograph", "graphic", "illustration", or "thumbnail"

label

val label: Label?

What the Washington Post calls a Kicker

language

val language: String?

The primary language of the content. The value should follow IETF BCP47. (e.g. 'en', 'es-419', etc.)

last_updated_date

val last_updated_date: Date?

Last Updated Date: When the content was last updated (RFC3339-formatted).

licensable

val licensable: Boolean?

True if the image can legally be licensed to others.

location

val location: String?

Location related trait: A description of the location, useful if a full address or lat/long specification is overkill.

owner

val owner: Owner?

Various unrelated fields that should be preserved for backwards-compatibility reasons. See also trait_source.

pitches

val pitches: Pitches?

Trait that represents a story's pitches. In the Arc ecosystem, this data is generated by WebSked.

planning

val planning: Planning?

Trait that applies planning information to a document or resource. In the Arc ecosystem, this data is generated by WebSked. Newsroom use only. All these fields should be available and editable in WebSked.

promo_image

val promo_image: Image?

A promo/leader image to the video.

promo_items

val promo_items: PromoItem?

Lists of promotional content to use when highlighting the story. In the Arc ecosystem, references in these lists will be denormalized.

publish_date

val publish_date: Date?

Publish_Date: When the story was published.

rating

val rating: String?

A rating of the video, to be used for appropriate age/content warnings.

related_content

val related_content: Map<String, *>?

Lists of content items or references this story is related to, arbitrarily keyed. In the Arc ecosystem, references in this object will be denormalized into the fully-inflated content objects they represent.

short_url

val short_url: String?

Short_Url: A url-shortened version of the canonical url.

slug

val slug: String?

A short reference name for internal editorial use

source

val source: Source?

Information about the original source and/or owner of this content

status

val status: String?

Status: Optional field to story story workflow related status (e.g. published/embargoed/etc)

streams

val streams: List<Streams>?

The different streams this video can play in.

subheadlines

val subheadlines: Headline?

SubHeadlines: The subheadline(s) or title for this content.

subtitle

val subtitle: String?

Subtitle for the image.

subtitles

val subtitles: Video.Subtitle?

Data about different subtitle encodings and confidences of auto-transcribed content.

subtype

val subtype: String?

A user-defined categorization method to supplement type. In Arc, this field is reserved for organization-defined purposes, such as selecting the PageBuilder template that should be used to render a document.

taxonomy

val taxonomy: Taxonomy?

Holds the collection of tags, categories, keywords, etc that describe content.

tracking

val tracking: Any?

Tracking information, probably implementation-dependent

transcript

val transcript: String?

A transcript of the contents of the video.

type

val type: String

url

val url: String?

URL for the image.

vanity_credits

val vanity_credits: Credits?

Similar to the credits trait, but to be used only when ANS is being directly rendered to readers natively. For legal and technical reasons, the credits trait is preferred when converting ANS into feeds or other distribution formats. However, when present, vanity_credits allows more sophisticated credits presentation to override the default without losing that original data.

version

val version: String?

Describes the ANS version of this object: The version of ANS that this object was serialized as, in major.minor.patch format. For top-level content objects, this is a required trait.

video_type

val video_type: String?

The type of video (e.g. clip, livestream, etc)

websites

val websites: Map<String, SiteInfo>?

Website-specific metadata for url generation for multi-site copies. These fields are not indexed in Content API.

width

val width: Int?

Width for the image.

youtube_content_id

val youtube_content_id: String?

The YouTube ID of the content, if (re)hosted on youtube.com