Theme Variables - Video Metadata

This page lists the attributes that are available for each video handled by TubePress.

Attribute Name authorDisplayName
Description The display name of the user/channel that uploaded/owns the video.
Examples
  • KatyPerryVEVO
  • Seeking Nirvana
  • Red Bull
Attribute Name authorUid
Description The internal (to the video host) name of the user/channel that uploaded/owns the video.
Examples
  • UC1yBKRuGpC1tSM73A0ZjYjQ (YouTube)
  • user48494445 (Vimeo)
  • RedBull (Dailymotion)
Attribute Name authorUrl
Description The public URL to the user/channel that uploaded/owns the video.
Examples
  • https://www.youtube.com/channel/UC1yBKRuGpC1tSM73A0ZjYjQ (YouTube)
  • https://vimeo.com/user48494445 (Vimeo)
  • https://www.dailymotion.com/RedBull (Dailymotion)
Attribute Name category
Description The display name of the video's assigned category.
Examples
  • Pet's & Animals (YouTube)
  • Comedy & Entertainment (Dailymotion)
Note This attribute is not available for Vimeo videos.
Attribute Name commentCount
Description The raw, unformatted count of the number of comments that this video has received on its hosted page.
Examples
  • 5326
  • 98948
Note This attribute is only available for YouTube videos.
Attribute Name commentCountFormatted
Description The formatted count of the number of comments that this video has received on its hosted page.
Examples
  • 5,326
  • 98,948
Note This attribute is only available for YouTube videos.
Attribute Name description
Description The full video description.
Notes
  • Video descriptions may contain simple HTML (mainly just line breaks)
Attribute Name countDislikes
Description The raw, unformatted count of the number of dislikes that this video has received.
Examples
  • 5326
  • 98948
Note This attribute is only available for YouTube videos.
Attribute Name countDislikesFormatted
Description The formatted count of the number of dislikes that this video has received.
Examples
  • 5,326
  • 98,948
Note This attribute is only available for YouTube videos.
Attribute Name countFavorited
Description The raw, unformatted count of the number of times this video has been marked as a favorite.
Examples
  • 5326
  • 98948
Note This attribute is only available for YouTube videos.
Attribute Name countFavoritedFormatted
Description The formatted count of the number of times this video has been marked as a favorite.
Examples
  • 5,326
  • 98,948
Note This attribute is only available for YouTube videos.
Attribute Name duration
Description The formatted duration of the video.
Examples
  • 0:13
  • 3:45
  • 2:15:57
Note Leading zeros are used for videos less than 1 minute long.
Attribute Name durationInSeconds
Description The duration, in seconds, of the video.
Examples
  • 13
  • 225
  • 3498
Attribute Name homeUrl
Description The URL of this video on its original host.
Examples
  • https://www.youtube.com/watch?v=9bZkp7q19f0
  • https://vimeo.com/154698227
  • https://www.dailymotion.com/video/x3zg56v_cliff-diving-victoria-falls-the-world-s-largest-waterfall_sport
Attribute Name id
Description The globally-unique video identifier.
Examples
  • 1cGsm_eaNhw (YouTube)
  • 159681647 (Vimeo)
  • dailymotion_x3rx1nb (Dailymotion)
Notes
  • YouTube video IDs are always 11 characters long.
  • Vimeo video IDs are always composed of just numbers.
  • TubePress prefixes all Dailymotion video IDs with dailymotion_
Attribute Name invokingAnchorHref
Description When TubePress is configured to play a video on a new page (not within the same page), this attribute holds the URL of the new page. i.e. it will end up in the href attribute of the invoking HTML anchor.
Examples
  • /videos/my-awesome-video
  • http://some-domain.com/some_video.php
Notes
  • This attribute is not present when TubePress is configured to display videos on the same page.
  • The URL may be relative or absolute.
Attribute Name invokingAnchorRel
Description When TubePress is configured to play a video on a new page (not within the same page), this attribute holds the rel attribute of the invoking HTML anchor.
Examples
  • external
  • nofollow
Notes This attribute is not present when TubePress is configured to display videos on the same page.
Attribute Name invokingAnchorTarget
Description When TubePress is configured to play a video on a new page (not within the same page), this attribute holds the target attribute of the invoking HTML anchor.
Examples
  • _blank
  • _self
Notes This attribute is not present when TubePress is configured to display videos on the same page.
Attribute Name countLikes
Description The raw, unformatted count of the number of likes that this video has received.
Examples
  • 5326
  • 98948
Note This attribute is not available for Dailymotion videos.
Attribute Name likesFormatted
Description The formatted count of the number of likes that this video has received.
Examples
  • 5,326
  • 98,948
Note This attribute is not available for Dailymotion videos.
Attribute Name provider
Description The internal name (to TubePress) of the video host.
Examples
  • dailymotion
  • vimeo
  • youtube
Attribute Name thumbnailUrl
Description The URL of the thumbnail image that will be used for this video.
Examples
  • https://i.ytimg.com/vi_webp/DNGmD6FcQdY/default.webp (YouTube)
  • https://i.vimeocdn.com/video/555342641_295x166.webp (Vimeo)
  • https://s1-ssl.dmcdn.net/JJNhr/118x118-2He.png (Dailymotion)
Attribute Name timePublishedFormatted
Description The formatted publication/upload date and time of the video.
Examples
  • Nov. 3, 2014
  • November 3, 2014 at 3:45 pm
  • yesterday
Attribute Name timePublishedUnixTime
Description The publication/upload date and time, in Unix time, of the video.
Examples
  • 1458616813
  • 915148800
Attribute Name title
Description The video title.
Examples
  • Evolution of Dance
  • Eye of India
  • After Hours
Attribute Name viewCount
Description The raw, unformatted count of the number times this video has been viewed.
Examples
  • 5326
  • 98948
Attribute Name viewCountFormatted
Description The formatted count of the number times this video has been viewed.
Examples
  • 5,326
  • 98,948


Last Updated Mar 22, 2016 03:15PM PDT
c65861bf7a72e1a8878bdf73cabbbdbf@tubepress.desk-mail.com
http://assets0.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete